c

com.fulcrumgenomics.internal

FgMetricsDoclet

class FgMetricsDoclet extends Doclet

Custom scaladoc Doclet for rendering the documentation for Metric classes into MarkDown for display on the fgbio website.

Linear Supertypes
Doclet, Universer, Generator, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FgMetricsDoclet
  2. Doclet
  3. Universer
  4. Generator
  5. AnyRef
  6. 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 FgMetricsDoclet()

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from FgMetricsDoclet to any2stringadd[FgMetricsDoclet] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (FgMetricsDoclet, B)
    Implicit
    This member is added by an implicit conversion from FgMetricsDoclet to ArrowAssoc[FgMetricsDoclet] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. val checks: Set[() ⇒ Boolean]
    Attributes
    protected
    Definition Classes
    Generator
  8. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  9. def ensuring(cond: (FgMetricsDoclet) ⇒ Boolean, msg: ⇒ Any): FgMetricsDoclet
    Implicit
    This member is added by an implicit conversion from FgMetricsDoclet to Ensuring[FgMetricsDoclet] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: (FgMetricsDoclet) ⇒ Boolean): FgMetricsDoclet
    Implicit
    This member is added by an implicit conversion from FgMetricsDoclet to Ensuring[FgMetricsDoclet] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean, msg: ⇒ Any): FgMetricsDoclet
    Implicit
    This member is added by an implicit conversion from FgMetricsDoclet to Ensuring[FgMetricsDoclet] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean): FgMetricsDoclet
    Implicit
    This member is added by an implicit conversion from FgMetricsDoclet to Ensuring[FgMetricsDoclet] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  15. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  16. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from FgMetricsDoclet to StringFormat[FgMetricsDoclet] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  17. def generate(): Unit
    Definition Classes
    Generator
  18. def generateImpl(): Unit

    Main entry point for the doclet.

    Main entry point for the doclet. Scans for documentation for the metrics classes and renders it into MarkDown.

    Definition Classes
    FgMetricsDoclet → Doclet → Generator
  19. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  20. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  21. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  22. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  23. final def notify(): Unit
    Definition Classes
    AnyRef
  24. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  25. def setUniverse(u: Universe): Unit
    Definition Classes
    Universer
  26. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  27. def toString(): String
    Definition Classes
    AnyRef → Any
  28. def universe: Universe
    Definition Classes
    Universer
  29. val universeField: Universe
    Attributes
    protected
    Definition Classes
    Universer
  30. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  31. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  32. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  33. def →[B](y: B): (FgMetricsDoclet, B)
    Implicit
    This member is added by an implicit conversion from FgMetricsDoclet to ArrowAssoc[FgMetricsDoclet] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from Doclet

Inherited from Universer

Inherited from Generator

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from FgMetricsDoclet to any2stringadd[FgMetricsDoclet]

Inherited by implicit conversion StringFormat from FgMetricsDoclet to StringFormat[FgMetricsDoclet]

Inherited by implicit conversion Ensuring from FgMetricsDoclet to Ensuring[FgMetricsDoclet]

Inherited by implicit conversion ArrowAssoc from FgMetricsDoclet to ArrowAssoc[FgMetricsDoclet]

Ungrouped