The Stanford Natural Language Processing Group home · people · teaching · research · publications · software · events · local

How to Generate JavaNLP Javadocs

Generating Javadocs for your local code

To generate and evaluate javadocs for your local code (which may have been modified since your last commit), go to your main javanlp/ dir and type "make jdoc" or ant javadoc. This will generate javadocs from your src/ dir and put them in your javadoc/ dir. Look for any warnings that get generated, this will tell you where you've made mistakes that need correcting. The main web page will be javdoc/index.html (use your favorite web browser, or make a symbolic link to your public web dir if you like).

Installing Javadocs on the NLP Website

Once you've made sure your javadocs look good, commit your changes to CVS. Then run (i.e. type) /u/nlp/java/install-javanlp-javadoc.sh to install them on the web site. This script will check out a fresh copy of the repository (so make sure your changes are committed first!) and generate the javadocs, then (if there are no errors), copy them over to the web site. The script creates a lock file, /u/nlp/java/.javanlp-javadoc-install.lock, to prevent more than one install at a time, so make sure to delete this file after the install process finishes. The script will prompt you to delete this file when it's done, but if you abort the process in the middle, you must delete the file yourself. There's a link to the official javanlp javadocs off the javanlp home page. There's also a log kept of every successful installation in /u/nlp/java/javanlp-javadoc-install.log.