The Java 9 modules feature adds (higher-level) module-info files in addition to the package-info files that existed previously. Can module-info.java (source-code) files include marked-up comments that the JavaDoc tool will extract and present (usefully) as module-level documentation?
Javadoc comments in module-info
Viewed 1403
2 Answers
In a word - yes. You can see, for example, how Java 9's Javadoc has module-level documentation, which then lists the packages in them with their documentation. The packages, in turn, contain classes with their documentation.
As a quick example, check out the jdk.shell module documentation.
Yes. And the tags supported at module declaration are:
Module Declaration
{@author}, {@deprecated}, {@provides}, {@see}, {@since}, {@serialField}, {@uses}, {@version}
{@code}, {@docRoot}, {@index}, {@link}, {@linkplain}, {@literal}, {@summary}
Source:- Documentation Comment Specification for the Standard doclet
Amongst these, the newly introduced tags you might further be interested in are :
and then module specific
Related