code blocks w/ back ticks?

[Raymond Camden]

If we want code format for our text, we should use back ticks, right? I've done so in the sample below:

 * For example, to get the shared instance of Secret Project:

 * 

 * `SecretProject *project = [SecretDoohicky sharedInstance].project;`

 * 

 * Another example:

 * 

 * `mgr = [[SecretyDoohicky sharedInstance] secretManager];`

And oddly, the second line works but the first line is a bit messy. Only portions of the first line use the code font. SecretProject and SecretDoohicky are in the regular font, as is sharedInstance and the final .project.

When I view source, I see some empty <code></code> blocks on the line. 

[Tom @ Gentle Bytes]

There's some incompatibility on current appledoc branch regarding multiline comments that use star delimiters (like on your example). Try to use plain comments to see if it will work.

But otherwise yes, you use backticks for code spans - appledoc uses Markdown for formatting.

Tom

--
You received this message because you are subscribed to the Google Groups "appledoc" group.
To unsubscribe from this group and stop receiving emails from it, send an email to appledoc+u...@googlegroups.com.
To post to this group, send email to appl...@googlegroups.com.
Visit this group at http://groups.google.com/group/appledoc.
For more options, visit https://groups.google.com/d/optout.

[Raymond Camden]

Sorry, plain comments? Do you mean:

/*

*/

Ie, no * on every line.

On Monday, July 14, 2014 1:16:55 PM UTC-5, Tom wrote:

There's some incompatibility on current appledoc branch regarding multiline comments that use star delimiters (like on your example). Try to use plain comments to see if it will work.

But otherwise yes, you use backticks for code spans - appledoc uses Markdown for formatting.

Tom

[Tom @ Gentle Bytes]

Sorry wasn't clear: you need to start with /** otherwise appledoc won't consider the comment, but no star on subsequent lines, so:

/**

*/

Alternatively you can use triple slash:

///

///

///

[Raymond Camden]

No luck with either format. I get the same results using 

/**

...

*/

or

/// 

formats.

On Mon, Jul 14, 2014 at 2:22 PM, appledoc on behalf of Tom <appl...@googlegroups.com> wrote:

Sorry wasn't clear: you need to start with /** otherwise appledoc won't consider the comment, but no star on subsequent lines, so:

/**

*/

Alternatively you can use triple slash:

///

///

///

--

===========================================================================
Raymond Camden, Web Developer for Adobe

Email : raymon...@gmail.com
Blog : www.raymondcamden.com
Twitter: raymondcamden

[Tom @ Gentle Bytes]

Hmm, try to remove stars from code spans, just for quick test. Let me know how it goes.

[Raymond Camden]

Nope, didn't help. If you want to test w/ my .h file, I can send it to you directly, I just can't share it publicly. (Code is still under NDA.)

--
You received this message because you are subscribed to a topic in the Google Groups "appledoc" group.
To unsubscribe from this topic, visit https://groups.google.com/d/topic/appledoc/eAJwYMugSRc/unsubscribe.
To unsubscribe from this group and all its topics, send an email to appledoc+u...@googlegroups.com.

To post to this group, send email to appl...@googlegroups.com.
Visit this group at http://groups.google.com/group/appledoc.
For more options, visit https://groups.google.com/d/optout.

[Tom @ Gentle Bytes]

Sure, send it to to...@gentlebytes.com and I'll take a look.

--
Sent from my iPad