You may put some header here ...

Ant project AntDocGUI

Initial base directory:
Default target:
antdocgui.run

This Ant buildfile handles AntDoc and AntDocGUI. It offers the opportunity to launch AntDocGUI in a console (through Ant, actually). You may generate a first HTML documentation with the antdoc.example target. You may deploy AntDocGUI into IDEA via the antdocgui.idea.plugin.deploy target.



Target Summary
  Press that icon in order to update AntDoc GUI antdoc.example
Demonstrates how to use AntDoc: generates HTML documentation for this buildfile
  Press that icon in order to update AntDoc GUI antdoc.example.template
A template that should be used as a reference for beginners
  Press that icon in order to update AntDoc GUI antdocgui.idea.plugin.deploy
Deploys the IDEA plugin for AntDocGUI. Edit this file or overload IDEA_HOME_PATH in order to deploy the plugin
  Press that icon in order to update AntDoc GUI antdocgui.run
Runs the AntDocGUI in a console mode
 
Top Property
 
Target Detail
Press that icon in order to update AntDoc GUI

antdoc.example

Demonstrates how to use AntDoc: generates HTML documentation for this buildfile
Detail:
<target
	description="Demonstrates how to use AntDoc: generates HTML documentation for this buildfile"
	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 biew 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>

Press that icon in order to update AntDoc GUI

antdoc.example.template

A template that should be used as a reference for beginners
Detail:
<target
	description="A template that should be used as a reference for beginners"
	name="antdoc.example.template"
>
	<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 biew the documentation</echo>

	<echo>The "destination" is where the generated files are yielded</echo>

	<echo>The "runtime" tells to generate the applet that will enable to connect to AntDocGUI and execute targets directly from the
                              HTML</echo>

	<echo>The "hide" tells AntDoc not to generate documentation for a target with no explicit description (target "description" attribute
                              missing or empty)</echo>

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

	<AntDoc
		destination="${ANTDOC_DESTINATION}"
		hide="true"
		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>

Press that icon in order to update AntDoc GUI

antdocgui.idea.plugin.deploy

Deploys the IDEA plugin for AntDocGUI. Edit this file or overload IDEA_HOME_PATH in order to deploy the plugin
Detail:
<target
	description="Deploys the IDEA plugin for AntDocGUI. Edit this file or overload IDEA_HOME_PATH in order to deploy the plugin"
	name="antdocgui.idea.plugin.deploy"
>
	<property
		location="F:\win32app\Programming\IDEA642"
		name="IDEA_HOME_PATH"
	/>

	<property
		location="${IDEA_HOME_PATH}/plugins"
		name="IDEA_PLUGIN_PATH"
	/>

	<property
		location="${IDEA_PLUGIN_PATH}/antdoc.tmp"
		name="TEMPORARY_IDEA_DIST_DIRECTORY_PATH"
	/>

	<property
		location="${IDEA_PLUGIN_PATH}/AntDocIDEA.jar"
		name="ANTDOC_IDEAPLUGIN_JAR"
	/>

	<mkdir dir="${TEMPORARY_IDEA_DIST_DIRECTORY_PATH}"/>

	<unjar
		dest="${TEMPORARY_IDEA_DIST_DIRECTORY_PATH}"
		src="${ant.home}/lib/saxon.jar"
	/>

	<unjar
		dest="${TEMPORARY_IDEA_DIST_DIRECTORY_PATH}"
		src="${ant.home}/lib/AntDoc.jar"
	/>

	<delete file="${TEMPORARY_IDEA_DIST_DIRECTORY_PATH}/META-INF/AntDoc.dsa"/>

	<delete file="${TEMPORARY_IDEA_DIST_DIRECTORY_PATH}/META-INF/AntDoc.sf"/>

	<delete file="${ANTDOC_IDEAPLUGIN_JAR}"/>

	<jar jarfile="${ANTDOC_IDEAPLUGIN_JAR}">
		<fileset dir="${TEMPORARY_IDEA_DIST_DIRECTORY_PATH}">
			<include name="**/*"/>
		</fileset>
	</jar>

	<delete dir="${TEMPORARY_IDEA_DIST_DIRECTORY_PATH}"/>
</target>

Press that icon in order to update AntDoc GUI

antdocgui.run

Runs the AntDocGUI in a console mode
Detail:
<target
	description="Runs the AntDocGUI in a console mode"
	name="antdocgui.run"
>
	<echo>If you want to execute AntDocGUI with no console, just type "AntDocGUI"!</echo>

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

	<AntDoc
		gui="yes"
		port="111"
	/>
</target>

... and even more some footer here

Edouard Mercier 2002.11.06 19:44:05 - AntDoc V0.7g