appledoc

appledoc copied to clipboard

If you're trying to document externalized string constants with appledoc, there doesn't seem to be any way to make it appear in the generated documentation. Apple's documentation does contain such constants, like those at the bottom of the page for NSError under the Constants section (https://developer.apple.com/library/mac/documentation/Cocoa/Reference/Foundation/Classes/NSError_Class/Reference/Reference.html#//apple_ref/doc/uid/20001704-CJBIAHGF).

Would love such a feature. Same goes for public-facing enums and structs.

@emaloney I can get enums documented using:

/** Error codes used by CLIOptionParser */
typedef NS_ENUM(NSUInteger, CLIOptionParserErrorCode) {
    /** An option that required an argument was not supplied with that argument */
    kCLIMissingRequiredArgument = 1,
    /** An option that wasn't specified was encountered */
    kCLIUnknownOption,
    /** There are multiple errors which can be found the error's userInfo dictionary under the key CLIMultipleErrorsKey */
    kCLIMultipleErrors
};

Note: this won't work unless you use the NS_ENUM macro. Regular enums are not noticed by appledoc.

I don't know about structs though.

Cool, I wasn't aware of that. Thanks!

Are externalized string constants still not supported?

+1

+1

+1