Documentation Preferences

From the menubar, select Window > Preferences > Modeling > Documentation to change the preferences that determine how Together generates documentation:

General Tab

These options provide the default settings for the Configure dialog in the UML Documentation Wizard.


Option Description Default
Generate diagrams for selected project's elements Generates SVG images for all the diagrams in your project. When documentation generation is complete, the images are displayed in the Diagram frame of documentation output. On
Generate QA reports for selected project's elements Generates a QA report for each package that is included in the scope of your documentation. On
Generate classes in navigator Includes links to your project's classes in the Java applet treeview of documentation output. On
Copy external documents to output directory If the elements that are being documented contain hyperlinks to external documents/files, copies those documents/files to the output directory. If the documentation is moved the links are still valid. On

E-mail Output Tab

These options apply when you select "email" as the output option for your documentation in the UML Documentation Wizard.


Option Description Default
SMTP Server location    
Host Specifies the location of your mail server. <blank>
SMTP Authentication    
User Specifies the user name required by the server. <blank>
Password Specifies the password required by the server. <blank>
From    
Name Specifies a name by which to identify the sender. This will appear in the email header. <blank>
Address Specifies the sender's email address. This will appear in the email header. <blank>
Reply to Specifies where replies should be sent. This will appear in the email header. The field is used when replying to a message received from Together. <blank>

Related Topic:

Generating Documentation