| You may put some header here ... | ||||
INDEX: SUMMARY | PROPERTY | DETAIL |
antdocgui.run
This is an overall comment concerning the current Ant buildfile.
This Ant buildfile offers the opportunity to launch AntDocGUI in a console (through Ant, actually).
It is a good practice to tell the end-user what are the main public targets of the Ant buildfiles, so that a newbie can cope with it.
antdoc.example
target.antdocgui.idea.plugin.deploy
target.
This Ant buildfile handles AntDoc and AntDocGUI. Note than you can put special HTML tags in that description, provided you use entity references. However, prefer the XML comments to place HTML tags.
Target Summary | |||
Depends (the depends attribute) | Runtime (the target executed at runtime) | Run (via AntDocGUI) | Description |
---|---|---|---|
| antdoc.example | ![]() | antdoc.example
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!
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. |
| antdoc.example.template | ![]() | antdoc.example.template
This target is full-featured template on how to use the AntDoc Ant task. You may copy and paste this template in order to discover most of the AntDoc options. However, the AntDoc options used here are not exhaustive. See the AntDoc manual for a complete explanation. A template that should be used as a reference for beginners |
| antdocgui.idea.plugin.deploy | ![]() | antdocgui.idea.plugin.deploy
This target is necessary in order to deploy AntDocGUI in IDEA. Once you've run this target, restart IDEA if necessary and you will get AntDocGUI integrated to the wondeful IDEA! Deploys the IDEA plugin for AntDocGUI. Edit this file or overload IDEA_HOME_PATH in order to deploy the plugin |
| antdocgui.run | ![]() | antdocgui.run
This target enables to run AntDocGUI, but with a console window that enables to trace the possible log of AntDocGUI. If you kill the console window, you will kill AntDocGUI as well. If you want to execute AntDocGUI with no console, just type "AntDocGUI"! Runs the AntDocGUI in a console mode |
| target_with_no_description | ![]() | target_with_no_description
This target is only aimed at showing that the non-documented targets are displayed in a smaller font size. |
Top Property |
Target Detail |
![]() |
antdoc.example |
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!
<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> |
![]() |
antdoc.example.template |
<target description="A template that should be used as a reference for beginners" name="antdoc.example.template" > <property name="ANTDOC_DESTINATION" value="../../antdoc" /> <mkdir dir="${ANTDOC_DESTINATION}"/> <get dest="${ANTDOC_DESTINATION}/welcome.html" src="http://jakarta.apache.org" /> <get dest="${ANTDOC_DESTINATION}/AntDoc_forAntDoc.html" src="http://mapage.noos.fr/antdoc/example/AntDoc_forAntDoc.css" /> <tstamp> <format pattern="yyyy.MM.dd HH:mm:ss" property="TIME_STAMP" /> </tstamp> <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> <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> <echo>...</echo> <taskdef classname="org.ed.pack.ant.AntDoc" name="AntDoc" /> <AntDoc css="${ANTDOC_DESTINATION}/AntDoc_forAntDoc.html" destination="${ANTDOC_DESTINATION}" hide="true" processor="org.apache.xalan.processor.TransformerFactoryImpl" runtime="yes" welcome="${ANTDOC_DESTINATION}/welcome.html" > <title>The title of the documentation of your Ant build files<br/>Generation timestamp: ${TIME_STAMP}</title> <header>You may put some <b>header</b> here ...</header> <footer>... and even more some <font size="+2">footer</font> here</footer> <fileset dir="."> <include name="AntDocGUI_build.xml"/> </fileset> <fileset dir="../.."> <include name="build.xml"/> </fileset> </AntDoc> </target> |
![]() |
antdocgui.idea.plugin.deploy |
<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> |
![]() |
antdocgui.run |
This target enables to run AntDocGUI, but with a console window that enables to trace the possible log of AntDocGUI. If you kill the console window, you will kill AntDocGUI as well.
If you want to execute AntDocGUI with no console, just type "AntDocGUI"!
![]() |
target_with_no_description |
<target name="target_with_no_description"> <echo>Just a dummy target, in order to show that the target may not be documented, under certain circumstances.</echo> </target> |
| ... and even more some footer here | ||||
INDEX: SUMMARY | PROPERTY | DETAIL |