My lazy header ...

AntDocGUI
Target antdoc.example

antdoc.example

Demonstrates how to use AntDoc: generates HTML documentation for this buildfile.
Note that HTML elements may be used, provided entity references are used. However, you had better use the XML comment on that purpose.

This target is a very basic example on how to use the AntDoc Ant task. You may copy and paste this example in order to have something to start with. antdoc.example.template is more advanced and may be used as well, if you are already accustomed to AntDoc. AntDoc is very simple, so that the customization does not take too much time!

Detail:
<target
	description="Demonstrates how to use AntDoc: generates HTML documentation for this buildfile.<br/>   <em>Note that HTML elements may be used, provided entity references are used. However, you had better use the XML comment   on that purpose.</em>"
	name="antdoc.example"
>
	<property
		name="ANTDOC_DESTINATION"
		value="antdoc"
	/>

	<echo>AntDoc documentation will be generated in the '${ANTDOC_DESTINATION}' directory</echo>

	<echo>This directory contains the index.html file that should be opened in order to view the documentation</echo>

	<taskdef
		classname="org.ed.pack.ant.AntDoc"
		name="AntDoc"
	/>

	<AntDoc
		destination="${ANTDOC_DESTINATION}"
		runtime="yes"
	>
		<title>The title of your Ant build files</title>

		<header>You may put some header here ...</header>

		<footer>... and even more some footer here</footer>

		<fileset dir=".">
			<include name="AntDocGUI_build.xml"/>
		</fileset>
	</AntDoc>
</target>

... is just like my footer!

Edouard Mercier 2003.12.08 20:31:08 - AntDoc V0.8h - XSL Transformer Factory: com.icl.saxon.TransformerFactoryImpl