doxygen:doxygen

Note:This goal should be used as a Maven report.

Full name:

de.gsi.cs.co.maven.plugins:doxygen-maven-plugin:0.0.1-SNAPSHOT:doxygen

Description:

Creates a doxygen report for all your native C/C++ files in the project.sourceDirectory

Attributes:

  • Requires a Maven project to be executed.
  • Binds by default to the lifecycle phase: site.

Required Parameters

Name Type Since Description
outputDirectory String - output directory
Default value is: ${project.reporting.outputDirectory}/doxygen.
project MavenProject - Mavens project context for injection purposes
Default value is: ${project}.
project_name String - doxygens PROJECT_NAME
Default value is: ${project.artifactId}.
project_number String - doxygens PROJECT_NUMBER
Default value is: ${project.version}.

Optional Parameters

Name Type Since Description
doxygen LinkedHashMap - doxygen key-value list. You should really now what you are doing if you mess with these. They won't be validated. <doxygen> <generate_treeview>NO</generate_treeview< </doxygen>
exclude List - doxygens EXCLUDE default: empty
input List - doxygens INPUT
TODO We need to check if it makes more sense to default to scons build directory. That way only needed files will be parsed and we get access to generated files Defaults to ${project.build.sourceDirectory}
pattern List - doxygens FILE_PATTERN default: *.c *.cc *.cxx *.cpp *.c++ *.h *.hh *.hxx *.f (but in doubt check source)

Parameter Details

doxygen:

doxygen key-value list. You should really now what you are doing if you mess with these. They won't be validated. <doxygen> <generate_treeview>NO</generate_treeview< </doxygen>
  • Type: java.util.LinkedHashMap
  • Required: No

exclude:

doxygens EXCLUDE default: empty
  • Type: java.util.List
  • Required: No

input:

doxygens INPUT
TODO We need to check if it makes more sense to default to scons build directory. That way only needed files will be parsed and we get access to generated files Defaults to ${project.build.sourceDirectory}
  • Type: java.util.List
  • Required: No

outputDirectory:

output directory
  • Type: java.lang.String
  • Required: Yes
  • Default: ${project.reporting.outputDirectory}/doxygen

pattern:

doxygens FILE_PATTERN default: *.c *.cc *.cxx *.cpp *.c++ *.h *.hh *.hxx *.f (but in doubt check source)
  • Type: java.util.List
  • Required: No

project:

Mavens project context for injection purposes
  • Type: org.apache.maven.project.MavenProject
  • Required: Yes
  • Default: ${project}

project_name:

doxygens PROJECT_NAME
  • Type: java.lang.String
  • Required: Yes
  • Default: ${project.artifactId}

project_number:

doxygens PROJECT_NUMBER
  • Type: java.lang.String
  • Required: Yes
  • Default: ${project.version}