Question

When programming in C++, I use Doxygen and frequently create external .dox files for additional documentation that won’t fit well in a specific class or method – for instance, file format documentation (for files that are accessed by multiple classes). I tried to find a way to do the same in Java, but it appears that javadoc doesn’t have an equivalent feature, all documentation must be written inside the comments of a .java file and is tied to it (or at least to its package). Am I right? Is there an alternative way to do this?

Answer 1

If you’re asking if Javadoc can create external documentation, then the answer is no. But you can link to external documentation you’ve already made. Additionally, if something applies to the package level, you can put the documentation in the package file instead of attaching it to a particular class or method.