dotty.tools.dottydoc.staticsite.tags

Docstring

Related Doc: package tags

case class Docstring(params: Map[String, AnyRef]) extends Tag with Product with Serializable

Allows the extraction of docstrings from the given path. E.g:

html {% docstring "scala.collection.Seq" %}

In Scaladoc, objects are denoted by a name ending in '$'. This means that a path that goes through, or targets an object need to appropriately intersperse these, e.g:

html {% docstring "scala.collection.Seq$" %}

Linear Supertypes
Serializable, Serializable, Product, Equals, Tag, LValue, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Docstring
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. Tag
  7. LValue
  8. AnyRef
  9. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Docstring(params: Map[String, AnyRef])

Abstract Value Members

  1. abstract def render(arg0: TemplateContext, arg1: <repeated...>[LNode]): AnyRef

    Definition Classes
    Tag

Concrete 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. def asArray(arg0: Any): Array[AnyRef]

    Definition Classes
    LValue

  5. def asBoolean(arg0: Any): Boolean

    Definition Classes
    LValue

  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  7. def asNumber(arg0: Any): Number

    Definition Classes
    LValue
    Annotations
    @throws( ... )

  8. def asString(arg0: Any): String

    Definition Classes
    LValue

  9. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  10. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  11. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  12. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  13. def isArray(arg0: Any): Boolean

    Definition Classes
    LValue

  14. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  15. def isInteger(arg0: Any): Boolean

    Definition Classes
    LValue

  16. def isNumber(arg0: Any): Boolean

    Definition Classes
    LValue

  17. def isString(arg0: Any): Boolean

    Definition Classes
    LValue

  18. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  19. final def notify(): Unit

    Definition Classes
    AnyRef

  20. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  21. val params: Map[String, AnyRef]

  22. def render(ctx: TemplateContext, nodes: LNode*): AnyRef

  23. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef

  24. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  25. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  26. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Tag

Inherited from LValue

Inherited from AnyRef

Inherited from Any

Ungrouped