CODEWITHSUNDEEP
objective-cdoxygendocumentation-generation
McLeary
McLeary

Reputation: 1281

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?

Upvotes: 8

Views: 22983

Answers (2)

Chris
Chris

Reputation: 46316

See the doxygen manual page Automatic link generation for more information on referencing classes and functions. In particular see the section "Links to Functions".

Typically, I use the function refernce pattern

<className>::<functionName>

So in your case, I would use

/// \see Server::start

However, from the doxygen manual

For JavaDoc compatibility a # may be used instead of a :: in the patterns above

as stated in @PeterG.'s answer.

For completeness, note that if you a reference a member in the same class

In the documentation of a class containing a member foo, a reference to a global variable is made using ::foo, whereas #foo will link to the member.

Upvotes: 6

Andy Friese
Andy Friese

Reputation: 6489

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:

Upvotes: 10

Related Questions