How to disable return value as hyperlink using javadoc?
Joined: Sep 18, 2006
I have a method that return a class as return value, but that class does not have any published methods, so this class should not be published either.
I have the following javadoc comments added:
But in generated javadoc, MySampleClass is enabled as a hyperlink that user can click on, web browser cannot display the related page since
MySampleClass is not published. I am wondering how I can disable the hyperlink so it foes not give users false impression that this class is published?
Another weird thing is, the following class return value is not displayed as hyperlink even though I use similar javadoc comments, I cannot figure out
what is playing a role to enable/disable hyperlink here:
If this class is published, and this is the method's actual return type, then that return type is very much published. If you do not want "MySampleClass" to be published it cannot be the return type or parameter type of any published method. You should consider returning a published super class or interface instead.