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:

Linear Supertypes
ScalaMatchingTask, ScalaTask, MatchingTask, SelectorContainer, Task, ProjectComponent, java.lang.Cloneable, AnyRef, Any
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Scaladoc
  2. ScalaMatchingTask
  3. ScalaTask
  4. MatchingTask
  5. SelectorContainer
  6. Task
  7. ProjectComponent
  8. Cloneable
  9. AnyRef
  10. Any
Implicitly
  1. by any2stringadd
  2. by any2stringfmt
  3. by any2ArrowAssoc
  4. by any2Ensuring
  1. Hide All
  2. Show all
Learn more about member selection
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. def +(other: String): String

    Implicit information
    This member is added by an implicit conversion from Scaladoc to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd

  5. def ->[B](y: B): (Scaladoc, B)

    Implicit information
    This member is added by an implicit conversion from Scaladoc to ArrowAssoc[Scaladoc] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()

  6. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  7. final def ==(arg0: Any): Boolean

    Definition Classes
    Any

  8. object Flag extends PermissibleValue

    Defines valid values for the deprecation and unchecked properties.

  9. def XsetIgnore(arg0: String): Unit

    Definition Classes
    MatchingTask

  10. def XsetItems(arg0: String): Unit

    Definition Classes
    MatchingTask

  11. def add(arg0: FileSelector): Unit

    Definition Classes
    MatchingTask → SelectorContainer

  12. def addAnd(arg0: AndSelector): Unit

    Definition Classes
    MatchingTask → SelectorContainer

  13. def addContains(arg0: ContainsSelector): Unit

    Definition Classes
    MatchingTask → SelectorContainer

  14. def addContainsRegexp(arg0: ContainsRegexpSelector): Unit

    Definition Classes
    MatchingTask → SelectorContainer

  15. def addCustom(arg0: ExtendSelector): Unit

    Definition Classes
    MatchingTask → SelectorContainer

  16. def addDate(arg0: DateSelector): Unit

    Definition Classes
    MatchingTask → SelectorContainer

  17. def addDepend(arg0: DependSelector): Unit

    Definition Classes
    MatchingTask → SelectorContainer

  18. def addDepth(arg0: DepthSelector): Unit

    Definition Classes
    MatchingTask → SelectorContainer

  19. def addDifferent(arg0: DifferentSelector): Unit

    Definition Classes
    MatchingTask → SelectorContainer

  20. def addFilename(arg0: FilenameSelector): Unit

    Definition Classes
    MatchingTask → SelectorContainer

  21. def addMajority(arg0: MajoritySelector): Unit

    Definition Classes
    MatchingTask → SelectorContainer

  22. def addModified(arg0: ModifiedSelector): Unit

    Definition Classes
    MatchingTask → SelectorContainer

  23. def addNone(arg0: NoneSelector): Unit

    Definition Classes
    MatchingTask → SelectorContainer

  24. def addNot(arg0: NotSelector): Unit

    Definition Classes
    MatchingTask → SelectorContainer

  25. def addOr(arg0: OrSelector): Unit

    Definition Classes
    MatchingTask → SelectorContainer

  26. def addPresent(arg0: PresentSelector): Unit

    Definition Classes
    MatchingTask → SelectorContainer

  27. def addSelector(arg0: SelectSelector): Unit

    Definition Classes
    MatchingTask → SelectorContainer

  28. def addSize(arg0: SizeSelector): Unit

    Definition Classes
    MatchingTask → SelectorContainer

  29. def addType(arg0: TypeSelector): Unit

    Definition Classes
    MatchingTask → SelectorContainer

  30. def appendSelector(arg0: FileSelector): Unit

    Definition Classes
    MatchingTask → SelectorContainer

  31. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  32. final def bindToOwner(arg0: Task): Unit

    Definition Classes
    Task

  33. 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.

  34. def clone(): AnyRef

    Definition Classes
    ProjectComponent → AnyRef
    Annotations
    @throws( ... )

  35. 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.

  36. 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.

  37. def createExclude(): NameEntry

    Definition Classes
    MatchingTask

  38. def createExcludesFile(): NameEntry

    Definition Classes
    MatchingTask

  39. 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.

  40. def createInclude(): NameEntry

    Definition Classes
    MatchingTask

  41. def createIncludesFile(): NameEntry

    Definition Classes
    MatchingTask

  42. def createPatternSet(): PatternSet

    Definition Classes
    MatchingTask

  43. 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.

  44. 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.

  45. def ensuring(cond: (Scaladoc) ⇒ Boolean, msg: ⇒ Any): Scaladoc

    Implicit information
    This member is added by an implicit conversion from Scaladoc to Ensuring[Scaladoc] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  46. def ensuring(cond: (Scaladoc) ⇒ Boolean): Scaladoc

    Implicit information
    This member is added by an implicit conversion from Scaladoc to Ensuring[Scaladoc] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  47. def ensuring(cond: Boolean, msg: ⇒ Any): Scaladoc

    Implicit information
    This member is added by an implicit conversion from Scaladoc to Ensuring[Scaladoc] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  48. def ensuring(cond: Boolean): Scaladoc

    Implicit information
    This member is added by an implicit conversion from Scaladoc to Ensuring[Scaladoc] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring

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

    Definition Classes
    AnyRef

  50. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  51. def execute(): Unit

    Performs the compilation.

    Performs the compilation.

    Definition Classes
    Scaladoc → Task

  52. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  53. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from Scaladoc to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()

  54. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  55. def getDescription(): String

    Definition Classes
    ProjectComponent

  56. 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

  57. final def getImplicitFileSet(): FileSet

    Attributes
    protected[org.apache.tools.ant.taskdefs]
    Definition Classes
    MatchingTask

  58. def getLocation(): Location

    Definition Classes
    ProjectComponent

  59. def getOwningTarget(): Target

    Definition Classes
    Task

  60. def getProject(): Project

    Definition Classes
    ProjectComponent

  61. def getRuntimeConfigurableWrapper(): RuntimeConfigurable

    Definition Classes
    Task

  62. def getSelectors(arg0: Project): Array[FileSelector]

    Definition Classes
    MatchingTask → SelectorContainer

  63. def getTaskName(): String

    Definition Classes
    Task

  64. def getTaskType(): String

    Definition Classes
    Task

  65. def getWrapper(): RuntimeConfigurable

    Attributes
    protected[org.apache.tools.ant]
    Definition Classes
    Task

  66. def handleErrorFlush(arg0: String): Unit

    Attributes
    protected[org.apache.tools.ant]
    Definition Classes
    Task

  67. def handleErrorOutput(arg0: String): Unit

    Attributes
    protected[org.apache.tools.ant]
    Definition Classes
    Task

  68. def handleFlush(arg0: String): Unit

    Attributes
    protected[org.apache.tools.ant]
    Definition Classes
    Task

  69. def handleInput(arg0: Array[Byte], arg1: Int, arg2: Int): Int

    Attributes
    protected[org.apache.tools.ant]
    Definition Classes
    Task
    Annotations
    @throws( classOf[java.io.IOException] )

  70. def handleOutput(arg0: String): Unit

    Attributes
    protected[org.apache.tools.ant]
    Definition Classes
    Task

  71. def hasSelectors(): Boolean

    Definition Classes
    MatchingTask → SelectorContainer

  72. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  73. def init(): Unit

    Definition Classes
    Task
    Annotations
    @throws( ... )

  74. def initialize: (Settings, List[File])

    Initializes settings and source files

    Initializes settings and source files

    Attributes
    protected

  75. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  76. final def isInvalid(): Boolean

    Attributes
    protected[org.apache.tools.ant]
    Definition Classes
    Task

  77. def log(arg0: String, arg1: java.lang.Throwable, arg2: Int): Unit

    Definition Classes
    Task

  78. def log(arg0: java.lang.Throwable, arg1: Int): Unit

    Definition Classes
    Task

  79. def log(arg0: String, arg1: Int): Unit

    Definition Classes
    Task → ProjectComponent

  80. def log(arg0: String): Unit

    Definition Classes
    Task → ProjectComponent

  81. def maybeConfigure(): Unit

    Definition Classes
    Task
    Annotations
    @throws( ... )

  82. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  83. final def notify(): Unit

    Definition Classes
    AnyRef

  84. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  85. final def perform(): Unit

    Definition Classes
    Task

  86. def reconfigure(): Unit

    Definition Classes
    Task

  87. def safeBuildError(message: String): Unit

  88. def selectorCount(): Int

    Definition Classes
    MatchingTask → SelectorContainer

  89. def selectorElements(): java.util.Enumeration

    Definition Classes
    MatchingTask → SelectorContainer

  90. def setAddparams(input: String): Unit

    Set the addparams info attribute.

    Set the addparams info attribute.

    input

    The value for addparams.

  91. def setBootclasspath(input: Path): Unit

    Sets the bootclasspath attribute.

    Sets the bootclasspath attribute. Used by Ant.

    input

    The value of bootclasspath.

  92. 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.

  93. def setCaseSensitive(arg0: Boolean): Unit

    Definition Classes
    MatchingTask

  94. def setClasspath(input: Path): Unit

    Sets the classpath attribute.

    Sets the classpath attribute. Used by Ant.

    input

    The value of classpath.

  95. 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.

  96. def setDefaultexcludes(arg0: Boolean): Unit

    Definition Classes
    MatchingTask

  97. 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.

  98. def setDescription(arg0: String): Unit

    Definition Classes
    ProjectComponent

  99. def setDestdir(input: File): Unit

    Sets the destdir attribute.

    Sets the destdir attribute. Used by Ant.

    input

    The value of destination.

  100. def setDiagrams(input: String): Unit

    Set the diagrams bit so Scaladoc adds diagrams to the documentation

    Set the diagrams bit so Scaladoc adds diagrams to the documentation

    input

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

  101. def setDiagramsDebug(input: String): Unit

    Set the diagramsDebug bit so Scaladoc outputs diagram building debug information

    Set the diagramsDebug bit so Scaladoc outputs diagram building debug information

    input

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

  102. def setDiagramsDotPath(input: String): Unit

    Set the diagramsDotPath attribute to the path where graphviz dot can be found (including the binary file name, eg: /usr/bin/dot)

  103. def setDocUncompilable(input: String): Unit

  104. def setDocfooter(input: String): Unit

    Sets the docfooter attribute.

    Sets the docfooter attribute.

    input

    The value of docfooter.

  105. def setDocgenerator(input: String): Unit

    Sets the docgenerator attribute.

    Sets the docgenerator attribute.

    input

    A fully qualified class name of a doclet.

  106. 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.

  107. def setDocsourceurl(input: String): Unit

    Sets the docsourceurl attribute.

    Sets the docsourceurl attribute.

    input

    The value of docsourceurl.

  108. def setDoctitle(input: String): Unit

    Sets the doctitle attribute.

    Sets the doctitle attribute.

    input

    The value of doctitle.

  109. def setDocversion(input: String): Unit

    Sets the docversion attribute.

    Sets the docversion attribute.

    input

    The value of docversion.

  110. def setEncoding(input: String): Unit

    Sets the encoding attribute.

    Sets the encoding attribute. Used by Ant.

    input

    The value of encoding.

  111. def setExcludes(arg0: String): Unit

    Definition Classes
    MatchingTask

  112. def setExcludesfile(arg0: File): Unit

    Definition Classes
    MatchingTask

  113. 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.

  114. 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.

  115. def setFollowSymlinks(arg0: Boolean): Unit

    Definition Classes
    MatchingTask

  116. def setGroups(input: String): Unit

    Instruct the scaladoc tool to group similar functions together

  117. def setImplicits(input: String): Unit

    Set the implicits info attribute.

    Set the implicits info attribute.

    input

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

  118. def setImplicitsDebug(input: String): Unit

    Set the implicitsDebug info attribute so scaladoc outputs implicit conversion debug information

    Set the implicitsDebug info attribute so scaladoc outputs implicit conversion debug information

    input

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

  119. def setImplicitsShowAll(input: String): Unit

    Set the implicitsShowAll info attribute to enable scaladoc to show all implicits, including those impossible to convert to from the default scope

    Set the implicitsShowAll info attribute to enable scaladoc to show all implicits, including those impossible to convert to from the default scope

    input

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

  120. def setIncludes(arg0: String): Unit

    Definition Classes
    MatchingTask

  121. def setIncludesfile(arg0: File): Unit

    Definition Classes
    MatchingTask

  122. def setLocation(arg0: Location): Unit

    Definition Classes
    ProjectComponent

  123. def setNoFail(input: String): Unit

    Set the nofail info attribute.

    Set the nofail info attribute.

    input

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

  124. def setNoPrefixes(input: String): Unit

    Set the noPrefixes bit to prevent Scaladoc from generating prefixes in front of types -- may lead to confusion, but significantly speeds up the generation.

    Set the noPrefixes bit to prevent Scaladoc from generating prefixes in front of types -- may lead to confusion, but significantly speeds up the generation.

    input

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

  125. def setOwningTarget(arg0: Target): Unit

    Definition Classes
    Task

  126. def setProject(arg0: Project): Unit

    Definition Classes
    MatchingTask → ProjectComponent

  127. def setRawOutput(input: String): Unit

    Set the rawOutput bit so Scaladoc also outputs text from each html file

    Set the rawOutput bit so Scaladoc also outputs text from each html file

    input

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

  128. def setRuntimeConfigurableWrapper(arg0: RuntimeConfigurable): Unit

    Definition Classes
    Task

  129. def setSkipPackages(input: String): Unit

    Instruct the scaladoc tool to skip certain packages.

    Instruct the scaladoc tool to skip certain packages.

    input

    A colon-delimited list of fully qualified package names that will be skipped from scaladoc.

  130. def setSourcepath(input: Path): Unit

    Sets the sourcepath attribute.

    Sets the sourcepath attribute. Used by Ant.

    input

    The value of sourcepath.

  131. 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.

  132. def setSrcdir(input: Path): Unit

    Sets the srcdir attribute.

    Sets the srcdir attribute. Used by Ant.

    input

    The value of origin.

  133. 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.

  134. def setTaskName(arg0: String): Unit

    Definition Classes
    Task

  135. def setTaskType(arg0: String): Unit

    Definition Classes
    Task

  136. 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.

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

    Definition Classes
    AnyRef

  138. def toString(): String

    Definition Classes
    AnyRef → Any

  139. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  140. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  141. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  142. def →[B](y: B): (Scaladoc, B)

    Implicit information
    This member is added by an implicit conversion from Scaladoc to ArrowAssoc[Scaladoc] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Shadowed Implicit Value Members

  1. val self: Any

    Implicit information
    This member is added by an implicit conversion from Scaladoc to StringAdd performed by method any2stringadd in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (scaladoc: StringAdd).self
    Definition Classes
    StringAdd

  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from Scaladoc to StringFormat performed by method any2stringfmt in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (scaladoc: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. def x: Scaladoc

    Implicit information
    This member is added by an implicit conversion from Scaladoc to ArrowAssoc[Scaladoc] performed by method any2ArrowAssoc in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (scaladoc: ArrowAssoc[Scaladoc]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: Scaladoc

    Implicit information
    This member is added by an implicit conversion from Scaladoc to Ensuring[Scaladoc] performed by method any2Ensuring in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (scaladoc: Ensuring[Scaladoc]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from ScalaMatchingTask

Inherited from ScalaTask

Inherited from MatchingTask

Inherited from SelectorContainer

Inherited from Task

Inherited from ProjectComponent

Inherited from java.lang.Cloneable

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from Scaladoc to StringAdd

Inherited by implicit conversion any2stringfmt from Scaladoc to StringFormat

Inherited by implicit conversion any2ArrowAssoc from Scaladoc to ArrowAssoc[Scaladoc]

Inherited by implicit conversion any2Ensuring from Scaladoc to Ensuring[Scaladoc]

Ungrouped