I have not used javadoc and would like to start - I usually develope my own api (usually included in my users manual); however, I think the users of the software I am currently developing will benifit from the javadoc style most java developers are occustomed to.
Anyways, I have looked at sun's site on java doc and found thishttp://java.sun.com/j2se/1.4/docs/tooldocs/solaris/javadoc.html#sourcefiles
Both talk about package level comments. You basicaly but a package.html file in the root of each package directory. For instance, you have a package called foo.bar with a class in foo/bar/Old.java
What I want to do is document each root directory.
I want to describe the package foo in this html file but I do not want any .java files in the root of foo (its not approriate here)
I get an error from java doc when I do this
javadoc: No source files for package foo
However, if I do javadoc foo.bar.Old then it produces semi-right stuff (it doesn't include the comments I had in the package.html found in foo/bar/)
Anyone have any suggestions? Can you have a package.html w/out a coresponding .java file?