laika-docs
1.1.0
API
Generated with
laika-docs/laika/laika.ast/Comment

Comment

laika.ast.Comment
case class Comment(content: String, options: Options) extends Block, TextContainer

A comment that may be omitted by renderers.

Attributes

Source
blocks.scala
Graph
Supertypes
trait Container[String]
trait Block
class Element
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Members list

Type members

Types

type Self = Comment

Attributes

Source
blocks.scala

Value members

Concrete methods

def withOptions(options: Options): Comment

Returns a new instance of this element with the specified options replacing the current value.

Returns a new instance of this element with the specified options replacing the current value.

Attributes

Source
blocks.scala

Inherited methods

def clearOptions: Self

Returns a new instance of this element with all options removed from it.

Returns a new instance of this element with all options removed from it.

Attributes

Inherited from:
Element
Source
base.scala
def hasId: Boolean

Indicates whether this element has an id assigned.

Indicates whether this element has an id assigned.

Attributes

Inherited from:
Element
Source
base.scala
def hasStyle(name: String): Boolean

Indicates whether this element has the specified style assigned.

Indicates whether this element has the specified style assigned.

Attributes

Inherited from:
Element
Source
base.scala
def mergeOptions(opt: Options): Self

Returns a new instance of this element with its options merged with the specified options.

Returns a new instance of this element with its options merged with the specified options.

Attributes

Inherited from:
Element
Source
base.scala
def modifyOptions(f: Options => Options): Self

Returns a new instance of this element with the new options obtained from applying the specified function to the existing value.

Returns a new instance of this element with the new options obtained from applying the specified function to the existing value.

Attributes

Inherited from:
Element
Source
base.scala
def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product
def withId(id: String): Self

Returns a new instance of this element with its id set to the specified value, overriding any existing value.

Returns a new instance of this element with its id set to the specified value, overriding any existing value.

Attributes

Inherited from:
Element
Source
base.scala
def withStyle(name: String): Self

Returns a new instance of this element with the specified style added to its existing styles.

Returns a new instance of this element with the specified style added to its existing styles.

Attributes

Inherited from:
Element
Source
base.scala
def withStyles(styles: Iterable[String]): Self

Returns a new instance of this element with the specified styles added to its existing styles.

Returns a new instance of this element with the specified styles added to its existing styles.

Attributes

Inherited from:
Element
Source
base.scala
def withStyles(style: String, styles: String*): Self

Returns a new instance of this element with the specified styles added to its existing styles.

Returns a new instance of this element with the specified styles added to its existing styles.

Attributes

Inherited from:
Element
Source
base.scala
def withoutId: Self

Returns a new instance of this element without its id.

Returns a new instance of this element without its id.

Attributes

Inherited from:
Element
Source
base.scala
Generated with