Package gosu.tools.ant

Class Gosudoc

java.lang.Object
org.apache.tools.ant.ProjectComponent
org.apache.tools.ant.Task
gosu.tools.ant.Gosudoc
All Implemented Interfaces:
Cloneable
public class Gosudoc extends org.apache.tools.ant.Task
Access to the GosuDoc tool from Ant.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private org.apache.tools.ant.types.Path
    _inputDirs
     
    private File
    _outputDir
     
    private org.apache.tools.ant.types.Path
    _runtimeClasspath
     
    private String
    _title
     
    private boolean
    _verbose
     
    private final AntLoggingHelper
    log
     

    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
    Gosudoc()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    org.apache.tools.ant.types.Path
    createClasspath()
    Adds a path to the classpath.
    void
    execute()
     
    void
    setClasspathRef(org.apache.tools.ant.types.Reference ref)
    Adds a reference to a classpath defined elsewhere.
    void
    setInputDirs(org.apache.tools.ant.types.Path inputDirs)
    Specify where to find source file
    void
    setOutputDir(File dir)
    Set the directory where the GosuDoc output will be generated.
    void
    setVerbose(boolean verbose)
     

    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, setProject

    Methods inherited from class java.lang.Object

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

  • Field Details

    • log

      private final AntLoggingHelper log

    • _inputDirs

      private org.apache.tools.ant.types.Path _inputDirs

    • _outputDir

      private File _outputDir

    • _verbose

      private boolean _verbose

    • _runtimeClasspath

      private org.apache.tools.ant.types.Path _runtimeClasspath

    • _title

      private String _title

  • Constructor Details

    • Gosudoc

      public Gosudoc()

  • Method Details

    • setInputDirs

      public void setInputDirs(org.apache.tools.ant.types.Path inputDirs)
      Specify where to find source file
      Parameters:
      inputDirs - a Path instance containing the various source directories.

    • setOutputDir

      public void setOutputDir(File dir)
      Set the directory where the GosuDoc output will be generated.
      Parameters:
      dir - the output directory.

    • setVerbose

      public void setVerbose(boolean verbose)

    • createClasspath

      public org.apache.tools.ant.types.Path createClasspath()
      Adds a path to the classpath.
      Returns:
      a classpath to be configured

    • setClasspathRef

      public void setClasspathRef(org.apache.tools.ant.types.Reference ref)
      Adds a reference to a classpath defined elsewhere.
      Parameters:
      ref - a reference to a classpath

    • execute

      public void execute() throws org.apache.tools.ant.BuildException
      Overrides:
      execute in class org.apache.tools.ant.Task
      Throws:
      org.apache.tools.ant.BuildException