Search code examples
objective-cdoxygendocumentation-generation

Reference a specific class method with @see command using Doxygen


I was not able to reference a specific class method using the doxygen @see command.

Suppose I have a class Server with a method start like below

@interface Server : NSObject

- (void) start:(NSInteger) mask;

@end

And suppose I have another class that has an object of Server.

@interface RandomNumberGeneration

/// How can I reference the method start from 
/// class server using the command @see
/// @see ????
+ (NSInteger) generate;

@end

So, is there a way to reference the method start of class Server?


Solution

  • Copied from here

    @see text | URL | classname | classname#methodname Use this to tag to refer the reader to some other source of related information.

    So I guess it should be:

    /// @see Server#start: