Documentation Output
The Together documentation generator documents your projects as web-ready html and
graphics files. If you chose "Directory" as the output option the
subdirectories files are created in a directory whose name and location you
can specify. If you chose "JAR" or "E-mail," the same files
are created, but archived in a JAR file which is saved or emailed as you specified.
Browser View
When the documentation process finishes, a dialog asks if you wish to view the
output in a browser. To do so, check the option, or manually open the index.html
file created on the root of your documentation directory.
When opened in a browser, the view contains three frames: a diagram frame,
a project frame, and the documentation itself. In the documentation frame, the
default page is the overview. The default diagram is your project diagram, and
the treeview is a collapsed view of your project's structure.
Navigation
There are several ways to navigate the documentation. You can use the diagram
at the top, the java applet tree in the lower left, or the navigation bar in the
lower right frame. In the example below, clicking SaleDM in either the tree or
in the diagram, opens the documentation page for that class.
Diagram Navigation:
The diagram is similar to the diagram you created in Together. But each package/element
is a link to the documentation for that selection. The project diagram defaults,
but you may open individual diagrams by clicking their nodes in the treeview applet.
Treeview Navigation:
The treeview applet resembles the UML Navigator view in Together. Expand the
nodes to reveal individual diagrams and elements. Clicking on a class or interface
opens the related documentation. Clicking on a diagram or diagram element opens
that selection in the diagram frame.
Navigation Bar:
At the top of the documentation frame is a navigation bar with links including:
- Overview: Provides a list of all packages with links to the documentation
page for each.
- Package: Each package has a page that contains a list of its classes and
interfaces, with a summary for each. This link is only active from within
a relevant page.
- Class: Each class has a page with a description of its contents. This link
is only active from within a relevant page.
- Deprecated: Lists deprecated API.
- Index: An alphabetical list of classes, interfaces, constructors, methods,
and fields.
- Help: Describes the contents of the documentation frame and use of links.
- Frames/No Frames: The frames view includes the frames shown above. In the
no frames view, only the contents of the documentation frame is visible.
- Summary/Detail: Each summary entry contains the first sentence from the
detailed description for that item. The summary entries are alphabetical,
while the detailed descriptions are in the order they appear in the source
code.
Related Topics:
Documentation Wizard
Generating Documentation