Documentation Output
When you generate
UML Documentation for your project, Together not only generates the Javadoc of
your source, but includes documentation for:
-
Design diagrams (use case diagram, state diagram etc...).
-
Design entities (use case, state etc...).
-
Quality Assurance (if you choose to include it).
All the documentation that Together generates is written to a single
directory that you specify when using the UML
Documentation wizard. Once the wizard runs, you are asked if you would
like to open the documentation in a browser. (If you choose not to open the
documentation immediately, you can open it later using the index.html file
on the root of your project's documentation directory.) When opened, the view
contains three frames, as shown below:
The Diagram Frame
When you select a diagram in the Project frame it opens here. Elements on the
diagram are hyperlinked to their relevant Javadoc pages. If you select an element
in the diagram, its contents are displayed in the Javadoc frame.
NB: If an element on a class diagram doesn't appear to be hyperlinked
it may be because its visibility was not part of the scope of the generated
documentation. Instead, it appears in the diagram, but there is no documentation
for it.
The diagram image is in SVG format, so you can right click on the image
and perform the following tasks:
The JavaDoc Frame
This frame displays the JavaDoc output of your source, and includes everything
you would expect when generating Javadoc.
At the top of this frame, notice the following links in the navigation bar:
- Overview: 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 which
includes summary and details tables for fields, constructors, and methods.
This link is only active from within a relevant page.
- Deprecated: List of deprecated API.
- Index: An alphabetical list of classes, interfaces, constructors, methods,
and fields.
- Help: A document that 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 ordered as they appear in the source
code.
The Project Frame
The Project frame contains a tree representation of the project or parts
of the project. Expand the nodes to reveal individual diagrams and elements.
Clicking on a class or interface opens the related documentation. In the example
below, for instance, clicking SaleDM in either the project or diagram frame
opens the documentation for that class in the Javadoc frame.
NB: Due to JDK 1.3 limitations, this functionality is most reliable
when using JDK 1.4.
Clicking on a diagram or diagram element opens that selection in the diagram
frame. You can also access QA documentation from this frame:
QA
If you choose to generate Quality Assurance reports within the UML Documentation,
the project will contain a QA report for the whole project. Each package will
also have its own individual QA report. Select Quality Assurance in the Project
frame, and the QA report opens in the Javadoc frame. The QA report is exactly
the same as the report you can generate from the Audits and Metrics table of
results in Together.