I have a Util package with source files in three seperate directories, defined like so:
The package is built with the first set of files and either one of the second or third set, to create a total of two different implementations of the same interface.
Now, I want to generate javadoc based on those files. How can I specify that? What I really want to do is
javadoc com.domain.util -sourcepath ./src;./src/Standard
to build the javadoc for the standard util package, and
javadoc com.domain.util -sourcepath ./src;./src/Extended
to build the javadoc for the extended util package. This doesn't work. The only way I've found so far to actually make it work is to merge the directory structure of the common classes and the Standard classes into another location and run with that for the standard javadoc, then do the same for the Extended package. Is there another way?
In the Package Explorer view, select a Java project and click Project > Generate Javadoc with Diagrams > Automatically. In the Generate Javadoc wizard, under Javadoc command, select the Javadoc command (an executable file). Note: Only Oracle JDK Version 1.4.
Nope, you shouldn't write javadoc for private methods. End users don't have access to private fields or methods so there really isn't a point in providing javadoc for them. Private fields and methods are only meant for the developer. If you really need to though, feel free to write comments for non-obvious logic.
I ended up writing a script to copy the two directories into a third temp directory and run the javadoc on that.
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With