Docstrings
object Docstrings
Value members
Concrete methods
Expands or cooks the documentation for sym
in class owner
.
The expanded comment will directly replace the original comment in the doc context.
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.
- Value parameters:
- owner
The class for which comments are being cooked.
- sym
The symbol for which the comment is being cooked.