Package Frame Behavior
I am having trouble with the ever-so-famous overview-frame (the one in the upper-left corner of the index.html that Javadoc produces). The problem is that, while I have managed to get that window to appear in previous configurations, it does not appear now under a similar one.
I am running Cygwin under Windows 2000. The command I am passing Javadoc is as follows:
javadoc -d ../docs -windowtitle "Local Java Source" -package \
com/people1/project/*.java \
com/people2/common/exception/*.java \
com/people2/common/interfaces/*.java \
com/people2/net/*.java \
"com/people2/test/*.java" \
com/people2/util/*.java
Something similar to this has run before, but I unfortunately lost it due to a bad driver install and a foolish failure to back up my work. Any clues would be appreciated.
Thanks!
-Zach
[885 byte] By [
tvynr] at [2007-9-26 11:50:36]
To have the upper left frame appear, if you are using 1.2 or 1.3, you must pass in 2 or more package names. Passing in source filenames (for any number of packages) will not create the frames.
In 1.4, source filenames belonging to 2 or more packages will also make the frame appear.
-Doug Kramer
Javadoc team
BTW, I notice we get a lot of questions about how to make these frames appear.
I wonder if we should just turn on all three frames regardless of how many packages people are documenting.
Or should we go to the other extreme of giving people complete control over how many frames there are
with some -htmlframes option.
-Doug
I had originally thought that it depended on how many classes were involved. Obviously, if you are only putting 3 classes into a Javadoc, the overview frame is a bit unnecessary. My list grew, however, and I was a little confused.Thanks for the help; it looks great now. :)
tvynr at 2007-7-2 2:05:38 >
