scala.tools.ant

Scaladoc

class Scaladoc extends ScalaMatchingTask

An Ant task to document Scala code.

This task can take the following parameters as attributes:

It also takes the following parameters as nested elements:

Source
Scaladoc.scala
Linear Supertypes
ScalaMatchingTask, ScalaTask, MatchingTask, SelectorContainer, Task, ProjectComponent, Cloneable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. Scaladoc
  2. ScalaMatchingTask
  3. ScalaTask
  4. MatchingTask
  5. SelectorContainer
  6. Task
  7. ProjectComponent
  8. Cloneable
  9. AnyRef
  10. Any
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Scaladoc()

Type Members

  1. abstract class PermissibleValue extends AnyRef

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  6. object Flag extends PermissibleValue

    Defines valid values for the deprecation and unchecked properties.

  7. def XsetIgnore(arg0: String): Unit

    Definition Classes
    MatchingTask
  8. def XsetItems(arg0: String): Unit

    Definition Classes
    MatchingTask
  9. def add(arg0: FileSelector): Unit

    Definition Classes
    MatchingTask → SelectorContainer
  10. def addAnd(arg0: AndSelector): Unit

    Definition Classes
    MatchingTask → SelectorContainer
  11. def addContains(arg0: ContainsSelector): Unit

    Definition Classes
    MatchingTask → SelectorContainer
  12. def addContainsRegexp(arg0: ContainsRegexpSelector): Unit

    Definition Classes
    MatchingTask → SelectorContainer
  13. def addCustom(arg0: ExtendSelector): Unit

    Definition Classes
    MatchingTask → SelectorContainer
  14. def addDate(arg0: DateSelector): Unit

    Definition Classes
    MatchingTask → SelectorContainer
  15. def addDepend(arg0: DependSelector): Unit

    Definition Classes
    MatchingTask → SelectorContainer
  16. def addDepth(arg0: DepthSelector): Unit

    Definition Classes
    MatchingTask → SelectorContainer
  17. def addDifferent(arg0: DifferentSelector): Unit

    Definition Classes
    MatchingTask → SelectorContainer
  18. def addFilename(arg0: FilenameSelector): Unit

    Definition Classes
    MatchingTask → SelectorContainer
  19. def addMajority(arg0: MajoritySelector): Unit

    Definition Classes
    MatchingTask → SelectorContainer
  20. def addModified(arg0: ModifiedSelector): Unit

    Definition Classes
    MatchingTask → SelectorContainer
  21. def addNone(arg0: NoneSelector): Unit

    Definition Classes
    MatchingTask → SelectorContainer
  22. def addNot(arg0: NotSelector): Unit

    Definition Classes
    MatchingTask → SelectorContainer
  23. def addOr(arg0: OrSelector): Unit

    Definition Classes
    MatchingTask → SelectorContainer
  24. def addPresent(arg0: PresentSelector): Unit

    Definition Classes
    MatchingTask → SelectorContainer
  25. def addSelector(arg0: SelectSelector): Unit

    Definition Classes
    MatchingTask → SelectorContainer
  26. def addSize(arg0: SizeSelector): Unit

    Definition Classes
    MatchingTask → SelectorContainer
  27. def addType(arg0: TypeSelector): Unit

    Definition Classes
    MatchingTask → SelectorContainer
  28. def appendSelector(arg0: FileSelector): Unit

    Definition Classes
    MatchingTask → SelectorContainer
  29. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  30. final def bindToOwner(arg0: Task): Unit

    Definition Classes
    Task
  31. def buildError(message: String): Nothing

    Generates a build error.

    Generates a build error. Error location will be the current task in the ant file.

    message

    A message describing the error.

    Attributes
    protected
    Definition Classes
    ScalaTask
    Exceptions thrown
    BuildException

    A build error exception thrown in every case.

  32. def clone(): AnyRef

    Definition Classes
    ProjectComponent → AnyRef
    Annotations
    @throws()
  33. def createBootclasspath(): Path

    Sets the bootclasspath as a nested sourcepath Ant parameter.

    Sets the bootclasspath as a nested sourcepath Ant parameter.

    returns

    A source path to be configured.

  34. def createClasspath(): Path

    Sets the classpath as a nested classpath Ant parameter.

    Sets the classpath as a nested classpath Ant parameter.

    returns

    A class path to be configured.

  35. def createExclude(): NameEntry

    Definition Classes
    MatchingTask
  36. def createExcludesFile(): NameEntry

    Definition Classes
    MatchingTask
  37. def createExtdirs(): Path

    Sets the extdirs as a nested sourcepath Ant parameter.

    Sets the extdirs as a nested sourcepath Ant parameter.

    returns

    An extensions path to be configured.

  38. def createInclude(): NameEntry

    Definition Classes
    MatchingTask
  39. def createIncludesFile(): NameEntry

    Definition Classes
    MatchingTask
  40. def createPatternSet(): PatternSet

    Definition Classes
    MatchingTask
  41. def createSourcepath(): Path

    Sets the sourcepath as a nested sourcepath Ant parameter.

    Sets the sourcepath as a nested sourcepath Ant parameter.

    returns

    A source path to be configured.

  42. def createSrc(): Path

    Sets the origin as a nested src Ant parameter.

    Sets the origin as a nested src Ant parameter.

    returns

    An origin path to be configured.

  43. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  44. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  45. def execute(): Unit

    Performs the compilation.

    Performs the compilation.

    Definition Classes
    Scaladoc → Task
  46. def finalize(): Unit

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  47. final def getClass(): java.lang.Class[_]

    Definition Classes
    AnyRef → Any
  48. def getDescription(): String

    Definition Classes
    ProjectComponent
  49. def getDirectoryScanner(baseDir: File): DirectoryScanner

    This is forwarding method to circumvent bug #281 in Scala 2.

    This is forwarding method to circumvent bug #281 in Scala 2. Remove when bug has been corrected.

    Attributes
    protected
    Definition Classes
    Scaladoc → MatchingTask
  50. final def getImplicitFileSet(): FileSet

    Attributes
    protected[taskdefs]
    Definition Classes
    MatchingTask
  51. def getLocation(): Location

    Definition Classes
    ProjectComponent
  52. def getOwningTarget(): Target

    Definition Classes
    Task
  53. def getProject(): Project

    Definition Classes
    ProjectComponent
  54. def getRuntimeConfigurableWrapper(): RuntimeConfigurable

    Definition Classes
    Task
  55. def getSelectors(arg0: Project): Array[FileSelector]

    Definition Classes
    MatchingTask → SelectorContainer
  56. def getTaskName(): String

    Definition Classes
    Task
  57. def getTaskType(): String

    Definition Classes
    Task
  58. def getWrapper(): RuntimeConfigurable

    Attributes
    protected[ant]
    Definition Classes
    Task
  59. def handleErrorFlush(arg0: String): Unit

    Attributes
    protected[ant]
    Definition Classes
    Task
  60. def handleErrorOutput(arg0: String): Unit

    Attributes
    protected[ant]
    Definition Classes
    Task
  61. def handleFlush(arg0: String): Unit

    Attributes
    protected[ant]
    Definition Classes
    Task
  62. def handleInput(arg0: Array[Byte], arg1: Int, arg2: Int): Int

    Attributes
    protected[ant]
    Definition Classes
    Task
    Annotations
    @throws()
  63. def handleOutput(arg0: String): Unit

    Attributes
    protected[ant]
    Definition Classes
    Task
  64. def hasSelectors(): Boolean

    Definition Classes
    MatchingTask → SelectorContainer
  65. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  66. def init(): Unit

    Definition Classes
    Task
    Annotations
    @throws()
  67. def initialize: (Settings, List[File])

    Initializes settings and source files

    Initializes settings and source files

    Attributes
    protected
  68. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  69. final def isInvalid(): Boolean

    Attributes
    protected[ant]
    Definition Classes
    Task
  70. def log(arg0: String, arg1: Throwable, arg2: Int): Unit

    Definition Classes
    Task
  71. def log(arg0: Throwable, arg1: Int): Unit

    Definition Classes
    Task
  72. def log(arg0: String, arg1: Int): Unit

    Definition Classes
    Task → ProjectComponent
  73. def log(arg0: String): Unit

    Definition Classes
    Task → ProjectComponent
  74. def maybeConfigure(): Unit

    Definition Classes
    Task
    Annotations
    @throws()
  75. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  76. final def notify(): Unit

    Definition Classes
    AnyRef
  77. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  78. final def perform(): Unit

    Definition Classes
    Task
  79. def reconfigure(): Unit

    Definition Classes
    Task
  80. def selectorCount(): Int

    Definition Classes
    MatchingTask → SelectorContainer
  81. def selectorElements(): Enumeration

    Definition Classes
    MatchingTask → SelectorContainer
  82. def setAddparams(input: String): Unit

    Set the addparams info attribute.

    Set the addparams info attribute.

    input

    The value for addparams.

  83. def setBootclasspath(input: Path): Unit

    Sets the bootclasspath attribute.

    Sets the bootclasspath attribute. Used by Ant.

    input

    The value of bootclasspath.

  84. def setBootclasspathref(input: Reference): Unit

    Sets the bootclasspath as an external reference Ant parameter.

    Sets the bootclasspath as an external reference Ant parameter.

    input

    A reference to a source path.

  85. def setCaseSensitive(arg0: Boolean): Unit

    Definition Classes
    MatchingTask
  86. def setClasspath(input: Path): Unit

    Sets the classpath attribute.

    Sets the classpath attribute. Used by Ant.

    input

    The value of classpath.

  87. def setClasspathref(input: Reference): Unit

    Sets the classpath as an external reference Ant parameter.

    Sets the classpath as an external reference Ant parameter.

    input

    A reference to a class path.

  88. def setDefaultexcludes(arg0: Boolean): Unit

    Definition Classes
    MatchingTask
  89. def setDeprecation(input: String): Unit

    Set the deprecation info attribute.

    Set the deprecation info attribute.

    input

    One of the flags yes/no or on/off.

  90. def setDescription(arg0: String): Unit

    Definition Classes
    ProjectComponent
  91. def setDestdir(input: File): Unit

    Sets the destdir attribute.

    Sets the destdir attribute. Used by Ant.

    input

    The value of destination.

  92. def setDocUncompilable(input: String): Unit

  93. def setDocfooter(input: String): Unit

    Sets the docfooter attribute.

    Sets the docfooter attribute.

    input

    The value of docfooter.

  94. def setDocgenerator(input: String): Unit

    Sets the docgenerator attribute.

    Sets the docgenerator attribute.

    input

    A fully qualified class name of a doclet.

  95. def setDocrootcontent(input: File): Unit

    Sets the docrootcontent attribute.

    Sets the docrootcontent attribute.

    input

    The file from which the documentation content of the root package will be taken.

  96. def setDocsourceurl(input: String): Unit

    Sets the docsourceurl attribute.

    Sets the docsourceurl attribute.

    input

    The value of docsourceurl.

  97. def setDoctitle(input: String): Unit

    Sets the doctitle attribute.

    Sets the doctitle attribute.

    input

    The value of doctitle.

  98. def setDocversion(input: String): Unit

    Sets the docversion attribute.

    Sets the docversion attribute.

    input

    The value of docversion.

  99. def setEncoding(input: String): Unit

    Sets the encoding attribute.

    Sets the encoding attribute. Used by Ant.

    input

    The value of encoding.

  100. def setExcludes(arg0: String): Unit

    Definition Classes
    MatchingTask
  101. def setExcludesfile(arg0: File): Unit

    Definition Classes
    MatchingTask
  102. def setExtdirs(input: Path): Unit

    Sets the external extensions path attribute.

    Sets the external extensions path attribute. Used by Ant.

    input

    The value of extdirs.

  103. def setExtdirsref(input: Reference): Unit

    Sets the extdirs as an external reference Ant parameter.

    Sets the extdirs as an external reference Ant parameter.

    input

    A reference to an extensions path.

  104. def setFollowSymlinks(arg0: Boolean): Unit

    Definition Classes
    MatchingTask
  105. def setIncludes(arg0: String): Unit

    Definition Classes
    MatchingTask
  106. def setIncludesfile(arg0: File): Unit

    Definition Classes
    MatchingTask
  107. def setLocation(arg0: Location): Unit

    Definition Classes
    ProjectComponent
  108. def setOwningTarget(arg0: Target): Unit

    Definition Classes
    Task
  109. def setProject(arg0: Project): Unit

    Definition Classes
    MatchingTask → ProjectComponent
  110. def setRuntimeConfigurableWrapper(arg0: RuntimeConfigurable): Unit

    Definition Classes
    Task
  111. def setSourcepath(input: Path): Unit

    Sets the sourcepath attribute.

    Sets the sourcepath attribute. Used by Ant.

    input

    The value of sourcepath.

  112. def setSourcepathref(input: Reference): Unit

    Sets the sourcepath as an external reference Ant parameter.

    Sets the sourcepath as an external reference Ant parameter.

    input

    A reference to a source path.

  113. def setSrcdir(input: Path): Unit

    Sets the srcdir attribute.

    Sets the srcdir attribute. Used by Ant.

    input

    The value of origin.

  114. def setSrcref(input: Reference): Unit

    Sets the origin as an external reference Ant parameter.

    Sets the origin as an external reference Ant parameter.

    input

    A reference to an origin path.

  115. def setTaskName(arg0: String): Unit

    Definition Classes
    Task
  116. def setTaskType(arg0: String): Unit

    Definition Classes
    Task
  117. def setUnchecked(input: String): Unit

    Set the unchecked info attribute.

    Set the unchecked info attribute.

    input

    One of the flags yes/no or on/off.

  118. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  119. def toString(): String

    Definition Classes
    AnyRef → Any
  120. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()
  121. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()
  122. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()

Inherited from ScalaMatchingTask

Inherited from ScalaTask

Inherited from MatchingTask

Inherited from SelectorContainer

Inherited from Task

Inherited from ProjectComponent

Inherited from Cloneable

Inherited from AnyRef

Inherited from Any