Documentation Wizard

Together provides documentation support for your Java projects. The process uses Javadoc, but includes additional functionality for graphics and navigation. The wizard described below guides you through the process of creating documentation. For step-by-step instructions, see Generating Documentation.

 

Option Description Default
Select elements to include Check the project or parts of the project to include. Only one project can be documented at a time. Expand the nodes to see individual elements.
NB: Custom properties from plugins or new profiles will be exported as well. 		Active projects
Select destination type Select one of the following:
  • Directory: Places documentation in a directory structure, the location of which you specify in the "Destination" box below.
  • Jar file: Creates documentation in a jar file whose path and name you enter in the "Jar file" box below.
  • E-mail: Sends the results of the documentation via email. To use the latter option, you must have specified an email server, user, and password on the Documentation preferences page.
 Directory
Destination This is where your documentation will reside. If you enter a destination directory that does not exist, Together asks you to confirm that you want to update the specified path with a new directory. If so, it will be created during document generation.

NB: Due to a limitation in JDK 1.4.0, if your browser uses this JDK for applets, you should delete any spaces in the destination name.

  • Directory option: <project name>/out/UMLDocumentation
  • JAR option: <project name>/out/UMLDocumentation/documentation.jar
  • E-mail option: a jar file to specified recipient
    		•

    NB: If the message "Javadoc command location not specified on the Javadoc preference page" appears at the top of the dialog, exit the wizard and configure your Javadoc preferences as follows. From the menubar, select Window > Preferences. Expand "Java," and select "Javadoc." On the right-hand side of the dialog, enter the location of your javadoc.exe file. Typically, this in the bin directory of your sdk or jdk.

    Configure

     

    Option Description Default
    Generate diagrams for selected project's elements Includes diagrams for your project elements. For instance, a project with five packages could have five diagrams, each diagram an svg (Scalable Vector Graphics) file. You can view these in the browser by clicking the diagram icon in the treeview project frame. For more, see Documentation Output. On
    Generate QA reports for selected project's elements Includes a QA report listing audit and metric statistics. In a multi-package project, for example: One broad report lists results for the entire project, and includes a pie chart that represents warnings by package. Separate QA reports generate for and reside on the root of each package directory. You can view these in the help browser by clicking the quality assurance icon in the treeview project frame. For more, see Documentation Output. On
    Generate classes in navigator Determines if classes appear in the treeview project frame when viewing output. You may wish to turn this option off to simplify the tree structure. On
    Copy external documents to output directory If selected, linked external documents are copied to the output directory where your documentation files will reside. On

     

     

    Option Description Default
    Document Title You can enter a title that will appear as a heading for the overview-summary page, viewed in the javadoc frame of the browser output. For more, see Documentation Output. Checkbox: Off
    Text field: <blank>
    Basic Options    
    Generate use page Adds a "Use" link in the navigation bar of the overview-summary page. Also adds a use page for each documented class and package. To display use pages, first click on the class or package, then on the "Use" link in its navigation bar. For more, see Documentation Output. On
    Generate hierarchy tree Adds a "Tree" link in the navigation bar of the overview-summary page, and accompanying overview-tree.html page. This displays class and interface hierarchies for the project. Also adds a package_tree.html page to each package directory, listing the class and interface hierarchies for each package. On
    Generate navigation bar Adds a navigation bar to the top of the overview-summary page. For more, see Documentation Output. On
    Generate index and
    Separate index per letter    		 Adds an index link in the navigation bar of the overview-summary page. Adds accompanying index-all.html page with alphabetical listings of all project elements. Or, when used with "Separate index per letter" option, adds separate html pages for elements, one for each letter of the alphabet. On
    Document these tags    
    @author Includes author information in your documentation. On
    @version Includes version information in your documentation. On
    @deprecated Includes deprecated elements information in your documentation. On
    deprecated list Adds a link in the navigation bar of the overview-summary page. Adds accompanying deprecated-list.html page with list of deprecated APIs. On
    Create Javadoc for members with visibility Select one of the following:
  • Private: Shows all classes and members.
  • Package: Shows only package, protected, and public classes and members.
  • Protected: Shows only protected and public classes and members.
  • Public: Shows only public classes and members.
    		•  Public
    Select referenced classes to which Javadoc should create links Links to classes referenced in your project. Select an item to activate the Configure button which opens a dialog in which you can specify a javadoc location. Off
    Style sheet Allows use of a custom stylesheet to display your documentation. If checked, specify a path. If not used, Together will generate a default stylesheet and save it on the root of your documentation directory. Off

     



    Option Description Default
    Overview Specifies the path to the file of an overview document. This information will appear on the overview-summary page. The path and file name must be relative to the source path. Off
    Extra Javadoc options Executes additional Javadoc commands. <blank>
    Save the settings of this Javadoc export as an Ant Script Saves your settings to an Ant Script. If selected, the default path creates an xml file on the root of your project directory. You may also specify another path. Off

     

    If the target destination is not empty, the following dialog also opens:

    If you entered a destination other than the default, the following dialog also opens:

    Update default documentation location for project <projectname>

    If you click Yes, the next time you generate documentation for this project, the path you entered will default in the Generate UML Documentation dialog..

    		 N/A

    When the documentation process is complete, the following dialog also opens:

    Open generated documentation in browser If you chose "Directory" as your output option, the dialog above opens when document generation is complete. If checked, the documentation opens immediately in your default browser.

    Tip: On a windows system, you can also drag the index.html file on the root of your documentation directory from Windows Explorer into the help browser to view the documentation.
    		 On

    Navigate Menu Access to Documentation

    Once generated, you open documentation for a selected project by selecting Navigate > Open UML Documentation from the menubar.

     

    Related Topic:

    Generating Documentation
    Documentation Output