CODEWITHSUNDEEP
packagejavadocdoxygen
Nate Glenn
Nate Glenn

Reputation: 6744

Doxygen and package.html

As per javadoc specifications, I placed a documentation file called package-info.html in the root directory of the relevant package. When I run Doxygen on that folder, however, the documentation in this file is not picked up. How do I tell Doxygen to use this file as the package documentation? I also tried package.html, the old specification, but that doesn't work., either

Upvotes: 2

Views: 1568

Answers (1)

Paŭlo Ebermann
Paŭlo Ebermann

Reputation: 74800

The new alternative way to provide documentation for a Java package is to use a file named package-info.java instead of package.html. (The file name is intentionally chosen not to be a valid class name.)

It has a different syntax:

/**
 * any javadoc comments (including tags)
 */
package name;

This is also the only way to provide package annotations (which are noted before the package keyword here, if any).

From your comments to the question, it looks like recent versions of Doxygen only understand this package-info.java, not the old package.html file.

I recall there being a module system proposed, which then would add a similar module-info.java file, but I don't find it now after a short googleing. (Maybe JSR 294?)

Upvotes: 3

Related Questions