Packages

c

scala.tools.ant

Scaladoc

class Scaladoc extends ScalaMatchingTask

An Ant task to document Scala code.

This task can take the following parameters as attributes:

  • srcdir (mandatory),
  • srcref,
  • destdir,
  • classpath,
  • classpathref,
  • sourcepath,
  • sourcepathref,
  • bootclasspath,
  • bootclasspathref,
  • extdirs,
  • extdirsref,
  • encoding,
  • doctitle,
  • header,
  • footer,
  • top,
  • bottom,
  • addparams,
  • deprecation,
  • docgenerator,
  • docrootcontent,
  • unchecked,
  • nofail,
  • skipPackages.

It also takes the following parameters as nested elements:

  • src (for srcdir),
  • classpath,
  • sourcepath,
  • bootclasspath,
  • extdirs.
Source
Scaladoc.scala
Linear Supertypes
ScalaMatchingTask, ScalaTask, MatchingTask, SelectorContainer, Task, ProjectComponent, java.lang.Cloneable, AnyRef, Any
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 StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Scaladoc()

Type Members

  1. abstract class PermissibleValue extends AnyRef

Value Members

  1. def XsetIgnore(arg0: String): Unit
    Definition Classes
    MatchingTask
  2. def XsetItems(arg0: String): Unit
    Definition Classes
    MatchingTask
  3. def add(arg0: FileSelector): Unit
    Definition Classes
    MatchingTask → SelectorContainer
  4. def addAnd(arg0: AndSelector): Unit
    Definition Classes
    MatchingTask → SelectorContainer
  5. def addContains(arg0: ContainsSelector): Unit
    Definition Classes
    MatchingTask → SelectorContainer
  6. def addContainsRegexp(arg0: ContainsRegexpSelector): Unit
    Definition Classes
    MatchingTask → SelectorContainer
  7. def addCustom(arg0: ExtendSelector): Unit
    Definition Classes
    MatchingTask → SelectorContainer
  8. def addDate(arg0: DateSelector): Unit
    Definition Classes
    MatchingTask → SelectorContainer
  9. def addDepend(arg0: DependSelector): Unit
    Definition Classes
    MatchingTask → SelectorContainer
  10. def addDepth(arg0: DepthSelector): Unit
    Definition Classes
    MatchingTask → SelectorContainer
  11. def addDifferent(arg0: DifferentSelector): Unit
    Definition Classes
    MatchingTask → SelectorContainer
  12. def addFilename(arg0: FilenameSelector): Unit
    Definition Classes
    MatchingTask → SelectorContainer
  13. def addMajority(arg0: MajoritySelector): Unit
    Definition Classes
    MatchingTask → SelectorContainer
  14. def addModified(arg0: ModifiedSelector): Unit
    Definition Classes
    MatchingTask → SelectorContainer
  15. def addNone(arg0: NoneSelector): Unit
    Definition Classes
    MatchingTask → SelectorContainer
  16. def addNot(arg0: NotSelector): Unit
    Definition Classes
    MatchingTask → SelectorContainer
  17. def addOr(arg0: OrSelector): Unit
    Definition Classes
    MatchingTask → SelectorContainer
  18. def addPresent(arg0: PresentSelector): Unit
    Definition Classes
    MatchingTask → SelectorContainer
  19. def addSelector(arg0: SelectSelector): Unit
    Definition Classes
    MatchingTask → SelectorContainer
  20. def addSize(arg0: SizeSelector): Unit
    Definition Classes
    MatchingTask → SelectorContainer
  21. def addType(arg0: TypeSelector): Unit
    Definition Classes
    MatchingTask → SelectorContainer
  22. def appendSelector(arg0: FileSelector): Unit
    Definition Classes
    MatchingTask → SelectorContainer
  23. final def bindToOwner(arg0: Task): Unit
    Definition Classes
    Task
  24. def clone(): AnyRef
    Definition Classes
    ProjectComponent → AnyRef
    Annotations
    @throws( ... )
  25. 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.

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

  27. def createExclude(): NameEntry
    Definition Classes
    MatchingTask
  28. def createExcludesFile(): NameEntry
    Definition Classes
    MatchingTask
  29. 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.

  30. def createInclude(): NameEntry
    Definition Classes
    MatchingTask
  31. def createIncludesFile(): NameEntry
    Definition Classes
    MatchingTask
  32. def createPatternSet(): PatternSet
    Definition Classes
    MatchingTask
  33. 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.

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

  35. def execute(): Unit

    Performs the compilation.

    Performs the compilation.

    Definition Classes
    Scaladoc → Task
  36. def getDescription(): String
    Definition Classes
    ProjectComponent
  37. def getLocation(): Location
    Definition Classes
    ProjectComponent
  38. def getOwningTarget(): Target
    Definition Classes
    Task
  39. def getProject(): Project
    Definition Classes
    ProjectComponent
  40. def getRuntimeConfigurableWrapper(): RuntimeConfigurable
    Definition Classes
    Task
  41. def getSelectors(arg0: Project): Array[FileSelector]
    Definition Classes
    MatchingTask → SelectorContainer
  42. def getTaskName(): String
    Definition Classes
    Task
  43. def getTaskType(): String
    Definition Classes
    Task
  44. def hasSelectors(): Boolean
    Definition Classes
    MatchingTask → SelectorContainer
  45. def init(): Unit
    Definition Classes
    Task
    Annotations
    @throws( ... )
  46. def log(arg0: String, arg1: java.lang.Throwable, arg2: Int): Unit
    Definition Classes
    Task
  47. def log(arg0: java.lang.Throwable, arg1: Int): Unit
    Definition Classes
    Task
  48. def log(arg0: String, arg1: Int): Unit
    Definition Classes
    Task → ProjectComponent
  49. def log(arg0: String): Unit
    Definition Classes
    Task → ProjectComponent
  50. def maybeConfigure(): Unit
    Definition Classes
    Task
    Annotations
    @throws( ... )
  51. final def perform(): Unit
    Definition Classes
    Task
  52. def reconfigure(): Unit
    Definition Classes
    Task
  53. def safeBuildError(message: String): Unit
  54. def selectorCount(): Int
    Definition Classes
    MatchingTask → SelectorContainer
  55. def selectorElements(): java.util.Enumeration[FileSelector]
    Definition Classes
    MatchingTask → SelectorContainer
  56. def setAddparams(input: String): Unit

    Set the addparams info attribute.

    Set the addparams info attribute.

    input

    The value for addparams.

  57. def setBootclasspath(input: Path): Unit

    Sets the bootclasspath attribute.

    Sets the bootclasspath attribute. Used by Ant.

    input

    The value of bootclasspath.

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

  59. def setCaseSensitive(arg0: Boolean): Unit
    Definition Classes
    MatchingTask
  60. def setClasspath(input: Path): Unit

    Sets the classpath attribute.

    Sets the classpath attribute. Used by Ant.

    input

    The value of classpath.

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

  62. def setDefaultexcludes(arg0: Boolean): Unit
    Definition Classes
    MatchingTask
  63. 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.

  64. def setDescription(arg0: String): Unit
    Definition Classes
    ProjectComponent
  65. def setDestdir(input: File): Unit

    Sets the destdir attribute.

    Sets the destdir attribute. Used by Ant.

    input

    The value of destination.

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

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

  68. 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)

  69. def setDocUncompilable(input: String): Unit
  70. def setDocfooter(input: String): Unit

    Sets the docfooter attribute.

    Sets the docfooter attribute.

    input

    The value of docfooter.

  71. def setDocgenerator(input: String): Unit

    Sets the docgenerator attribute.

    Sets the docgenerator attribute.

    input

    A fully qualified class name of a doclet.

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

  73. def setDocsourceurl(input: String): Unit

    Sets the docsourceurl attribute.

    Sets the docsourceurl attribute.

    input

    The value of docsourceurl.

  74. def setDoctitle(input: String): Unit

    Sets the doctitle attribute.

    Sets the doctitle attribute.

    input

    The value of doctitle.

  75. def setDocversion(input: String): Unit

    Sets the docversion attribute.

    Sets the docversion attribute.

    input

    The value of docversion.

  76. def setEncoding(input: String): Unit

    Sets the encoding attribute.

    Sets the encoding attribute. Used by Ant.

    input

    The value of encoding.

  77. def setExcludes(arg0: String): Unit
    Definition Classes
    MatchingTask
  78. def setExcludesfile(arg0: File): Unit
    Definition Classes
    MatchingTask
  79. 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.

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

  81. def setFollowSymlinks(arg0: Boolean): Unit
    Definition Classes
    MatchingTask
  82. def setGroups(input: String): Unit

    Instruct the scaladoc tool to group similar functions together

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

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

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

  86. def setIncludes(arg0: String): Unit
    Definition Classes
    MatchingTask
  87. def setIncludesfile(arg0: File): Unit
    Definition Classes
    MatchingTask
  88. def setLocation(arg0: Location): Unit
    Definition Classes
    ProjectComponent
  89. 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.

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

  91. def setOwningTarget(arg0: Target): Unit
    Definition Classes
    Task
  92. def setProject(arg0: Project): Unit
    Definition Classes
    MatchingTask → ProjectComponent
  93. 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.

  94. def setRuntimeConfigurableWrapper(arg0: RuntimeConfigurable): Unit
    Definition Classes
    Task
  95. 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.

  96. def setSourcepath(input: Path): Unit

    Sets the sourcepath attribute.

    Sets the sourcepath attribute. Used by Ant.

    input

    The value of sourcepath.

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

  98. def setSrcdir(input: Path): Unit

    Sets the srcdir attribute.

    Sets the srcdir attribute. Used by Ant.

    input

    The value of origin.

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

  100. def setTaskName(arg0: String): Unit
    Definition Classes
    Task
  101. def setTaskType(arg0: String): Unit
    Definition Classes
    Task
  102. 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.

  103. object Flag extends PermissibleValue

    Defines valid values for the deprecation and unchecked properties.