Example block may change single * to double **

[tomaz]

This example block:

- (void)doThis:(NSString *)value1 withThis:(NSString *)value2;

Will be converted to:

- (void)doThis:(NSString **)value1 withThis:(NSString **)value2;

The reason is in Markdown preprocessing which converts single * to double ** (note that it would be fine as long as only a single star is used). This should not be handled in example blocks and code sections. After converting to full Markdown support, detecting example blocks is not as simple as it was before (previously appledoc converted any tab or spaces prefixed blocks of lines into example blocks, but Markdown handles it differently based on previous context - list items for example).

This would also solve false invalid cross reference warnings handling from within example blocks - see #72.

[tomaz]

Fixed conversion of single to double star within example blocks and spans under certain circumstances. Closed by a85a42b.

The problem was with appledoc treating single star as bold and single underscore as italics while Markdown treats single star or underscore as italics and double star or underscore as bold. This requires appledoc preprocessing comment text and converting any single star marker to double star. However as Markdown processor doesn't convert markers inside code blocks, this effectively changed the layout in there. To further complicate the issue, appledoc preprocessor doesn't know in advance whether certain part of text will be converted to code block or not. To compensate, appledoc now leaves original markers untouched and uses placeholder strings when converting single stars to double ones. These placeholders are caught and properly handled later on, in generated HTML where detecting code block or span is simple.

[poussain]

I had this issue with my projects, and when I saw it was fixed, I checked the dev branch out, and now I have ugly *~!# instead of my * (in a code block) for example NSObject *object = [[NSObject alloc] init] transforms into NSObject *~!#object = [[NSObject alloc] init]

[tomaz]

Will check this, I thought it was affecting two stars, but obviously single one is also affected. This is the side effect of using external library for parsing Markdown. The **~!# markup is appledoc placeholder so that I can cleanup and properly handle example blocks. Should be easy to fix.

Oh, I will move main development to master branch and delete development branch as it's causing misunderstandings. GitHub users expect to have master branch as the front-most branch for project...

[tomaz]

Sorry, GitHub closed the issue when pushing data...

I'm trying to replicate the issue, but can't. !~# is placeholder for single stars markers, however there should be two of them in the same section (i.e. example block), it should leave single stars untouched. Can you post the whole of the comment text (or send me a private message through inbox)?

[tomaz]

Ok, check it out a bit and found two issues with code: first is cleaning up Markdown remote member links (i.e. [[Class method]](address)). Currently, appledoc regex doesn't parse such strings properly. Second part is due to appledoc handling of single star placeholders when two are found in separate example blocks. Working on both at the moment, so hopefully it'll be fixed soon.