Overview   Project   Target   Usage   About 
My lazy header ...
INDEX: SUMMARY | PROPERTY | DETAIL

Ant project AntDocGUI (file: AntDocGUI_build.xml)

Initial base directory:
Default target:
antdocgui.run

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.

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.

Target Summary
Depends
(the depends attribute)		 Runtime
(the target executed at runtime)		 Description 
antdoc.example
 antdoc.example antdoc.example

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.

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! 
antdoc.example.template
 antdoc.example.template antdoc.example.template

A template that should be used as a reference for beginners

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. 
antdocgui.idea.plugin.deploy
 antdocgui.idea.plugin.deploy antdocgui.idea.plugin.deploy

Deploys the IDEA plugin for AntDocGUI. Edit this file or overload IDEA_HOME_PATH in order to deploy the plugin

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 wonderful IDEA! 
antdocgui.run
 antdocgui.run antdocgui.run

Runs the AntDocGUI in a console mode

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_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
         

      

      

      

         
            

               
                  

                     
                        

                            Overview 
                           
                            Project 
                           
                            Target 
                           
                            Usage 
                           
                            About 
                           
                        

                     
                  

               		
               ... is just like my footer!

            

            

               INDEX: SUMMARY | PROPERTY | DETAIL
            

         
      

      

      
Edouard Mercier 2003.12.08 20:31:08 - AntDoc V0.8h - XSL Transformer Factory: com.icl.saxon.TransformerFactoryImpl