tag:blogger.com,1999:blog-21939269176330234542024-03-13T14:53:36.804-04:00Ant Task for DoxygenOpen Source Programmerhttp://www.blogger.com/profile/06081166832182857672noreply@blogger.comBlogger8125tag:blogger.com,1999:blog-2193926917633023454.post-62828204762291452722008-03-23T18:52:00.003-04:002008-12-31T11:29:14.927-05:00OverviewThis package contains the Ant task to use <a href="http://www.doxygen.org/">doxygen</a>, a document generation utility software.<br /><br /><i>Ant</i> was initially designed to be a build maintenance utility - but now it has a whole lot of projects that extend its features beyond its original intentions. To know more about the same - visit <a href="http://ant.apache.org/">Ant Apache</a> home page.<br /><br /><i>Doxygen</i> is a document generation utility that is used to generate a variety of documents (html/pdf/hlp/dot - among others) from the given set of source files, by parsing the structures and comments in the same.To know more about the same - visit <a href="http://www.stack.nl/%7Edimitri/doxygen/">Doxygen</a> home page.<br /><br />This project released under Apache License, contains the jar task that helps an Ant build maintainer to integrate doxygen tasks with the same. The ideal target audience of the same would be build maintainers and release engineers of the projects who can integrate this Ant Task with the rest of the release system to generate a set of documentation from the latest version of the source tree.<br /><ul><li> The usage manual is available <a href="http://ant-doxygen.blogspot.com/2008/03/usage.html">here</a>.</li><li> For more examples refer to this <a href="http://ant-doxygen.blogspot.com/2008/03/usage.html#examples">page</a>. </li><br /></ul><br /><br /><br /><h3>Update:</h3><br /><br /><b>Dec 30 2008:</b> Ant 1.6.1 released. See the Download page for options.Unknownnoreply@blogger.comtag:blogger.com,1999:blog-2193926917633023454.post-58530232136382084622008-03-23T17:30:00.007-04:002009-01-21T11:25:16.274-05:00Download<div xmlns="http://www.w3.org/1999/xhtml">The latest binary release is 1.6.1 .<br /><br />Download the latest binaries from the sourceforge project page, as below.<br /><h4>Prerequisites:</h4><ul><li>Java 5</li><li> Ant 1.7 for taglib support <i>(Optional)</i><br /></li> </ul><h4>Binaries:</h4> <ul><li><a href="http://sourceforge.net/project/showfiles.php?group_id=62308&package_id=58852">Binaries</a><br /></li></ul><h4>Sources:</h4> <ul><li><a href="http://sourceforge.net/project/showfiles.php?group_id=62308&package_id=107494">Download Sources </a></li><li><a href="http://ant-doxygen.svn.sourceforge.net/viewvc/ant-doxygen/trunk/ant_task/">Browse SVN</a></li><li>Check out the latest tree as -<br /><code>svn co https://ant-doxygen.svn.sourceforge.net/svnroot/ant-doxygen/trunk/ant_task/ ant-doxygen </code></li></ul><span style="font-weight: bold;">Patches:</span><br /><br />To submit the patches - please follow the instructions at the <a href="http://ant-doxygen.blogspot.com/2007/01/patches.html">Patches</a> page.<br /><br /></div>Unknownnoreply@blogger.comtag:blogger.com,1999:blog-2193926917633023454.post-84402174248405216352008-03-23T17:30:00.003-04:002008-12-21T17:08:16.871-05:00Changelog<div xmlns='http://www.w3.org/1999/xhtml'><b>1.6 (Dec 2008):<br/></b> * antlib.xml added to the package. <br/> * Build system modified to use ivy ( to manage compile-time dependencies better). <br/><br/><b>1.5( 2008)<br/></b><br/> * Code refactored to use Java Generics internally for better maintenance.<br/><br/><b>1.4( 2004)<br/></b><br/> * Attributes 'versionCompatible' , 'configFile', 'doxygenPath' added to the task.<br/><br/> <br/><i>Features:</i><br/> * 887510 DoxygenTask.java: Attribute 'versionCompatible' added<br/> * 885849 DoxygenTask.java: Integrate/Remove of task-element support.<br/> * 883163 DoxygenTask.java: Ant/Java flavor defaults for Doxygen<br/> * 702402 DoxygenTask.java: Support for multiple INPUTs.<br/> * 883174 DoxygenTask.java: Support nested attribute specifications.<br/> * 883150 DoxygenTask.java: configFile attribute added<br/> * 881633 DoxygenTask.java: doxygenPath attribute added <br/><br/><i>Bugs Fixed:</i><br/> * 793056 FILE_PATTERNS<br/> * 739884 Support for Doxygen 1.3<br/> * 772527 Doxygen 1.3.2 Ant task support<br/> * 875319 plugin do not support the current doxygen version <br/><br/><br/><b>1.3(Jan 21 2004):</b><br/> The Task is now made independent of the doxygen version installation.<br/> <property> child nodes are added to the task structure.<br/> *Warning: Tasks written for version 1.2 may break and may need to be rewritten**<br/><br/><br/><b>1.2(Sep 18 2002):</b><br/> Supports Doxygen version 1.2.18<br/><br/><b>1.1(Sep 12 2002):</b><br/> Attribute ignoreVersion added so as to ignore the version check between the doxygen<br/> version for which the task is written and the doxygen version installed on the system.<br/><br/><b>1.0(Sep 11 2002):</b><br/>Initial Revision.<br/></div>Unknownnoreply@blogger.comtag:blogger.com,1999:blog-2193926917633023454.post-7555219676845240032008-03-23T17:29:00.001-04:002008-03-23T17:29:44.155-04:00LicenseThe project is released under Apache License. To know more details about the same - please visit <a href="http://commons.apache.org/license.html">license summary on the apache web site</a>.Unknownnoreply@blogger.comtag:blogger.com,1999:blog-2193926917633023454.post-36811118426467740062008-03-22T18:54:00.013-04:002009-07-14T11:40:14.744-04:00Usage<h3 class="anth3">Description</h3>Generates documentation for source files, using the document generation utility <a href="http://www.doxygen.org/">doxygen</a><br /><br /><h3 class="anth3">Dependency</h3><br />The 'doxygen' binary need to be pre-installed on the system. If it is not in the PATH environment variable of your operating system, please see the attribute 'doxygenPath' as to how to use the same to invoke doxygen.<br /><br /><h3 class="anth3">Parameters</h3><br /><table border="1" cellpadding="2" cellspacing="0"><tbody><tr><td style="font-weight: bold;">Attribute</td><td style="font-weight: bold;">Description</td><td style="font-weight: bold;">Required</td></tr><tr><td>versionCompatible</td><td>This is the version of doxygen for which the task is compatible. If set and the version of the doxygen installed on the system does not match with this version, the build would break </td><td style="text-align: center;">No</td></tr><tr><td>doxygenPath</td><td>This is the full path to the doxygen executable that is to be used for executing this doxygen task. By default, the task expects the doxygen binary in the path.</td><td style="text-align: center;">No</td></tr><tr><td>configFilename </td><td>If set, then the doxygen task would load the configuration properties from this file. </td><td style="text-align: center;">No</td></tr></tbody></table><br /><br /><p><br /></p><h3 class="anth3">Parameters specified as nested elements</h3><h4 class="anth4">property</h4><h4 style="font-weight: normal;">doxygen task can have more than one 'property' nested elements as follows.</h4><br /><br /><table border="1" cellpadding="2" cellspacing="0"><tbody><tr><td style="font-weight: bold;">Attribute</td><td style="font-weight: bold;">Description</td><td style="font-weight: bold;">Required</td></tr><tr><td>name</td><td>The name of the property in the Doxygen configuration file.</td> <td style="text-align: center;">Yes.</td></tr><tr><td>value</td><td>The value of the property whose name is specified as 'name' attribute in the Doxygen configuration file.</td><td style="text-align: center;">Yes.</td></tr></tbody></table><br /><br /><br /><h3 class="anth3">Defining Doxygen Task</h3><br />The doxygen task could be defined in 2 ways as follows.<br /><br />1.6.0+ ( Preferred):<br /><br />* Copy ant-doxygen.jar from the binary distribution to $ANT_HOME/lib .<br />* Define a new URI for doxygen as follows, at the antlib library location, antlib:org.doxygen.tools , as follows.<br /><pre class="brush:xml"><br /><project name="my-project" xmlns:doxygen="antlib:org.doxygen.tools" ><br /><br /><br /><doxygen:doxygen /><br /><br /></project><br /><br /></pre>* Note the revised task invocation (with additional uri prefix for doxygen:) above.<br /><span style="font-style: italic;"><br />Legacy Task Definition (Deprecated):</span><br /><br /><pre class="brush:xml"><taskdef name="doxygen" classname="org.doxygen.tools.DoxygenTask"<br />classpath="<path_to_ant_doxygen.jar_file>" /><br /></pre>Note: The legacy task definition would be soon deprecated and the users are suggested to switch to the modern task definition at their earliest convenience.<br /><br /><br /><h3 class="anth3"><br /></h3><br /><a name="examples"></a><br /><h3>Examples</h3><ol><li>To generate documentation by default in current directory, basic option.</li><br /><pre class="brush:xml"><br /><doxygen:doxygen><br /><property name="INPUT" value="${inputdir}" /><br /></doxygen:doxygen><br /></pre><br /><li>To generate html documentation recursively for a given directory and suppress latex documentation.</li><br /><pre class="brush:xml"><doxygen:doxygen><br /><br /><property name="INPUT" value="${inputdir}" /><br /><property name="RECURSIVE" value="yes" /><br /><property name="GENERATE_LATEX" value="false" /><br /><property name="PROJECT_NAME" value="Ant-Doxygen" /><br /></doxygen:doxygen ><br /></pre><br /><br /><li>To launch doxygen that is not installed on the path.</li><pre class="brush:xml"><doxygen:doxygen doxygenPath="/usr/local/doxygen-1.2.5/doxygen" ><br /><property name="INPUT" value="${inputdir}" /><br /><property name="PROJECT_NAME" value="Ant-Doxygen" /><br /></doxygen:doxygen><br /></pre><br /><br /><li>To launch doxygen that should be run only with doxygen version 1.2.17.</li><pre class="brush:xml"><br /><doxygen:doxygen versionCompatible="1.2.17" ><br /><property name="INPUT" value="${inputdir}" /><br /><property name="PROJECT_NAME" value="Ant-Doxygen" /><br /></doxygen:doxygen ><br /></pre><br /><br /><li>To launch doxygen that should be run with doxygen versions 1.2.17 and above.</li><pre class="brush:xml"><br /><doxygen:doxygen versionCompatible="1.2.17+" ><br /><property name="INPUT" value="${inputdir}" /><br /><property name="PROJECT_NAME" value="Ant-Doxygen" /><br /></doxygen:doxygen><br /></pre><br /><br /><li>To load the doxygen configuration properties from a given file.</li></ol><pre class="brush:xml"><br /><doxygen:doxygen configFilename="/home/myhome/doxygen.cfg" /><br /></pre>Unknownnoreply@blogger.comtag:blogger.com,1999:blog-2193926917633023454.post-10365098848268869762008-03-21T17:45:00.000-04:002008-03-23T17:46:03.867-04:00ProjectsUnknownnoreply@blogger.comtag:blogger.com,1999:blog-2193926917633023454.post-12359972069386122602007-01-21T11:12:00.003-05:002009-01-21T11:15:07.547-05:00Feedback<ul><br /><li>Bugs could be submitted <a href="http://sourceforge.net/tracker/?group_id=62308&atid=500141">here</a><br /></li><br /><li>Feature Requests could be submitted <a href="http://sourceforge.net/tracker/?group_id=62308&atid=500144">here</a><br /></li><br /><li>Patches could be submitted <a href="http://sourceforge.net/tracker2/?group_id=62308&atid=500143">here</a> . <br /></li><br /></ul>Open Source Programmerhttp://www.blogger.com/profile/06081166832182857672noreply@blogger.comtag:blogger.com,1999:blog-2193926917633023454.post-35470972815753606862007-01-21T11:07:00.003-05:002009-01-21T11:12:18.918-05:00PatchesTo submit patches - follow these guidelines.<br /><br /><ul><br /><li> Check out the latest tree from subversion here at -<br /><code><br />svn co https://ant-doxygen.svn.sourceforge.net/svnroot/ant-doxygen/trunk/ant_task/ ant-doxygen <br /></code><br /></li><br /><li>Make your necessary changes as per Sun Java Formatting conventions. </li><br /><li> Create a patch as follows -<br /><code><br />$ svn diff > myfix.patch<br /></code><br /></li><br /><li> Submit the patch here at - <a href="http://sourceforge.net/tracker2/?group_id=62308&atid=500143">Ant Task for Doxygen Patches </a><br /></li><br /></ul>Open Source Programmerhttp://www.blogger.com/profile/06081166832182857672noreply@blogger.com