maven集成

与maven集成非常简单，在pom.xml中的<build><plugins>中加入maven-javadoc-plugin。具体请参考以下demo代码示例

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-javadoc-plugin</artifactId>
            <version>2.10.3</version>
            <configuration>
                <doclet>net.winroad.wrdoclet.HtmlDoclet</doclet>
                <docletArtifact>
                    <groupId>net.winroad</groupId>
                    <artifactId>wrdoclet</artifactId>
                    <version>1.0.2</version>
                </docletArtifact>
                <useStandardDocletOptions>false</useStandardDocletOptions><!-- important ! -->
                <additionalparam>
                    -systemname ${wrdoclet.systemname} 
                    -branchname ${wrdoclet.branchname} 
                    -buildid ${wrdoclet.buildid}
                    -encoding utf-8 
                    -charset utf-8 
                    -d ../../../../../wrdoclet-gh-pages/apidocs-demosite
                    -springcontextconfigpath ${project.basedir}/src/main/webapp/WEB-INF/mvc-dispatcher-servlet.xml
                    -excludedurlsxpath //:beans/mvc:interceptors/mvc:interceptor/:bean/:property/:list/:value
                </additionalparam>
                <sourcepath>${project.basedir}/../wrdoclet-beans/src/main/java;${project.basedir}/src/main/java</sourcepath>
                <subpackages>net.winroad.Controller</subpackages>
            </configuration>
        </plugin>
    </plugins>
</build>

上面例子中<additionalparam>节点所涉及的参数可参考上一节《命令行调用》。

${wrdoclet.systemname} 、${wrdoclet.branchname} 、${wrdoclet.buildid}是调用时传递进来的参数，可参考《Jenkins集成》一节。

sourcepath: 这个不是必须的。如果项目中有引用其它项目，并且希望在生成文档时也把该项目的相关注释包含进来时可以使用这个参数把其他项目的源文件包含进来。文件路径可以使用逗号或者分号分隔。

subpackages: 这个不是必须的。但是如果需要自定义文档附录的时候需要指定一下。如何自定义文档附录见《自定义文档附录》章节。