Configuration and Usage

This document is intended to provide instructions for using the Doxygen Maven Plugin.

Configuring the Plugin

These settings are used by the report goal.

Setting	Type	Description
alphabeticalIndex	Boolean	The ALPHABETICAL_INDEX Doxygen setting. If set to true, an alphabetical index of all compounds will be generated. The default value is false.
columnsInAlphabeticalIndex	Integer	The COLS_IN_ALPHA_INDEX Doxygen setting. Specifies the number of columns in which the alphabetical index list will be split. The default value is 3.
configurationFile	File	Defines the location of a Doxygen configuration file to use that contains additional Doxygen settings not directly supported by the plugin. Using a configuration file augments all other configuration settings of the plugin. The default value is ${basedir}/src/doxygen/doxygen.config.
executable	File	Defines the location of a Doxygen executable used to generate the documentation. The default value is doxygen.exe.
filePatterns	String	The FILE_PATTERNS Doxygen setting. Specifies one or more wildcard patterns to filter out the source-files in the directories. The default value is *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp .h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm.
generateHtml	Boolean	The GENERATE_HTML Doxygen setting. If set to true, HTML documentation is generated. The default value is true.
generateLatex	Boolean	The GENERATE_LATEX Doxygen setting. If set to true, LaTeX documentation is generated. The default value is false.
htmlFooter	File	The HTML_FOOTER Doxygen setting. Specifies the custom HTML footer used for the generated HTML documentation. The default value is ${basedir}/src/doxygen/footer.html.
htmlHeader	File	The HTML_HEADER Doxygen setting. Specifies the custom HTML header used for the generated HTML documentation. The default value is ${basedir}/src/doxygen/header.html.
inputDirectory	File	The INPUT Doxygen setting. Specifies the directory that contains source files. The default value is ${basedir}.
outputDirectory	File	The OUTPUT_DIRECTORY Doxygen setting. Specifies the directory into which the generated documentation will be written. The default value is ${project.build.directory}/apidocs.
projectName	String	The PROJECT_NAME Doxygen setting. Specifies the project name for which the documentation is generated. The default value is ${project.name}.
projectNumber	String	The PROJECT_NUMBER Doxygen setting. Specifies the project version for which the documentation is generated. The default value is ${project.version}.
recursive	String	The RECURSIVE Doxygen setting. If set to true, subdirectories of the inputDirectory are searched for source files. The default value is true.
workDirectory	String	Specifies a work directory used to hold any intermediate build files. The default value is ${project.build.directory}/doxygen.

Example Configuration

The follow configuration will generate HTML documentation for all Java files found in the ${basedir}/src/main/java directory:

<plugin>
  <groupId>net.sf.doodleproject</artifactId>
  <artifactId>doxygen-maven-plugin</artifactId>
  <configuration>
    <alphabeticalIndex>true</alphabeticalIndex>
    <generateHtml>true</generateHtml>
    <inputDirectory>${basedir}/src/main/java<inputinputDirectory>
    <filePatterns>*.java</filePatterns>
    <recursive>true</recursive>
  </configuration>
</plugin>