TOP

ant.doc

Description

Generate documentation of all tasks/types/macros in modelant, integrated with its javadoc documentation. 
     Usage:
     <ant.doc output.dir="${root.doc}/antlibdoc" javadoc.dir="../api" java.model="${out}/reverse.java.xmi" work.dir="${work}">
       <fileset dir="util/src/xml">
         <include name="**/antlib.xml" />
       </fileset>

       <fileset dir="mdr/src/xml">
         <include name="**/antlib.xml" />
       </fileset>
     </ant.doc>
See reverse.ant

Parameters

Attribute Description
output.dir the name of the directory where to generate the documentation
javadoc.dir the optional name of the directory, relative to output.dir, where javadoc documentation will be/is generated
java.model the optional name of the file with the reverse engineered java implementations of the tasks to document
work.dir the name of the work directory where to keep the repository files
header Optional text resource in classpath, containing an HTML fragment to include as a header of the pages shown in the main frame of the documentation
footer Optional text resource in classpath, containing an HTML fragment to include as a footer of the pages shown in the main frame of the documentation
classpath Optional classpath where to load header/footer from

Nested elements

Element Description
nested This is an implicit optional element holding fileset(s) that describe the antlib.xml files to reverse engineer

Use <typedef resource="net/mdatools/modelant/uml13/reverse/antlib.xml"/>
Documentation generated by ant.doc Ant macro from ModelAnt by MDA Tools