Standards for storing the Javadoc generated html files?
I'm new to using Javadoc have the following questions:
1) Does anyone know of any standards as to what directory structure should be used to store the Javadoc generated html files?
2) When working with a development and production environment, where should they be stored? Only on the development server or on both?
3) When setting up a html page to link to all of the various Javadoc generated files for all of our applications, should we just manually create an html page that links to them or is there a tool that will take care of this?
Any information that can be provided will be a big help!
[637 byte] By [
cavlear] at [2007-9-26 12:29:34]
1) All you do is specify a directory with the -d option and Javadoc creates the directory structure below that. We often use either "-d docs" or "-d html" to create a directory named "docs" or "html" in the current directory.
2) Preferably they should be stored on a server that has a web server running so people can access them. We build the docs nightly on the development server where people can access the latest version using a file: URL (not with a web server). Then before each release we stage them on our intranet before we push them out to the intranet. We also run the DocCheck doclet and a link checker nightly so developers and writers can find errors in their documentation.
3) If you want a top-level page that links to separate javadoc documents, you need to do this manually. However, keep in mind that you can also inter-link all those separate documents by using the -link or -linkoffline option.
Let us know if you have more questions or comments.
-Doug Kramer
Javadoc team
