de.tototec.sbuild.addons.scala

Scaladoc

class Scaladoc extends AnyRef

Generate Scaladoc.

Since

0.4.0

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Scaladoc
  2. AnyRef
  3. 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(scaladocClasspath: Seq[File] = null, sources: Seq[File] = null, srcDir: File = null, srcDirs: Seq[File] = null, destDir: File = null, classpath: Seq[File] = null, encoding: String = null, unchecked: Boolean = null, deprecation: Boolean = null, verbose: Boolean = null, implicits: Boolean = null, docTitle: String = null, windowTitle: String = null, docVersion: String = null, docFooter: String = null, rawOutput: Boolean = null, styleSheet: File = null, sourceUrl: String = null, fork: Boolean = false, additionalScaladocArgs: Seq[String] = null)(implicit project: Project)

    scaladocClasspath

    Classpath used to load the scaladoc generator.

    sources

    Sources, to generate the scaladoc for.

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. var additionalScaladocArgs: Seq[String]

  9. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  10. var classpath: Seq[File]

  11. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  12. var deprecation: Boolean

  13. var destDir: File

  14. var docFooter: String

  15. var docTitle: String

  16. var docVersion: String

  17. var encoding: String

  18. 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
  19. 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
  20. 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
  21. 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
  22. final def eq(arg0: AnyRef): Boolean

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

    Definition Classes
    AnyRef → Any
  24. def execute: Unit

  25. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  26. var fork: Boolean

  27. 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()
  28. def generateExternal(args: Array[String]): Int

  29. def generateInternal(args: Array[String]): Int

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

    Definition Classes
    AnyRef → Any
  31. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  32. var implicits: Boolean

  33. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  34. final def ne(arg0: AnyRef): Boolean

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

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

    Definition Classes
    AnyRef
  37. var rawOutput: Boolean

  38. val scaladocClassName: String

  39. var scaladocClasspath: Seq[File]

    Classpath used to load the scaladoc generator.

  40. var sourceUrl: String

  41. var sources: Seq[File]

    Sources, to generate the scaladoc for.

  42. var srcDir: File

  43. var srcDirs: Seq[File]

  44. var styleSheet: File

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

    Definition Classes
    AnyRef
  46. def toString(): String

    Definition Classes
    Scaladoc → AnyRef → Any
  47. var unchecked: Boolean

  48. var verbose: Boolean

  49. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  52. var windowTitle: String

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