Dotty Documentation

0.2.0-bin-SNAPSHOT

object 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.

[-] Constructors

[-] Members

[+] def cleanupSectionText ( str: String ) : String

Cleanup section text

[+] def extractSectionParam ( str: String , section: ( Int, Int ) ) : String

Extract the section parameter

[+] def extractSectionTag ( str: String , section: ( Int, Int ) ) : String

Extract the section tag, treating the section tag as an identifier

[+] def extractSectionText ( str: String , section: ( Int, Int ) ) : ( Int, Int )

Extract the section text, except for the tag and comment newlines

[+] def findAll ( str: String , start: Int ) ( p: Int => Boolean ) : List [ Int ]

Return first index following start and starting a line (i.e. after skipLineLead) which satisfies predicate p.

[+] def findNext ( str: String , start: Int ) ( p: Int => Boolean ) : Int

Returns first index following start and starting a line (i.e. after skipLineLead) or starting the comment which satisfies predicate p.

[+] def groupDoc ( str: String , sections: List [ ( Int, Int ) ] ) : Option [ ( Int, Int ) ]

Optionally start and end index of return section in str, or None if str does not have a @group.

[+] def mergeInheritdocSections ( str: String , idxs: List [ Int ] ) : List [ Int ]

Merge the inheritdoc sections, as they never make sense on their own

[+] def mergeUsecaseSections ( str: String , idxs: List [ Int ] ) : List [ Int ]

Merge sections following an usecase into the usecase comment, so they can override the parent symbol's sections

[+] def paramDocs ( str: String , tag: String , sections: List [ ( Int, Int ) ] ) : Map [ String, ( Int, Int ) ]

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.

[+] def removeSections ( raw: String , xs: [ String ] ) : String
[+] def returnDoc ( str: String , sections: List [ ( Int, Int ) ] ) : Option [ ( Int, Int ) ]

Optionally start and end index of return section in str, or None if str does not have a @return.

[+] def sectionTagMap ( str: String , sections: List [ ( Int, Int ) ] ) : Map [ String, ( Int, Int ) ]

A map from the section tag to section parameters

[+] def skipIdent ( str: String , start: Int ) : Int

Returns index of string str following start skipping sequence of identifier characters.

[+] def skipLineLead ( str: String , start: Int ) : Int

Returns index of string str after start skipping longest sequence of space and tab characters, possibly also containing a single * character or the /``** sequence.

[+] def skipTag ( str: String , start: Int ) : Int

Returns index of string str following start skipping sequence of identifier characters.

[+] def skipToEol ( str: String , start: Int ) : Int

Skips to next occurrence of \n or to the position after the /``** sequence following index start.

[+] def skipVariable ( str: String , start: Int ) : Int

Returns index following variable, or start index if no variable was recognized

[+] def skipWhitespace ( str: String , start: Int ) : Int

Returns index of string str following start skipping longest sequence of whitespace characters characters (but no newlines)

[+] def startTag ( str: String , sections: List [ ( Int, Int ) ] ) : Int

The first start tag of a list of tag intervals, or the end of the whole comment string - 2 if list is empty

[+] def startsWithTag ( str: String , section: ( Int, Int ) , tag: String ) : Boolean

Does interval iv start with given tag?

[+] def startsWithTag ( str: String , start: Int , tag: String ) : Boolean
[+] def tagIndex ( str: String , p: Int => Boolean ) : List [ ( Int, Int ) ]

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

[+] def variableName ( str: String ) : String

Extracts variable name from a string, stripping any pair of surrounding braces