Home Usage Download Change History Support |
doxygenDescriptionGenerates documentation for source files, using the document generation utility doxygen. DependencyThe '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. Parameters
Parameters specified as nested elementsproperty
doxygen task can have more than one 'property' nested elements as follows.
Defining Doxygen TaskThe doxygen task could be defined as follows. <taskdef name="doxygen" classname="org.doxygen.tools.DoxygenTask" classpath="<path_to_ant_doxygen.jar_file>" /> Examples1. To generate documentation by default in current directory, basic option. <doxygen> <property name="INPUT" value="${inputdir}" /> </doxygen> 2. To generate html documentation recursively for a given directory and suppress latex documentation. <doxygen> <property name="INPUT" value="${inputdir}" /> <property name="RECURSIVE" value="yes" /> <property name="GENERATE_LATEX" value="false" /> <property name="PROJECT_NAME" value="Ant-Doxygen" /> </doxygen> 3. To launch doxygen that is not installed on the path. <doxygen doxygenPath="/usr/local/doxygen-1.2.5/doxygen" > <property name="INPUT" value="${inputdir}" /> <property name="PROJECT_NAME" value="Ant-Doxygen" /> </doxygen> 4. To launch doxygen that should be run only with doxygen version 1.2.17. <doxygen versionCompatible="1.2.17" > <property name="INPUT" value="${inputdir}" /> <property name="PROJECT_NAME" value="Ant-Doxygen" /> </doxygen> 4. To launch doxygen that should be run with doxygen versions 1.2.17 and above. <doxygen versionCompatible="1.2.17+" > <property name="INPUT" value="${inputdir}" /> <property name="PROJECT_NAME" value="Ant-Doxygen" /> </doxygen> 5. To load the doxygen configuration properties from a given file. <doxygen configFilename="/home/myhome/doxygen.cfg" /> |