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
- Alphabetic
- By Inheritance
- Scaladoc
- ScalaMatchingTask
- ScalaTask
- MatchingTask
- SelectorContainer
- Task
- ProjectComponent
- Cloneable
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Instance Constructors
- new Scaladoc()
Type Members
- abstract class PermissibleValue extends AnyRef
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- def ->[B](y: B): (Scaladoc, B)
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
XsetIgnore(arg0: String): Unit
- Definition Classes
- MatchingTask
-
def
XsetItems(arg0: String): Unit
- Definition Classes
- MatchingTask
-
def
add(arg0: FileSelector): Unit
- Definition Classes
- MatchingTask → SelectorContainer
-
def
addAnd(arg0: AndSelector): Unit
- Definition Classes
- MatchingTask → SelectorContainer
-
def
addContains(arg0: ContainsSelector): Unit
- Definition Classes
- MatchingTask → SelectorContainer
-
def
addContainsRegexp(arg0: ContainsRegexpSelector): Unit
- Definition Classes
- MatchingTask → SelectorContainer
-
def
addCustom(arg0: ExtendSelector): Unit
- Definition Classes
- MatchingTask → SelectorContainer
-
def
addDate(arg0: DateSelector): Unit
- Definition Classes
- MatchingTask → SelectorContainer
-
def
addDepend(arg0: DependSelector): Unit
- Definition Classes
- MatchingTask → SelectorContainer
-
def
addDepth(arg0: DepthSelector): Unit
- Definition Classes
- MatchingTask → SelectorContainer
-
def
addDifferent(arg0: DifferentSelector): Unit
- Definition Classes
- MatchingTask → SelectorContainer
-
def
addFilename(arg0: FilenameSelector): Unit
- Definition Classes
- MatchingTask → SelectorContainer
-
def
addMajority(arg0: MajoritySelector): Unit
- Definition Classes
- MatchingTask → SelectorContainer
-
def
addModified(arg0: ModifiedSelector): Unit
- Definition Classes
- MatchingTask → SelectorContainer
-
def
addNone(arg0: NoneSelector): Unit
- Definition Classes
- MatchingTask → SelectorContainer
-
def
addNot(arg0: NotSelector): Unit
- Definition Classes
- MatchingTask → SelectorContainer
-
def
addOr(arg0: OrSelector): Unit
- Definition Classes
- MatchingTask → SelectorContainer
-
def
addPresent(arg0: PresentSelector): Unit
- Definition Classes
- MatchingTask → SelectorContainer
-
def
addSelector(arg0: SelectSelector): Unit
- Definition Classes
- MatchingTask → SelectorContainer
-
def
addSize(arg0: SizeSelector): Unit
- Definition Classes
- MatchingTask → SelectorContainer
-
def
addType(arg0: TypeSelector): Unit
- Definition Classes
- MatchingTask → SelectorContainer
-
def
appendSelector(arg0: FileSelector): Unit
- Definition Classes
- MatchingTask → SelectorContainer
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
final
def
bindToOwner(arg0: Task): Unit
- Definition Classes
- Task
-
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.
-
def
clone(): AnyRef
- Definition Classes
- ProjectComponent → AnyRef
- Annotations
- @throws( ... )
-
def
createBootclasspath(): Path
Sets the
bootclasspath
as a nestedsourcepath
Ant parameter.Sets the
bootclasspath
as a nestedsourcepath
Ant parameter.- returns
A source path to be configured.
-
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.
-
def
createExclude(): NameEntry
- Definition Classes
- MatchingTask
-
def
createExcludesFile(): NameEntry
- Definition Classes
- MatchingTask
-
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.
-
def
createInclude(): NameEntry
- Definition Classes
- MatchingTask
-
def
createIncludesFile(): NameEntry
- Definition Classes
- MatchingTask
-
def
createPatternSet(): PatternSet
- Definition Classes
- MatchingTask
-
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.
-
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.
- def ensuring(cond: (Scaladoc) ⇒ Boolean, msg: ⇒ Any): Scaladoc
- def ensuring(cond: (Scaladoc) ⇒ Boolean): Scaladoc
- def ensuring(cond: Boolean, msg: ⇒ Any): Scaladoc
- def ensuring(cond: Boolean): Scaladoc
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
execute(): Unit
Performs the compilation.
Performs the compilation.
- Definition Classes
- Scaladoc → Task
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
- def formatted(fmtstr: String): String
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
getDescription(): String
- Definition Classes
- ProjectComponent
-
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
-
final
def
getImplicitFileSet(): FileSet
- Attributes
- protected[org.apache.tools.ant.taskdefs]
- Definition Classes
- MatchingTask
-
def
getLocation(): Location
- Definition Classes
- ProjectComponent
-
def
getOwningTarget(): Target
- Definition Classes
- Task
-
def
getProject(): Project
- Definition Classes
- ProjectComponent
-
def
getRuntimeConfigurableWrapper(): RuntimeConfigurable
- Definition Classes
- Task
-
def
getSelectors(arg0: Project): Array[FileSelector]
- Definition Classes
- MatchingTask → SelectorContainer
-
def
getTaskName(): String
- Definition Classes
- Task
-
def
getTaskType(): String
- Definition Classes
- Task
-
def
getWrapper(): RuntimeConfigurable
- Attributes
- protected[org.apache.tools.ant]
- Definition Classes
- Task
-
def
handleErrorFlush(arg0: String): Unit
- Attributes
- protected[org.apache.tools.ant]
- Definition Classes
- Task
-
def
handleErrorOutput(arg0: String): Unit
- Attributes
- protected[org.apache.tools.ant]
- Definition Classes
- Task
-
def
handleFlush(arg0: String): Unit
- Attributes
- protected[org.apache.tools.ant]
- Definition Classes
- Task
-
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] )
-
def
handleOutput(arg0: String): Unit
- Attributes
- protected[org.apache.tools.ant]
- Definition Classes
- Task
-
def
hasSelectors(): Boolean
- Definition Classes
- MatchingTask → SelectorContainer
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
init(): Unit
- Definition Classes
- Task
- Annotations
- @throws( ... )
-
def
initialize: (Settings, List[File])
Initializes settings and source files
Initializes settings and source files
- Attributes
- protected
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
isInvalid(): Boolean
- Attributes
- protected[org.apache.tools.ant]
- Definition Classes
- Task
-
def
log(arg0: String, arg1: java.lang.Throwable, arg2: Int): Unit
- Definition Classes
- Task
-
def
log(arg0: java.lang.Throwable, arg1: Int): Unit
- Definition Classes
- Task
-
def
log(arg0: String, arg1: Int): Unit
- Definition Classes
- Task → ProjectComponent
-
def
log(arg0: String): Unit
- Definition Classes
- Task → ProjectComponent
-
def
maybeConfigure(): Unit
- Definition Classes
- Task
- Annotations
- @throws( ... )
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
perform(): Unit
- Definition Classes
- Task
-
def
reconfigure(): Unit
- Definition Classes
- Task
- def safeBuildError(message: String): Unit
-
def
selectorCount(): Int
- Definition Classes
- MatchingTask → SelectorContainer
-
def
selectorElements(): java.util.Enumeration[FileSelector]
- Definition Classes
- MatchingTask → SelectorContainer
-
def
setAddparams(input: String): Unit
Set the
addparams
info attribute.Set the
addparams
info attribute.- input
The value for
addparams
.
-
def
setBootclasspath(input: Path): Unit
Sets the
bootclasspath
attribute.Sets the
bootclasspath
attribute. Used by Ant.- input
The value of
bootclasspath
.
-
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.
-
def
setCaseSensitive(arg0: Boolean): Unit
- Definition Classes
- MatchingTask
-
def
setClasspath(input: Path): Unit
Sets the
classpath
attribute.Sets the
classpath
attribute. Used by Ant.- input
The value of
classpath
.
-
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.
-
def
setDefaultexcludes(arg0: Boolean): Unit
- Definition Classes
- MatchingTask
-
def
setDeprecation(input: String): Unit
Set the
deprecation
info attribute.Set the
deprecation
info attribute.- input
One of the flags
yes/no
oron/off
.
-
def
setDescription(arg0: String): Unit
- Definition Classes
- ProjectComponent
-
def
setDestdir(input: File): Unit
Sets the
destdir
attribute.Sets the
destdir
attribute. Used by Ant.- input
The value of
destination
.
-
def
setDiagrams(input: String): Unit
Set the
diagrams
bit so Scaladoc adds diagrams to the documentationSet the
diagrams
bit so Scaladoc adds diagrams to the documentation- input
One of the flags
yes/no
oron/off
. Default if no/off.
-
def
setDiagramsDebug(input: String): Unit
Set the
diagramsDebug
bit so Scaladoc outputs diagram building debug informationSet the
diagramsDebug
bit so Scaladoc outputs diagram building debug information- input
One of the flags
yes/no
oron/off
. Default if no/off.
-
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) - def setDocUncompilable(input: String): Unit
-
def
setDocfooter(input: String): Unit
Sets the
docfooter
attribute.Sets the
docfooter
attribute.- input
The value of
docfooter
.
-
def
setDocgenerator(input: String): Unit
Sets the
docgenerator
attribute.Sets the
docgenerator
attribute.- input
A fully qualified class name of a doclet.
-
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.
-
def
setDocsourceurl(input: String): Unit
Sets the
docsourceurl
attribute.Sets the
docsourceurl
attribute.- input
The value of
docsourceurl
.
-
def
setDoctitle(input: String): Unit
Sets the
doctitle
attribute.Sets the
doctitle
attribute.- input
The value of
doctitle
.
-
def
setDocversion(input: String): Unit
Sets the
docversion
attribute.Sets the
docversion
attribute.- input
The value of
docversion
.
-
def
setEncoding(input: String): Unit
Sets the
encoding
attribute.Sets the
encoding
attribute. Used by Ant.- input
The value of
encoding
.
-
def
setExcludes(arg0: String): Unit
- Definition Classes
- MatchingTask
-
def
setExcludesfile(arg0: File): Unit
- Definition Classes
- MatchingTask
-
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
.
-
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.
-
def
setFollowSymlinks(arg0: Boolean): Unit
- Definition Classes
- MatchingTask
-
def
setGroups(input: String): Unit
Instruct the scaladoc tool to group similar functions together
-
def
setImplicits(input: String): Unit
Set the
implicits
info attribute.Set the
implicits
info attribute.- input
One of the flags
yes/no
oron/off
. Default if no/off.
-
def
setImplicitsDebug(input: String): Unit
Set the
implicitsDebug
info attribute so scaladoc outputs implicit conversion debug informationSet the
implicitsDebug
info attribute so scaladoc outputs implicit conversion debug information- input
One of the flags
yes/no
oron/off
. Default if no/off.
-
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 scopeSet 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
oron/off
. Default if no/off.
-
def
setIncludes(arg0: String): Unit
- Definition Classes
- MatchingTask
-
def
setIncludesfile(arg0: File): Unit
- Definition Classes
- MatchingTask
-
def
setLocation(arg0: Location): Unit
- Definition Classes
- ProjectComponent
-
def
setNoFail(input: String): Unit
Set the
nofail
info attribute.Set the
nofail
info attribute.- input
One of the flags
yes/no
oron/off
. Default if no/off.
-
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
oron/off
. Default if no/off.
-
def
setOwningTarget(arg0: Target): Unit
- Definition Classes
- Task
-
def
setProject(arg0: Project): Unit
- Definition Classes
- MatchingTask → ProjectComponent
-
def
setRawOutput(input: String): Unit
Set the
rawOutput
bit so Scaladoc also outputs text from each html fileSet the
rawOutput
bit so Scaladoc also outputs text from each html file- input
One of the flags
yes/no
oron/off
. Default if no/off.
-
def
setRuntimeConfigurableWrapper(arg0: RuntimeConfigurable): Unit
- Definition Classes
- Task
-
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.
-
def
setSourcepath(input: Path): Unit
Sets the
sourcepath
attribute.Sets the
sourcepath
attribute. Used by Ant.- input
The value of
sourcepath
.
-
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.
-
def
setSrcdir(input: Path): Unit
Sets the
srcdir
attribute.Sets the
srcdir
attribute. Used by Ant.- input
The value of
origin
.
-
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.
-
def
setTaskName(arg0: String): Unit
- Definition Classes
- Task
-
def
setTaskType(arg0: String): Unit
- Definition Classes
- Task
-
def
setUnchecked(input: String): Unit
Set the
unchecked
info attribute.Set the
unchecked
info attribute.- input
One of the flags
yes/no
oron/off
.
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
- def →[B](y: B): (Scaladoc, B)
-
object
Flag extends PermissibleValue
Defines valid values for the
deprecation
andunchecked
properties.
The Scala compiler and reflection APIs.