Appledoc inline code in Xcode Quick Help panel?

StackOverflow https://stackoverflow.com/questions/23418658

Question

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.

Was it helpful?

Solution

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.

OTHER TIPS

Start the code block with a tab character.

Licensed under: CC-BY-SA with attribution
Not affiliated with StackOverflow
scroll top