Packages

case class Doc(short: String, long: String = "", example: String = "") extends Annotation with StaticAnnotation with Product with Serializable

Annotation used for documentation.

short

a one line description for the overview table

long

in-depth documentation

Example:
  1. a short example for the overview table

Linear Supertypes
Serializable, Product, Equals, StaticAnnotation, Annotation, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Doc
  2. Serializable
  3. Product
  4. Equals
  5. StaticAnnotation
  6. Annotation
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Doc(short: String, long: String = "", example: String = "")

    short

    a one line description for the overview table

    long

    in-depth documentation

Value Members

  1. val example: String
  2. val long: String
  3. def productElementNames: Iterator[String]
    Definition Classes
    Product
  4. val short: String