Jenkins学习(4)——Jenkins生成Javadoc

      通过Jenkins生成Javadoc文档可以便于对构建任务中的类及相关功能的了解。使用javadoc生成用Maven的插件maven-javadoc-plugin。首先在项目中引入依赖：

<plugin>
	<groupId>org.apache.maven.plugins</groupId>
	<artifactId>maven-javadoc-plugin</artifactId>
	<version>2.5</version>
	<executions>
		<execution>
			<id>attach-javadocs</id>
			<phase>package</phase>
			<goals>
				<goal>jar</goal>
			</goals>
			<configuration>
			    <additionalparam>-Xdoclint:none</additionalparam>
			</configuration>
		</execution>
	</executions>
</plugin>

      在Jenkins中增加构建生成文档的构建步骤Public javadoc：

      然后增加构建后步骤，在Publish Javadoc配置部分中，设置生成的doc文档的位置。默认为 项目/target/site/apidocs，不同的Maven插件生成的位置不同，具体路径可以去Jenkins工作空间所对应的项目下去找，第一次配置时会提示目录不存在，因为直到运行到javadoc:javadoc命令时才会生成该目录。所以可以忽略提示信息。

如果在增加构建后步骤中找不到Public javadoc选项，检查Jenkins是否成功安装了Javadoc Plugin插件。

如果Javadoc Plugin安装正确则在点击增加后步骤时，会有如下选项：

配置完成，对构建作业进行构建。可在输出的日志中看到javadoc的生成日志。

构建成功后，构建作业的主页会出现Javadoc的文档链接：

      点击文档链接，进入查看文档详情。本项目为测试项目文档内容为随意编写。如需要正式使用则要使用详细的注释进行规则的文档生成。

至此，Jenkins集成Javadoc生成文档完成。