By default, Jadexdoc uses a standard doclet that generates HTML-formatted
documentation. This doclet generates the following kinds of files (where each
HTML "page" corresponds to a separate file). Note that Jadexdoc
generates files with two types of names:
those named after agents/capabilities, and those that are not (such as
package-summary.html
).
Files in the latter group contain hyphens to prevent
filename conflicts with those in the former group.
Basic Content Pages.
One agent (agentname.agent.html
)
or capability (capabilityname.capability.html
)
page for each agent or capability is documented.
One package page (package-summary.html
)
for each package it is documenting. The Jadexdoc tool will include any
HTML text provided in a file named
package.html
in the package directory of the source tree.
One overview page (overview-summary.html
) for
the entire set of packages.
This is the front page of the generated document. The Jadexdoc tool will include
any HTML text provided in a file specified with the
-overview
option. Note that this file is created only if you pass
into Jadexdoc two or more package names.
Cross-Reference Pages.
One agent/capability hierarchy page for the
entire set of packages (overview-tree.html
).
To view this, click on Overview in the navigation bar, then click on
Tree.
One agent/capability hierarchy page for each package
(package-tree.html
). To view this, go to a particular package, agent or
capability page; click Tree to display the hierarchy for that package.
An index (index-*.html
) of all agent,
capabilities, beliefs, plans, goals, events and expressions names,
alphabetically arranged.
Support Files.
A help page (help-doc.html
) that
describes the navigation bar and the above pages. You can provide your own custom help file to
override the default using -helpfile
.
One index.html
file
which creates the HTML frames for display. This
is the file you load to display the front page with frames. This file itself contains
no text content. Several frame files (*-frame.html
) containing lists of
packages, agents and capabilities, used when HTML frames are being displayed.
A style sheet file (stylesheet.css
)
that controls a limited amount of color, font family, font size, font style
and positioning on the generated pages.
A doc-files
directory that holds any image, example,
source code or other files that you want copied to the destination directory.