Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Appledoc inline code in Xcode Quick Help panel?

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.

like image 868
Geri Borbás Avatar asked May 01 '14 23:05

Geri Borbás


2 Answers

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.

like image 157
Robert Karl Avatar answered Nov 07 '22 23:11

Robert Karl


Start the code block with a tab character.

like image 42
msk Avatar answered Nov 07 '22 23:11

msk