Dotty Documentation

0.11.0-bin-SNAPSHOT

object Docstrings
extends Object

[-] Constructors

[-] Members

[+] def cookComment ( sym: Symbol , owner: Symbol ) ( implicit ctx: Context ) : Option [ Comment ]

Expands or cooks the documentation for sym in class owner. The expanded comment will directly replace the original comment in the doc context.

The expansion registers @define sections, and will replace <invalid inheritdoc annotation> and variable occurrences in the comments.

If the doc comments contain @usecase sections, they will be typed.

[+] private def expand ( sym: Symbol , owner: Symbol ) ( implicit ctx: Context , docCtx: ContextDocstrings ) : Option [ Comment ]
[+] private def expandComment ( sym: Symbol , owner: Symbol , comment: Comment ) ( implicit ctx: Context , docCtx: ContextDocstrings ) : Comment
[+] private def expandComment ( sym: Symbol ) ( implicit ctx: Context , docCtx: ContextDocstrings ) : Option [ Comment ]