GitHub is home to over 20 million developers working together to host and review code, manage projects, and build software together.
In my documentation i have some exemples blocs.
When i create doc, i have a lot of warning like this :
WARN | Invalid [[NSNotificationCenter defaultCenter] reference found near My_Class_File.h@57, unknown object!
this line is an exemple bloc of code.
i have test with markdown notation ( tabs spaces) and but the warning are alway here.
It's probably due to appledoc noticing [NSNotificationCenter defaultCenter] in comments and thinking it's a cross reference to a class NSNotificationCenter but that class isn't part of the project (obviously as it's framework class :). To overcome, switch to explicit cross references mode. It will require embedding "wanted" cross references into '<' and '>' (or your custom strings if you'd use --crossref-format), but it'll also prevent warnings from happening.
Sure, it's one of the tradeoffs between simplicity and control...