how to hide few method names to be hidden in the javadoc
Have few set of APIs (methods ) and have javadoc comments included for all the methods.
Requirement is to generate the javadoc for few methods among the whole set.So how to get those methods alone hidden in the javadoc generation?
Used ( // ) and commented out the javadoc comments, but still the method names are seen in the javadoc(html file).
Only if the method is commented out, the methods are not visible in the html file which is not recommeded for my requirement which breaks up the compilation of the whole set of code.
Need ur advise.
[575 byte] By [
cbalarama] at [2007-10-3 9:41:48]
Yes. Thanks Doug for suggesting DocFlex!
> Used ( // ) and commented out the javadoc comments, but still the method names are seen in the javadoc(html file).
Sure, without comments, a method will still be documented, as Javadoc always has something to say about it -- that is, the method is there, has such an such parameters and so on.
Using DocFlex/Javadoc, you can filter out all methods you don't want to include in the generated docs. In fact, now you can do this even using only the freeware edition (called DocFlex/Doclet). You can download one from this page: http://www.filigris.com/downloads/
All you will need, is to mark those methods you want to exclude from the generated docs with a certain tag, for instance @hide (or any other). Just insert that tag in the method's comment, for example like this:
/**
* This method I want to hide.
*
* @hide
*/
Then, run Javadoc with the DocFlex/Doclet and specify in the "Exclude by tags" parameter that very @hide tag (or any others).
If you need a more complicated filtering, you will still be able to do this using DocFlex. (However, you will need a license for this.) In that case, you will need to slightly modify the provided basic templates using a graphic Template Designer, so as to specify a more complicated filtering condition. Basically, the filtering by tags is programmed by defining a filter on a few iterators using functions like
hasTag(String tagName)
Those functions are part of the template language. You can find all descriptions of them when running Template Designer | Help | Assistant menu item. The syntax of the filter expressions is similar to Java.
As a "success story", here is the thread "how to filter HTML javadoc output ?" found nearby, see
http://forum.java.sun.com/thread.jspa?threadID=782440
In fact, the author of that thread has eventually turned to our tool and successfully quickly resolved his problem using DocFlex/Javadoc.
After all, if someone has aleady done this, why not to use it?
The DocFlex/Javadoc home page is here:
http://www.filigris.com/products/docflex_javadoc/
Best regards,
Leonid Rudy
http://www.docflex.com
