Doxygen reference Multiple Parameter Method with @see Tag

Question

I am writing documentation for my iPhone app and I am running into a problem. I want to use a @see tag to reference another method in my documentation but the method has multiple parameters. I have tried including just the method name and the whole method stub but Doxygen doesn't seem it format it. How would reference a method with multiple parameters using the @see tag?

Method Header (URL.h)

+ (NSMutableString *)generateUrl:(NSString *) url fromParams:(NSMutableDictionary *)params;

Doxygen Tag (Failed Attemps)

@see URL#baseUrl
@see URL#generateUrl:(NSString *) url fromParams:(NSMutableDictionary *)params

score 3 · Accepted Answer · answered Aug 10 '11 at 18:10

3

Figured it out. It is the method name without any spaces, variable names or variable types like so ....

@see URL#generateUrl:fromParams:

answered Aug 10 '11 at 18:10

Stefan Bossbaly

6,682
9
53
82

Doxygen reference Multiple Parameter Method with @see Tag

1 Answers1