doxygen maven report

The doxyen maven report plugin creates a doxygen site report from nativ code in the project.sourceDirectory. It requires an installed version of doxygen in your search path.

Goals Overview

  • doxygen:doxygen Generates a Doxyfile in project.build.directory

Usage

Include plugin in the project configuration

<project>
        <reporting>
                <plugins>
                        <plugin>
                                <groupId>de.gsi.cs.co.maven.plugins</groupId>
                                <artifactId>doxygen-maven-plugin</artifactId>
                                <version>0.0.1-SNAPSHOT</version>
                        </plugin>
                </plugins>
        </reporting>
</project>

To add configuration

<project>
        <reporting>
                <plugins>
                        <plugin>
                                <groupId>de.gsi.cs.co.maven.plugins</groupId>
                                <artifactId>doxygen-maven-plugin</artifactId>
                                <version>0.0.1-SNAPSHOT</version>
                                <reportSets>
                                        <reportSet>
                                                <id>default</id>
                                                <reports>
                                                        <report>doxygen</report>
                                                        <configuration>
                                                                <inputs>
                                                                        <input>${project.build.directory}/foo</input>
                                                                </inputs>
                                                        </configuration>
                        </plugin>
                </plugins>
        </reporting>
</project>

Configuration

  • project_name, string, defaults to artifactId
  • project_number, string, defaults to artifact version
  • inputs, stringlist, directories to scan, defaults to project.sourceDirectory
  • patterns, stringlist, filenames to accept, defaults to *.c cc cxx cpp c++ h hh hxx f (in doubt check source)
  • excludes, stringlist, directories to exclude, default is empty