net.sf.fikin.ant
Class AntTasksDocHtmlDocletTask

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

Direct Known Subclasses:

AntTasksDocTextDocletTask, DocletAntlibTask, DocletAntPropertiesTask

public class AntTasksDocHtmlDocletTask
extends VelocityDocletTask

Generate single-page HTML documentation 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
• Each mandatory setter method must have @antTaskParamRequired tag in the method's comment

All setter methods are resolved automatically based on Ant specification for methods introspection

This task is based on VelocityDocletTask. The Velocity file ant-doc.html.vm used as HTML-page template is located in this package folder and loaded via the classloader.

Example:

      /**
       * This is example class
       * @antTaskName exampleTask
       * /
      public class Example extends Task {
          /**
           * setter method
           * @antTaskParamRequired true
           * /
          public void setName(String name) { ... }
          ...
      }
 

created on Sep 24, 2006

Since:

Version:

$Revision: 1.3 $

Author:

fiykov

Ant Task Name:

antTasksDocHtmlDoclet

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

AntTasksDocHtmlDocletTask()

Method Summary

protected java.lang.String	getPackageName() get the current's class package name
protected java.lang.String	getTemplateName() get the template name
void	init() set the template name
void	setTemplate(java.lang.String templateName) Deprecated.

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

AntTasksDocHtmlDocletTask

public AntTasksDocHtmlDocletTask()

Method Detail

setTemplate

public void setTemplate(java.lang.String templateName)

Deprecated.

this is deprecated parameter, attemp to set it would result in build exception

Overrides:

setTemplate in class VelocityDocletTask

Parameters:

templateName -

init

public void init()
          throws org.apache.tools.ant.BuildException

set the template name

Overrides:

init in class VelocityDocletTask

Throws:

org.apache.tools.ant.BuildException

getTemplateName

protected java.lang.String getTemplateName()

get the template name

Returns:

template name

getPackageName

protected java.lang.String getPackageName()

get the current's class package name

Returns:

current's class package name