使用ant javadoc 命令个性化生成项目javadoc (主要参数说明)

以前一直使用eclipse 自带的 export 的功能导出javadoc,功能本身还行,但是配置好了之后,要点击4次 next,不利于集成生成

 

maven 也可以生成javadoc,随着mvn install ,配置 

 

 

			<!-- -->
			<plugin>
				<groupId>org.apache.maven.plugins</groupId>
				<artifactId>maven-javadoc-plugin</artifactId>
				<version>2.7</version>
				<executions>
					<execution>
						<id>attach-javadocs</id>
						<goals>
							<goal>jar</goal>
						</goals>
					</execution>
				</executions>
			</plugin>
			<plugin>
				<inherited>true</inherited>
				<groupId>org.apache.maven.plugins</groupId>
				<artifactId>maven-source-plugin</artifactId>
				<executions>
					<execution>
						<id>attach-sources</id>
						<goals>
							<goal>jar</goal>
						</goals>
					</execution>
				</executions>
			</plugin>

 

 

但是一来 本来不想生成javadoc的时候,mvn install 会比较慢

二来不能个性化配置

 

 

最终我单独 ant 里面配置 输出javadoc,在这个过程中,弄明白每个参数的含义还是有意义的 ,首先我们来看效果 

 

 

 

直接上我的build.xml

 

 

 

<project name="feilong-core" basedir="." xmlns:artifact="antlib:org.apache.maven.artifact.ant">
	<description>feilong-core</description>
	<property file="${basedir}/build.properties" />

	<property file="E:/DataCommon/java/Taglib/Apache Ant/config/build-feilong.properties" />
	<import file="${path.config}/build-config-common-nested.xml" />
	<import file="${path.config}/build-feilong-nested.xml" />

	<!--由于使用的是maven 架构项目, 下面javadoc 需要引用 classpath -->
	<artifact:pom id="feilongMaven" file="pom.xml" />
	<artifact:dependencies filesetId="feilong.maven.dependencies.fileset" pathid="feilong.maven.dependencies.runtime" useScope="runtime">
		<pom refid="feilongMaven" />
	</artifact:dependencies>

	<artifact:dependencies pathid="feilong.maven.dependencies.system" scopes="system">
		<pom refid="feilongMaven" />
	</artifact:dependencies>

	<artifact:dependencies pathid="feilong.maven.dependencies.all">
		<pom refid="feilongMaven" />
	</artifact:dependencies>

	<!--javadoc -->
	<target name="javadoc">
		<!-- Destination directory(输出文件的目的文件夹) -->
		<property name="destdir" value="E:\javadoc\feilong-core" />

		<property name="source" value="1.6" />

		<!-- 指定使用什么样式 -->
		<property name="stylesheetfile" value="${basedir}/${ant.project.name}-javadoc.css" />
		<!-- 配置预览页面 -->
		<property name="overview" value="src/main/java/overview.html" />

		<!-- 这个参数可以用来配置帮助 -->
		<!--<property name="helpfile" value="src/main/java/overview.html" /> -->

		<!-- 浏览器窗口标题文件(文本) -->
		<property name="windowtitle" value="feilong-core 1.0 API" />
		<property name="additionalparam" value="-encoding UTF-8 -charset UTF-8" />

		<!-- Locale to be used -->
		<property name="locale" value="en_US" />
		<!-- Source file encoding name -->
		<property name="encoding" value="utf-8" />
		<property name="docencoding" value="utf-8" />
		<property name="charset" value="utf-8" />

		<!-- 包含 @author paragraphs -->
		<property name="author" value="true" />
		<!-- 包含 @version paragraphs -->
		<property name="version" value="true" />

		<property name="noindex" value="false" />
		<property name="nonavbar" value="false" />
		<property name="notree" value="false" />
		<property name="nodeprecatedlist" value="false" />
		<property name="nodeprecated" value="false" />

		<!-- Access mode: one of public, protected, package, or private -->
		<property name="access" value="public" />
		<!-- Create class and package usage pages -->
		<property name="use" value="true" />

		<property name="verbose" value="true" />
		<!-- 分割索引成单独的文件 如果是true,则生成index-files文件夹,里面存放单独的索引文件 -->
		<property name="splitindex" value="true" />

		<!-- 保证生成的javadoc 是最新的 -->
		<mkdir dir="${destdir}" />
		<delete dir="${destdir}" verbose="true" />

		<!-- javadoc -->
		<javadoc destdir="${destdir}" windowtitle="${windowtitle}" locale="${locale}" encoding="${encoding}" docencoding="${docencoding}" charset="${charset}"
			access="${access}" version="${version}" author="${author}" use="${use}" nodeprecated="${nodeprecated}" nodeprecatedlist="${nodeprecatedlist}" noindex="${noindex}"
			nonavbar="${nonavbar}" notree="${notree}" splitindex="${splitindex}" source="${source}" overview="${overview}" verbose="${verbose}" stylesheetfile="${stylesheetfile}"
			additionalparam="${additionalparam}" classpathref="feilong.maven.dependencies.all">
			<!-- Include title for the package index(first) page (html-code) -->
			<doctitle>feilong-core 1.0 API create by 飞天奔月</doctitle>

			<!-- 下面三个参数,指定header footer bottom 不解释 -->
			<header>feilong-core 1.0 API</header>
			<footer>feilong-core 1.0 API</footer>
			<bottom>
				<![CDATA[Copyright &copy; 2009-2012 by feilong]]>
			</bottom>

			<fileset dir="src/main/java" defaultexcludes="yes">
				<!--这里可以定制 你先哪些包生成 那些包不生成javadoc -->
				<include name="com/feilong/commons/core/**" />
			</fileset>
		</javadoc>

		<!-- javadoc 生成完成后,打开目标目录 -->
		<property name="_explorerPath" location="${destdir}" />
		<antcall target="Z_feilongExecExplorer" inheritall="true" />
	</target>
</project>

 

 

 

下面要研究的是 怎么用ant 生成javadoc 之后 ,直接调用相关api 生成chm 格式的文档 

 

 

 

勘误:

maven 也支持个性化输出的

配置 Maven Javadoc Plugin