Configuration and Usage

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

Configuring the Plugin

These settings are used by the report goal.

Setting	Type	Description
assembly	File	The assembly setting defines the location of the .NET assembly used to produce the documentation. The default value is ${project.build.directory}/${project.build.finalName}.dll and corresponds to the default assembly name used by the .NET Maven Plugin.
outputDirectory	File	The outputDirectory setting defines the location where generated documentation files are placed. The default value is ${project.build.directory}/ndoc.
xmldoc	File	The xmldoc setting defines the location of the assembly's XML documentation file used to produce the documentation. The default value is ${project.build.directory}/${project.build.finalName}.dll.xml and corresponds to the default XML documentation file name used by the .NET Maven Plugin.
includes	String[]	List of files to include. Specified as fileset patterns which are relative to the source directory.

Example Configuration

The follow configuration will generate NDoc documentation using the specified assembly XML documentation file:

<reporting>
  <plugins>
    <plugin>
      <groupId>net.sf.doodleproject</groupId>
      <artifactId>ndoc-maven-plugin</artifactId>
      <configuration>
        <xmldoc>${basedir}/target/${project.build.finalName}.xml</xmldoc>
      </configuration>
    </plugin>
    ...
  </plugins>
</reporting>