Dotty Documentation

0.14.0-bin-SNAPSHOT

case class Docstring
extends Tag with Product with Serializable

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

{% 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:

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

[-] Constructors

Docstring ( params: Map [ String, AnyRef ] )

[-] Members

[+] val params : Map [ String, AnyRef ]
[+] private def find ( xs: List [ String ] , ent: Entity & Members ) : Option [ Entity ]
[+] override def render ( ctx: TemplateContext , nodes: [ LNode ] ) : AnyRef