Appledoc inline code in Xcode Quick Help panel?

682 Views Asked by At

How can I indicate inline code blocks like this in Appledoc comments?

Backticks just read as backticks in Xcode Quick Help panel.

enter image description here

I'd really love to have NSStringFromClass codified somehow.

2

There are 2 best solutions below

0
Robert Karl On BEST ANSWER

Use @p before a word to place it in monospaced font.

///
/// @summary does some stuff
///
/// Alias for @p NSStringFromClass actually.
///

Code preview

Here's a pretty solid overview of available features.

1
msk On

Start the code block with a tab character.