de.tototec.sbuild.addons.java

Javadoc

class Javadoc extends AnyRef

Javadoc Generator Addon.

The generator can be configured via constructor parameter or vars. To actually start the compilation use Javac#execute.

To easily configure and execute the compiler in one go, see Javadoc$#apply.

Since

0.4.1

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Javadoc
  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 Javadoc(javadocClasspath: Seq[File] = null, classpath: Seq[File] = null, sources: Seq[File] = null, srcDir: File = null, srcDirs: Seq[File] = null, destDir: File = null, encoding: String = "UTF-8", verbose: Boolean = null, source: String = null, debugInfo: String = null, fork: Boolean = false, additionalJavadocArgs: Seq[String] = null)(implicit project: Project)

    Creates a new Javadoc Generator addon instance.

    Creates a new Javadoc Generator addon instance. All parameters can be omitted and set later.

    The source files can be given via multiple parameters, sources, srcDir and srcDirs, and will be joined.

    javadocClasspath

    The classpath which contains the Javadoc generator and its dependencies. If not given, the environment variable JAVA_HOME will be checked, and if it points to a installed JDK, this one will be used.

    classpath

    The classpath used to load dependencies of the sources.

    sources

    Source files.

    srcDir

    A directory containing Java source files.

    srcDirs

    Multiple directories containing Java source files.

    destDir

    The directory, where the generated files will be stored. If the directory does not exists, it will be created.

    encoding

    The encoding of the source files.

    verbose

    Output messages about what the generator is doing.

    source

    Provide source compatibility with specified release.

    debugInfo

    If specified generate debugging info. Supported values: none, lines, vars, source, all.

    fork

    Run the generator in a separate process (if true).

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 Javadoc to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd
  5. def ->[B](y: B): (Javadoc, B)

    Implicit information
    This member is added by an implicit conversion from Javadoc to ArrowAssoc[Javadoc] 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 additionalJavadocArgs: Seq[String]

  9. final def asInstanceOf[T0]: T0

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

    The classpath used to load dependencies of the sources.

  11. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  12. def compileExternal(args: Array[String]): Int

    Attributes
    protected
  13. def compileInternal(args: Array[String]): Int

    Attributes
    protected
  14. var debugInfo: String

    If specified generate debugging info.

    If specified generate debugging info. Supported values: none, lines, vars, source, all.

  15. var destDir: File

    The directory, where the generated files will be stored.

    The directory, where the generated files will be stored. If the directory does not exists, it will be created.

  16. var encoding: String

    The encoding of the source files.

  17. def ensuring(cond: (Javadoc) ⇒ Boolean, msg: ⇒ Any): Javadoc

    Implicit information
    This member is added by an implicit conversion from Javadoc to Ensuring[Javadoc] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  18. def ensuring(cond: (Javadoc) ⇒ Boolean): Javadoc

    Implicit information
    This member is added by an implicit conversion from Javadoc to Ensuring[Javadoc] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  19. def ensuring(cond: Boolean, msg: ⇒ Any): Javadoc

    Implicit information
    This member is added by an implicit conversion from Javadoc to Ensuring[Javadoc] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  20. def ensuring(cond: Boolean): Javadoc

    Implicit information
    This member is added by an implicit conversion from Javadoc to Ensuring[Javadoc] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  21. final def eq(arg0: AnyRef): Boolean

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

    Definition Classes
    AnyRef → Any
  23. def execute: Unit

    Execute the Javadoc generator.

  24. def finalize(): Unit

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

    Run the generator in a separate process (if true).

  26. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from Javadoc to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  27. final def getClass(): Class[_]

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

    Definition Classes
    AnyRef → Any
  29. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  30. val javadocClassName: String

  31. var javadocClasspath: Seq[File]

    The classpath which contains the Javadoc generator and its dependencies.

    The classpath which contains the Javadoc generator and its dependencies. If not given, the environment variable JAVA_HOME will be checked, and if it points to a installed JDK, this one will be used.

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

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

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

    Definition Classes
    AnyRef
  35. var source: String

    Provide source compatibility with specified release.

  36. var sources: Seq[File]

    Source files.

  37. var srcDir: File

    A directory containing Java source files.

  38. var srcDirs: Seq[File]

    Multiple directories containing Java source files.

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

    Definition Classes
    AnyRef
  40. def toString(): String

    Definition Classes
    Javadoc → AnyRef → Any
  41. var verbose: Boolean

    Output messages about what the generator is doing.

  42. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  45. def [B](y: B): (Javadoc, B)

    Implicit information
    This member is added by an implicit conversion from Javadoc to ArrowAssoc[Javadoc] 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 Javadoc 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:
    (javadoc: StringAdd).self
    Definition Classes
    StringAdd
  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from Javadoc 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:
    (javadoc: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. def x: Javadoc

    Implicit information
    This member is added by an implicit conversion from Javadoc to ArrowAssoc[Javadoc] 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:
    (javadoc: ArrowAssoc[Javadoc]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: Javadoc

    Implicit information
    This member is added by an implicit conversion from Javadoc to Ensuring[Javadoc] 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:
    (javadoc: Ensuring[Javadoc]).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 Javadoc to StringAdd

Inherited by implicit conversion any2stringfmt from Javadoc to StringFormat

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

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

Ungrouped