Ant：javadoc

Javadocを生成するコアタスク。
（org.apache.tools.ant.taskdefs.Javadoc extends Task）

属性

ボディー部に指定できるタグ

HTMLタグの使用

doctitleやheader等のボディー部には、HTMLタグを指定することが出来る。

ただし、直接HTMLタグを書くとxmlの一部だと認識され、エラーになる。
したがって、「<」は「<」、「>」は「>」に置き換えてやる必要がある。

	<header>&lt;i&gt;ヘッダー&lt;/i&gt;</header>

しかしそれは面倒なので、プロパティーファイルにHTMLタグを含めた文章を書き、それを使うという方法もある。
ただし日本語はそのままだと文字化けするので、native2asciiを使って変換しておく必要がある。これもbuild.xmlに組み込んでしまえばいいので、それほど大変ではない。

プロパティーファイル：

window-title=ウィンドウタイトル
doc-title=<i>文書タイトル</i>

build.xml：

	<native2ascii src="〜" dest="プロパティーファイルのあるディレクトリー"/>
	<property file="プロパティーファイル"/>
	<javadoc windowtitle="${window-title}" 〜>
		<doctitle>${doc-title}</doctitle>
	</javadoc>

例

複数のディレクトリーからJavadocを生成する例。
→生成されたJavadoc

build.xml：

<?xml version="1.0" encoding="Shift_JIS"?>
<project name="javadoc" default="javadoc" basedir=".">
	<target name="javadoc">
		<native2ascii src="." dest="." ext=".properties">
			<include name="docdata.txt" />
		</native2ascii>

		<property file="docdata.properties" />
		<property name="overview" location="../src/overview.html" />
		<property name="doc" location="../doc" />

		<delete dir="${doc}" />

		<javadoc destdir="${doc}"
			encoding="MS932"
			source="1.4"
			author="true"
			version="true"
			access="public"
			use="true"
			nonavbar="false"
			notree="true"
			nodeprecated="false"
			nodeprecatedlist="false"
			noindex="false"
			splitindex="true"
			nohelp="true"
			windowtitle="${window-title}"
			overview="${overview}"
			docencoding="MS932"
			charset="Shift_JIS"
		>
			<link href="http://java.sun.com/j2se/1.5.0/ja/docs/ja/api/" />
			<doctitle>${doc-title}</doctitle>

			<sourcepath path="../../eval/src" />
			<package name="jp.hishidama.eval.*" />
			<group title="${group-eval}" packages="jp.hishidama.eval*" />

			<sourcepath path="../../bitmap/src" />
			<package name="jp.hishidama.bitmap.*" />
			<group title="${group-bitmap}" packages="jp.hishidama.bitmap*" />
		</javadoc>
	</target>
</project>

docdata.txt：

window-title=ひしだまJavaライブラリー (Hishidama\'s Java library)
doc-title=ひしだまJavaライブラリー
group-eval  =四則演算（<a target="hishidama" href="http://www.ne.jp/asahi/hishidama/home/soft/java/eval.html">使用例</a>）
group-bitmap=ビットマップ（<a target="hishidama" href="http://www.ne.jp/asahi/hishidama/home/soft/java/bitmap.html">使用例</a>）

docdata.properties：

native2asciiによって docdata.txtから変換 して生成するようにしている。

特定ファイルを除外する例

sourcepathの代わりにfilesetを使うと、Javadoc生成対象のファイルを個別に指定できる。[2007-10-02]
（sourcepath等と混在できる）

build.xml：

		<javadoc destdir="${doc}" 〜>
〜
			<sourcepath path="../../bitmap/src" />
			<package name="jp.hishidama.bitmap.*" />
			<group title="${group-bitmap}" packages="jp.hishidama.bitmap*" />

			<fileset dir="../../hmwin32/src" defaultexcludes="yes">
				<exclude name="**/*.html" />
				<exclude name="**/*Const.java" />
			</fileset>
			<package name="jp.hishidama.win32.*" />
			<package name="jp.hishidama.robot.*" />
			<group title="${group-win32}" packages="jp.hishidama.win32*,jp.hishidama.robot*" />
		</javadoc>

ただし、例えば「class AAA implements BBB」としていてBBBを除外した場合、
Javadoc生成中に「シンボルを見つけられません」という警告が出て
生成されるAAAのJavadocからはBBBが完全に消える。（つまり「implements BBB」がJavadoc上に表示されない）