Friday, October 21, 2016

javadoc tutorial ala roseindia style

javadoc tutorial ala roseindia style

i had trouble running javadoc on a code repo i am working on this past few days and i thought i would document how i solved the problem. below is the command i ran on the command line.

/home/rs8350/git/bpub-java : javadoc -verbose -d ./docs -sourcepath /home/rs8350/git/bpub-java/
-subpackages psp

-verbose == to see the full output of the tool
-d == to set the path of the output directory (where the javadoc documents live :)
-sourcepath == this is ONE directory above your main package (just experiment, it's hard to explain)

i don't know why you would need -subpackages except to say the person who wrote javadoc well ....

you NEED -subpackages btw, i just checked and javadoc does not run without the name of that root class.