appledoc
appledoc copied to clipboard
Objective-c code Apple style documentation set generator.
I was having an issue where apple doc would bail out of a class and report no errors. I was getting docs generated to a specific point in the file...
I'm trying to convert someone's doxygen-marked-up code to use appledoc. It seems doxygen lets you give sections names, thus: `@section library The Library` Then when you want to refer to...
I'm getting this error when running appledoc on a set of code: Oops, something went wrong... NSInvalidArgumentException: -[__NSCFString appendString:]: nil argument @ 0 CoreFoundation 0x00007fff95ea825c __exceptionPreprocess + 172 @ 1...
If you pass --no-use-code-order it will alpha sort the results, but it does not sort the Tasks list.
Example: ``` /** documenting something (hello bracket) this is ignored in the output ``` Anything past the first line is simply omitted in the output.
Method declaration line (i.e. "- (void)doSomethingWith:(id)value") could include cross references to known objects in method result and argument types. Probably links should use same color as the rest of the...
Following interface fragment will cause the "execute" word to generate a link to the undocumented method execute: ``` /** * Initializes the action * * @param block Block to execute....
I've come across this a couple times now using appledoc v2.2 (build 963). In the class overview for class A I add the name of class B (a subclass of...
appledoc warns when encounters something like `[object doSomething:]` inside code section or example block. Many times this is just used as an example to make the documented entity more understandable....