CommentParsing
The comment parsing in dotc is used by both the comment cooking and the
dottydoc tool.
The comment cooking is used to expand comments with <invalid inheritdoc annotation> and
@define annotations. The rest of the comment is untouched and later
handled by dottydoc.
Value members
Concrete methods
Extract the section tag, treating the section tag as an identifier
Extract the section tag, treating the section tag as an identifier
Extract the section text, except for the tag and comment newlines
Extract the section text, except for the tag and comment newlines
Return first index following start and starting a line (i.e. after skipLineLead)
which satisfies predicate p.
Return first index following start and starting a line (i.e. after skipLineLead)
which satisfies predicate p.
Returns first index following start and starting a line (i.e. after skipLineLead) or starting the comment
which satisfies predicate p.
Returns first index following start and starting a line (i.e. after skipLineLead) or starting the comment
which satisfies predicate p.
Optionally start and end index of return section in str, or None
if str does not have a @group.
Optionally start and end index of return section in str, or None
if str does not have a @group.
A map from tag name to all boundaries for this tag
A map from tag name to all boundaries for this tag
Merge the inheritdoc sections, as they never make sense on their own
Merge the inheritdoc sections, as they never make sense on their own
Merge sections following an usecase into the usecase comment, so they can override the parent symbol's sections
Merge sections following an usecase into the usecase comment, so they can override the parent symbol's sections
A map from parameter names to start/end indices describing all parameter
sections in str tagged with tag, where sections is the index of str.
A map from parameter names to start/end indices describing all parameter
sections in str tagged with tag, where sections is the index of str.
Optionally start and end index of return section in str, or None
if str does not have a @return.
Optionally start and end index of return section in str, or None
if str does not have a @return.
Returns index of string str following start skipping
sequence of identifier characters.
Returns index of string str following start skipping
sequence of identifier characters.
Returns index of string str after start skipping longest
sequence of space and tab characters, possibly also containing
a single * character or the /``** sequence.
Returns index of string str after start skipping longest
sequence of space and tab characters, possibly also containing
a single * character or the /``** sequence.
Returns index of string str following start skipping
sequence of identifier characters.
Returns index of string str following start skipping
sequence of identifier characters.
Skips to next occurrence of \n or to the position after the /``** sequence following index start.
Skips to next occurrence of \n or to the position after the /``** sequence following index start.
Returns index following variable, or start index if no variable was recognized
Returns index following variable, or start index if no variable was recognized
Returns index of string str following start skipping longest
sequence of whitespace characters characters (but no newlines)
Returns index of string str following start skipping longest
sequence of whitespace characters characters (but no newlines)
The first start tag of a list of tag intervals, or the end of the whole comment string - 2 if list is empty
The first start tag of a list of tag intervals, or the end of the whole comment string - 2 if list is empty
Produces a string index, which is a list of sections, i.e
pairs of start/end positions of all tagged sections in the string.
Every section starts with an at sign and extends to the next at sign,
or to the end of the comment string, but excluding the final two
characters which terminate the comment.
Produces a string index, which is a list of sections, i.e
pairs of start/end positions of all tagged sections in the string.
Every section starts with an at sign and extends to the next at sign,
or to the end of the comment string, but excluding the final two
characters which terminate the comment.
Also take usecases into account - they need to expand until the next usecase or the end of the string, as they might include other sections of their own