• FlexDoc/Javadoc
• Documentation

FlexDoc/Javadoc - Documentation

Installation / Configuration Files

1. Installation
2. Configuration Files
   • flexdoc.config
   • flexdoc.license
   • designer.config
   • generator.config

FlexDoc Doclet

1. Running Doclet
   • Javadoc Command Line
   • Command Line Options
     • Template Options
     • Output Options
     • Configuration Options
     • Other Options
2. Doclet GUI
   • Specifying Template
     • Setting Template Parameters
   • Selecting Output Format
     • HTML Option Inspector
     • RTF Option Inspector
     • TXT Option Inspector
   • Specifying Output Location
   • Starting Generation
3. Handling Template Parameters
   • Using Parameter Inspector GUI
   • Setting parameters from command line
   • Using Doclet GUI to prepare parameters for command line
   • Setting template parameters via Standard Doclet options
   • Multi-valued (list) parameters
     • Specifying list value in Parameter Inspector
     • Using escapes
     • Specifying list parameter on command line
4. Generation Phases
5. Error Reporting
   • Finding Error Location in Template

Integrations

• Apache Ant
• Apache Maven
• Gradle
• Eclipse
• Other Systems

Frequently Asked Questions

1. Troubleshooting
   • Cannot find doclet class
   • FlexDoc doclet is too slow
   • Missing overview and package summaries
2. HTML Output
   • Inserting "Mark of the Web" comment
3. RTF Output
   • Getting your images into RTF
   • Updating RTF fields in MS Word
   • Including RTF in larger MS Word document
   • Generating RTF for OpenOffice.org