Geri Borbás
Geri Borbás

Reputation: 16618

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.

Upvotes: 7

Views: 706

Answers (2)

Robert Karl
Robert Karl

Reputation: 7826

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.

Upvotes: 9

msk
msk

Reputation: 8905

Start the code block with a tab character.

Upvotes: 1

Related Questions