net.sf.fikin.ant
Class DocletAntPropertiesTask

java.lang.Object
  org.apache.tools.ant.ProjectComponent
      org.apache.tools.ant.Task
          net.sf.fikin.ant.DocletTask
              net.sf.fikin.ant.VelocityDocletTask
                  net.sf.fikin.ant.AntTasksDocHtmlDocletTask
                      net.sf.fikin.ant.DocletAntPropertiesTask

public class DocletAntPropertiesTask
extends AntTasksDocHtmlDocletTask

Generate ant.properties file for all Ant Tasks found in the source

Recognized classes/tasks must qialify the following criteria:

• They are public classes
• Not abstract classes
• Descendant (direct or indirect) of Ant's Task class org.apache.tools.ant.Task
• Having @antTaskName tag in their class comment, denoting the task name in Ant

Example:

      /**
       * This is example class
       * @antTaskName exampleTask
       * /
      public class Example extends Task {
          ...
      }
 

would result in:

      ...
      exampleTask=Example
      ...
 

created on Sep 24, 2006

Since:

Version:

$Revision: 1.4 $

Author:

fiykov

Ant Task Name:

antTasksPropertiesDoclet

Field Summary

Fields inherited from class org.apache.tools.ant.Task

description, location, target, taskName, taskType, wrapper

Fields inherited from class org.apache.tools.ant.ProjectComponent

project

Constructor Summary

DocletAntPropertiesTask()


Method Summary

protected java.lang.String

getTemplateName() get the template name

Methods inherited from class net.sf.fikin.ant.AntTasksDocHtmlDocletTask

getPackageName, init, setTemplate

Methods inherited from class net.sf.fikin.ant.VelocityDocletTask

check, setFile, setName, setVelocityLog

Methods inherited from class net.sf.fikin.ant.DocletTask

addFileset, addPackage, addPackageset, addParam, createBootclasspath, createClasspath, createParam, createSourcepath, execute, init_javadoc, setBootclasspath, setBootClasspathRef, setClasspath, setClasspathRef, setExcludePackageNames, setExecutable, setFailonerror, setLinksource, setPackageList, setPackagenames, setSource, setSourcepath, setSourcepathRef, setVerbose

Methods inherited from class org.apache.tools.ant.Task

getDescription, getLocation, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, isInvalid, log, log, maybeConfigure, perform, reconfigure, setDescription, setLocation, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

Methods inherited from class org.apache.tools.ant.ProjectComponent

getProject, setProject

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DocletAntPropertiesTask

public DocletAntPropertiesTask()

Method Detail

getTemplateName

protected java.lang.String getTemplateName()

get the template name

Overrides:

getTemplateName in class AntTasksDocHtmlDocletTask

Returns:

template name