I am currently creating the documentation for a class with many functions. Is there any way to organize the JavaDoc such that the methods in the overview are divided into a few categories?
I am currently creating the documentation for a class with many functions. Is there any way to organize the JavaDoc such that the methods in the overview are divided into a few categories?
I am afraid its not Javadoc - but doxygen supports grouping items in the output.
I've used doxygen in preference to Javadoc for personal projects, and for multi-language projects professionally. The documentation comment format is close enough to Javadoc for the most part, but I've found it much richer and extendable, and the output is just better.
Heck, for one project we published the Users Guide and API Guide as PDF through doxygen...