TODO
A comment is usualy created by the parser, however for some special
cases we have to give some inTpl
comments (parent class for example)
to the comment of the symbol.
A comment is usualy created by the parser, however for some special
cases we have to give some inTpl
comments (parent class for example)
to the comment of the symbol.
This function manages some of those cases : Param accessor and Primary constructor
Parses a raw comment string into a Comment
object.
Parses a raw comment string into a Comment
object.
The expanded comment string (including start and end markers) to be parsed.
The raw comment source string.
The position of the comment in source.
Parses a string containing wiki syntax into a Comment
object.
Parses a string containing wiki syntax into a Comment
object.
Note that the string is assumed to be clean:
endOfLine
is used to mark line endings.Parses a string containing wiki syntax into a Comment
object.
Parses a string containing wiki syntax into a Comment
object.
Note that the string is assumed to be clean:
endOfLine
is used to mark line endings.(commentFactory: StringAdd).self
(commentFactory: StringFormat).self
(commentFactory: ArrowAssoc[CommentFactory]).x
(Since version 2.10.0) Use leftOfArrow
instead
(commentFactory: Ensuring[CommentFactory]).x
(Since version 2.10.0) Use resultOfEnsuring
instead
The comment parser transforms raw comment strings into
Comment
objects. Callparse
to run the parser. Note that the parser is stateless and should only be built once for a given Scaladoc run.