Java Reference
In-Depth Information
mentation for a set of packages or classes, giving an overview of what
they do. You specify the
HTML
file to use as an overview when generating
the documentation.
19.5.2. The
doc-files
Directory
The
javadoc
program will copy the contents of a
doc-files
directory in a
given package into the generated documentation for that package. You
can use this feature to include images,
HTML
, class files, or any other
component you want to reference in your doc comment. For example,
you could indirectly include a set of formal rules in a large number of
doc comments:
@see <a href="doc-files/semantics.html">Formal Semantics</a>
Or you could use the directory to store useful images:
Made by Magic, Inc.<img src="doc-files/magiclogo.gif">
