case class Docstrings(oneline: Oneline = Docstrings.Oneline.keep, wrap: Wrap = Docstrings.Wrap.yes, wrapMaxColumn: Option[Int] = None, blankFirstLine: BlankFirstLine = Docstrings.BlankFirstLine.no, style: Style = Docstrings.SpaceAsterisk) extends Product with Serializable

oneline

  • if fold, try to fold short docstrings into a single line
  • if unfold, unfold a single-line docstring into multiple lines
  • if keep, preserve the current formatting
wrap

if yes, allow reformatting/rewrapping the contents of the docstring

style

  • Asterisk: format intermediate lines with an asterisk below the first asterisk of the first line (aka JavaDoc)
  • SpaceAsterisk: format intermediate lines with a space and an asterisk, both below the two asterisks of the first line
  • AsteriskSpace: format intermediate lines with an asterisk and a space, both below the two asterisks of the first line
Linear Supertypes
Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Docstrings
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Docstrings(oneline: Oneline = Docstrings.Oneline.keep, wrap: Wrap = Docstrings.Wrap.yes, wrapMaxColumn: Option[Int] = None, blankFirstLine: BlankFirstLine = Docstrings.BlankFirstLine.no, style: Style = Docstrings.SpaceAsterisk)

    oneline

    • if fold, try to fold short docstrings into a single line
    • if unfold, unfold a single-line docstring into multiple lines
    • if keep, preserve the current formatting
    wrap

    if yes, allow reformatting/rewrapping the contents of the docstring

    style

    • Asterisk: format intermediate lines with an asterisk below the first asterisk of the first line (aka JavaDoc)
    • SpaceAsterisk: format intermediate lines with a space and an asterisk, both below the two asterisks of the first line
    • AsteriskSpace: format intermediate lines with an asterisk and a space, both below the two asterisks of the first line

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. val blankFirstLine: BlankFirstLine
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  14. val oneline: Oneline
  15. def productElementNames: Iterator[String]
    Definition Classes
    Product
  16. def skipFirstLineIf(wasBlank: Boolean): Boolean
  17. val style: Style
  18. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  19. def validate(implicit errors: Buffer[String]): Unit
  20. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  21. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  22. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  23. val wrap: Wrap

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped