include only interfaces and package-level comments -
hi jd forum -
forgive if this is covered elsewhere. i've found references to -include, -exclude, and 'docset', but i can't find these in the documentation at http://java.sun.com/j2se/1.3/docs/tooldocs/win32/javadoc.html (maybe it's for a different version).
i want to only include documentation for interfaces and exclude the classes -- and / or include documentation on a filename basis -- like 'document only IBI*.java.' also, i want to include ONLY package-level documentation (package.html) for some packages but not the javadocs for their associated classes...
are these things possible? i've looked into -package, -protected, and -public, but these don't seem to cover it.
thanks in advance;
-m
[760 byte] By [
sapportals] at [2007-9-26 18:54:06]
The -include and -exclude options and @docset tag were considered for 1.4 but then decided against by the Javadoc team as we look for other solutions.
You can document all public interfaces by passing their source filenames in to javadoc. Say, if the source files are in ./src, then:
javadoc -d docs ./src/com/package/Interface1.java /src/com/package/Interface2.java
You can use the wildcard asterisk here as well:
javadoc -d docs ./src/IBI*.java
There's no way to document the package-level documentation without the associated classes. Javadoc 1.4 has an -exclude option, but it works only to exclude packages from the -subpackages option, which is a shortcut for passing in package names.
A workaround could be to put the package.html file in a doc-files directory and then add a link to it in overview.html. It won't be processed, so won't have the navigation bars on the top and bottom, and cannot be automatically linked to from other places (index).
-Doug Kramer
Javadoc team
