7

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.

Robert Karl
  • 7,598
  • 6
  • 38
  • 61
Geri Borbás
  • 15,810
  • 18
  • 109
  • 172
  • So you couldn't be bothered to google "appledoc syntax"? You had to get someone to _tell_ you how to do it? – matt May 02 '14 at 00:18
  • 2
    @msk `This entire comment is an inline code block. He's not referring to a website, he's referring to the code block.` – Michael Yaworski May 02 '14 at 00:44
  • 1
    @matt The question emphasizes **xCode Quick Help panel**, I could not find any resources regarding this issue out there. – Geri Borbás May 02 '14 at 00:53

2 Answers2

9

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.

Community
  • 1
  • 1
Robert Karl
  • 7,598
  • 6
  • 38
  • 61
1

Start the code block with a tab character.

msk
  • 8,885
  • 6
  • 41
  • 72