khmarbaise/doxygen-maven-plugin

doxygen-maven-plugin

Doxygen Maven Plugin

License

Apache License, Version 2.0, January 2004

Issue Tracker

The Issue Tracker

Status

TODOs

Usage

The first and simplest usage is to configure the Maven Licenses Verifier Plugin

<plugin>
  <groupId>com.soebes.maven.plugins</groupId>
  <artifactId>doxygen-maven-plugin</artifactId>
  <version>1.1.0</version>
  <executions>
    <execution>
      <phase>test</phase>
      <goals>
        <goal>check</goal>
      </goals>
    </execution>
  </executions>
</plugin>

Settings Configuration

If you like you can configure an appropriate plugin group in your settings.xml file to make life a little bit easier.

<settings>
  ...
  <pluginGroups>
    <pluginGroup>com.soebes.maven.plugins</pluginGroup>
  </pluginGroups>
  ...
</settings>

doxygen-maven-plugin's Issues

Warnings not shown if quiet=true

If I set the Option quiet to true, no warnings are shown. This is WRONG, espacially if you use doxygens possibility, to warn about undocumented code.

Possibility to skip the generating

I have a multi module project and want to generate the doxygen only in the parent. Is it possible to include some skip parameter so that I can skip this plugin in the childs?

Is the plugin being hosted by main public maven repository?

Where can I find this plugin to put in my pom. I've checked the main maven repo at http://repo1.maven.org/maven2/ and could not find it. Is it being hosted in a publicly accessible repository somewhere?

Upgrade to newer parent 1.2.0 (smpp)

Fix links in docs

Several links in the docs (index.apt) page are not ok.

STRIP_FROM_PATH is always /home/marbkar/workspace-deps/depstest-0.2.0

Apparently the created doxygen.config always contains STRIP_FROM_PATH = /home/marbkar/workspace-deps/depstest-0.2.0 which certainly is wrong, as virtually nobody besides Karl-Heinz himself will have the need to strip exactly that path.

Apparently Doxygen must be installed

As the doxygen-maven-plugin does not attempt to download and install Doxygen "silently under the hood", the user has to do that manually. I'd like to propose to write that in the system requirements section of the docs. :-)

INPUT should be ${project.build.sourceDirectory}

It would be great if the plugin would automatically set INPUT to ${project.build.sourceDirectory}! :-)

Upgrade to smpp 1.0.0

Update to fluido skin

New layout

FILE_PATTERNS default apparently deviates from Doxygen's default

It is rather counterintuitive that the default of the FILE_PATTERNS option in the plugin is different from the one told in the Doxygen docs. This should be aligned to not confuse people.

Update copright informations

Docs,
POM etc.

Updated changes.xml

Update changes.xml file according to the fixed issues.

PROJECT_NAME is set to MIGRATION.PARENT

Seems there is a bug in the plugin. The created doxygen.config contains "PROJECT_NAME = MIGRATION.PARENT", where obviously it should use ${project.name} instead.

Example for parsing C and providing PDF

It would be cool to have a short example how to set up the POM so that Doxygen will parse C source found in src/main/c and provide a PDF output file. :-)