appledoc icon indicating copy to clipboard operation
appledoc copied to clipboard

WARN Invalid reference found, unknown object!

Open cccooolll opened this issue 13 years ago • 10 comments

WARN | Invalid [[NSFileManager defaultManager] reference found near MyClass.h@199, unknown object : [NSFileManager !

many warning when I add some sample code in my comments

/**
 [[NSFileManager defaultManager] isFolder]
 */

cccooolll avatar Sep 22 '12 01:09 cccooolll

Sample code should be writen either as Markdown code block or inline code in order for it not being processed.

Note that with 2.x, code blocks are not handled very well, so you might still get warnings, but in 3.0 with new Markdown engine, I'll be able to handle this in a better way.

On Sat, Sep 22, 2012 at 3:01 AM, cccooolll [email protected] wrote:

WARN | Invalid [[NSFileManager defaultManager] reference found near MyClass.h@199, unknown object : [NSFileManager !

many warning when I add some sample code in my comments

/** [[NSFileManager defaultManager] isFolder] */

— Reply to this email directly or view it on GitHubhttps://github.com/tomaz/appledoc/issues/253.

tomaz avatar Sep 24 '12 09:09 tomaz

This is still the case in 2.1 (build 840).

This comment: https://github.com/aerogear/aerogear-ios/blob/appledoc/AeroGear-iOS/AeroGear-iOS/AGPipeline.h#L22

causes these warnings:

WARN | Invalid [NSURL URLWithString:@"http://todo-aerogear.rhcloud.com/todo-server/"] reference found near AGPipeline.h@22, unknown object : NSURL ! WARN | Invalid [AGPipeline pipeline:serverURL] reference found near AGPipeline.h@22, unknown method!

matzew avatar Oct 22 '12 13:10 matzew

Also - I think even worse - these URL is rendered twice, see:

http://people.apache.org/~matzew/AppleDocDoubleURL.png

matzew avatar Oct 22 '12 13:10 matzew

2.1 didn't touch Markdown handling; until I change to parser with callbacks, such errors will be very difficult to deal with. I wrote about this in other tickets and my blog.

FYI: 3.0 uses sundown and feels much more reliable.

tomaz avatar Oct 22 '12 17:10 tomaz

@tomaz thanks for the feedback, can you point me to the 3.0 branch ?

matzew avatar Oct 29 '12 07:10 matzew

It's called experimental because it's still very early in dev process. Besides parsing it doesn't do much.

I just started work on Markdown parsing couple of months ago, but don't think I've pushed it to GitHub yet. Then I had to jump to other projects so effectively it lied stagnant for all this time. My current engagement is slowly coming to an end, so I expect to come back in the following week(s).

tomaz avatar Oct 29 '12 09:10 tomaz

Is there a workaround for this warning in the 2.x version?

neilgall avatar Mar 28 '13 16:03 neilgall

Unfortunately not...

tomaz avatar Mar 28 '13 16:03 tomaz

Is there any update on this issue? It seems to produce a lot of warnings when building ResearchKit documentation.

rsanchezsaez avatar May 26 '15 00:05 rsanchezsaez

A workaround for this issue is now possible on the referenced pull request.

rsanchezsaez avatar May 26 '15 22:05 rsanchezsaez