case class Docstrings(oneline: Oneline = Docstrings.Oneline.keep, removeEmpty: Boolean = false, wrap: Wrap = Docstrings.Wrap.yes, wrapMaxColumn: Option[Int] = None, forceBlankLineBefore: Option[Boolean] = 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
Ordering
- Alphabetic
- By Inheritance
Inherited
- Docstrings
- Serializable
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
Visibility
- Public
- All
Instance Constructors
-
new
Docstrings(oneline: Oneline = Docstrings.Oneline.keep, removeEmpty: Boolean = false, wrap: Wrap = Docstrings.Wrap.yes, wrapMaxColumn: Option[Int] = None, forceBlankLineBefore: Option[Boolean] = 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
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
- val blankFirstLine: BlankFirstLine
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
- val forceBlankLineBefore: Option[Boolean]
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- val oneline: Oneline
- val removeEmpty: Boolean
- def skipFirstLineIf(wasBlank: Boolean): Boolean
- val style: Style
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
- def validate(implicit errors: Buffer[String]): Unit
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
- val wrap: Wrap