Appledoc inline code in Xcode Quick Help panel?
Asked Answered
C

2

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.

Conductance answered 1/5, 2014 at 23:57 Comment(3)
So you couldn't be bothered to google "appledoc syntax"? You had to get someone to tell you how to do it?Curbing
@msk This entire comment is an inline code block. He's not referring to a website, he's referring to the code block.Ode
@Curbing The question emphasizes xCode Quick Help panel, I could not find any resources regarding this issue out there.Gauze
S
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.

Shorts answered 2/5, 2014 at 1:25 Comment(0)
R
1

Start the code block with a tab character.

Recalcitrate answered 2/5, 2014 at 0:13 Comment(1)
I meant inline code. Code blocks can be done by @code directive, which is fine.Gauze

© 2022 - 2024 — McMap. All rights reserved.