1. 程式人生 > >Jenkins學習(4)——Jenkins生成Javadoc

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生成文件完成。