Using Javadoc from the Command Line

If you are using a plain text editor, you can run Javadoc from the command line. First, in the directory where your Java program is located, create a new directory named doc:

mkdir doc

Now run Javadoc:

javadoc -d doc DistanceUtility.java -tag pre.:a:"Precondition:" -link http://www.cse.yorku.ca/common/java/api

The generated documentation will be placed in the doc directory. You can use your web browser to open the index.html file to view the generated documentation.

Important: If you generate documentation for a different class in the same directory, javadoc will overwrite any existing documentation files in the doc directory.