CODEWITHSUNDEEP
javajavadocjava-modulemodule-info
Raedwald
Raedwald

Reputation: 48682

Javadoc comments in module-info

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?

Upvotes: 7

Views: 2277

Answers (2)

Mureinik
Mureinik

Reputation: 311823

In a word - yes. You can see, for example, how Java 9's Javadoc has module-level documentation (including tags for provides, uses, moduleGraph), 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.jshell module documentation.

Upvotes: 7

Naman
Naman

Reputation: 31968

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 :

  1. @index
  2. @summary

and then module specific

  1. @provides
  2. @uses

Upvotes: 3

Related Questions