I'm using headerDoc tags in XCode and can't seem to document private methods in .m files. Using sample syntax straight from Apple's site:
@implementation AppDelegate
/*!
This is an objective-C method.
@param application
Parameter A.
@param launchOptions
Parameter B.
@result
Results in global warming.
*/
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
}
Results in the following error:
Processing compassview/AppDelegate.m
/Users/me/workspace/iOS/myapp/AppDelegate.m:inputCounter: warning: Class braces do not match.
We may have a problem.
/Users/me/workspace/iOS/myapp/AppDelegate.m:194: WARNING: anonymous type.
IC: 181
DC: "end
"
TL: ""
NL: "end"
PT: ""
/Users/me/workspace/iOS/myapp/AppDelegate.m:194: warning: Unknown keyword in block-parsed declaration.
This usually means that your code requires C preprocessing in order to be
valid C syntax and either C preprocessing is not enabled (-p) or the required
macros lack HeaderDoc comments. Use of the @parseOnly tag is recommended
for these special symbols.
headerDoc tags outside the @implementation block work without this error.