Package org.java.plugin.tools.ant

Class DocTask

  • All Implemented Interfaces:
    java.lang.Cloneable, org.apache.tools.ant.types.selectors.SelectorContainer
    public final class DocTask
extends BaseJpfTask
    The Ant task to generate documentation from plug-in manifest.
    Version:
    $Id$

    • Field Summary

      • Fields inherited from class org.apache.tools.ant.taskdefs.MatchingTask

        fileset

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

        target, taskName, taskType, wrapper

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

        description, location, project

    • Constructor Summary

      Constructors 
      Constructor Description
      DocTask()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void execute()  
      void setDestDir​(java.io.File aDestDir)  
      void setDocEncoding​(java.lang.String anEncoding)  
      void setEncoding​(java.lang.String anEncoding)  
      void setOverview​(java.io.File anOverviewFile)  
      void setStylesheetFile​(java.io.File aStylesheetFile)  
      void setTemplates​(java.lang.String aTemplatesPath)  

      • Methods inherited from class org.apache.tools.ant.taskdefs.MatchingTask

        add, addAnd, addContains, addContainsRegexp, addCustom, addDate, addDepend, addDepth, addDifferent, addFilename, addMajority, addModified, addNone, addNot, addOr, addPresent, addSelector, addSize, addType, appendSelector, createExclude, createExcludesFile, createInclude, createIncludesFile, createPatternSet, getDirectoryScanner, getImplicitFileSet, getSelectors, hasSelectors, selectorCount, selectorElements, setCaseSensitive, setDefaultexcludes, setExcludes, setExcludesfile, setFollowSymlinks, setIncludes, setIncludesfile, setProject, XsetIgnore, XsetItems

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

        bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

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

        clone, getDescription, getLocation, getProject, setDescription, setLocation

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • DocTask

        public DocTask()

    • Method Detail

      • setDestDir

        public void setDestDir​(java.io.File aDestDir)
        Parameters:
        aDestDir - base directory for generated documentation files

      • setOverview

        public void setOverview​(java.io.File anOverviewFile)
        Parameters:
        anOverviewFile - documentation overview HTML file

      • setEncoding

        public void setEncoding​(java.lang.String anEncoding)
        Parameters:
        anEncoding - source files encoding name (templates, overview etc.)

      • setDocEncoding

        public void setDocEncoding​(java.lang.String anEncoding)
        Parameters:
        anEncoding - output files encoding name

      • setStylesheetFile

        public void setStylesheetFile​(java.io.File aStylesheetFile)
        Parameters:
        aStylesheetFile - CSS style sheet to use

      • setTemplates

        public void setTemplates​(java.lang.String aTemplatesPath)
        Parameters:
        aTemplatesPath - path to template files (should be available in classpath)

      • execute

        public void execute()
        Overrides:
        execute in class org.apache.tools.ant.Task
        See Also:
        Task.execute()