Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

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?

like image 672
McLeary Avatar asked Mar 30 '12 20:03

McLeary


People also ask

How do I enter a code on doxygen?

You can put example source code in a special path defined in the doxygen config under EXAMPLE_PATH , and then insert examples with the @example tag. Doxygen will then generate an extra page containing the source of the example. It will also set a link to it from the class documentation containing the example tag.

What does @{ mean in doxygen?

Doxygen will put members into the group whose definition has the highest "priority": e.g. An explicit \ingroup overrides an implicit grouping definition via @{ @} . Conflicting grouping definitions with the same priority trigger a warning, unless one definition was for a member without any explicit documentation.


1 Answers

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:
like image 117
Andy Friese Avatar answered Oct 09 '22 09:10

Andy Friese