Documentation Generation Facility Overview

This feature automatically generates documentation for your project. Use this feature to illustrate you programme with the documentation in the HTML format. You can update this automatically generated documentation when your project changes, or edit this documentation manually afterwards.

Documentation files

All the documentation that Together generates is written to a single directory that you specify in the Output folder of the Generate HTML dialog box. By default, the generated documentation opens in your external web browser. The browser opens with a frameset to display the generated documentation. If you choose not to open the documentation immediately, you can open it later using the index.html file found on the root of the documentation directory specified in the Generate HTML dialog box.

HTML documentation frames

The HTML documentation contains three frames:

Diagram frame, when Include diagrams option is turned on
Project and Overview frame, when Include navigation tree option is turned on
PackageList and PackageOverview frame, when Include navigation tree option is turned off
Documentation frame

You can click the Project tab in the lower left frame and expand the nodes in the project tree view. Notice that clicking a class name in the Project tab opens the documentation in the lower right pane (the Documentation frame). When you select a diagram in the Project tab, it opens in the Diagram frame. Elements in the Diagram frame are hyperlinked to the Documentation frame. If you select an element in the Diagram frame, its contents are displayed in the Documentation frame.

The Documentation frame displays the documentation of your source code and diagrams, and includes everything you would expect when generating HTML documentation. The top of the Documentation frame contains a navigation bar for browsing your project documentation.

The Project tab contains a tree representation of the project. Expand the nodes to reveal individual diagrams and elements. Clicking a class or interface opens the related documentation in the Documentation frame.