scaladoc/dotty.tools.scaladoc.tasty.comments/Regexes

Regexes

object Regexes
class Object
trait Matchable
class Any
Regexes.type

Value members

Concrete methods

def htmlReplacement(mtch: Match): String

Maps a dangerous HTML tag to a safe wiki replacement, or an empty string if it cannot be salvaged.

Maps a dangerous HTML tag to a safe wiki replacement, or an empty string if it cannot be salvaged.

def javadocReplacement(mtch: Match): String

Maps a javadoc tag to a useful wiki replacement, or an empty string if it cannot be salvaged.

Maps a javadoc tag to a useful wiki replacement, or an empty string if it cannot be salvaged.

Concrete fields

val CleanCommentLine: Regex

The body of a line, dropping the (optional) start star-marker, one leading whitespace and all trailing whitespace

The body of a line, dropping the (optional) start star-marker, one leading whitespace and all trailing whitespace

val CodeBlockEndRegex: Regex

The end of a Scaladoc code block

The end of a Scaladoc code block

val CodeBlockStartRegex: Regex

The start of a Scaladoc code block

The start of a Scaladoc code block

val DangerousTags: Regex

Dangerous HTML tags that should be replaced by something safer, such as wiki syntax, or that should be dropped

Dangerous HTML tags that should be replaced by something safer, such as wiki syntax, or that should be dropped

val JavadocTags: Regex

Javadoc tags that should be replaced by something useful, such as wiki syntax, or that should be dropped.

Javadoc tags that should be replaced by something useful, such as wiki syntax, or that should be dropped.

val SafeTags: Regex

Safe HTML tags that can be kept.

Safe HTML tags that can be kept.

val SimpleTagRegex: Regex

A Scaladoc tag not linked to a symbol. Returns the name of the tag, and the rest of the line.

A Scaladoc tag not linked to a symbol. Returns the name of the tag, and the rest of the line.

val SingleTagRegex: Regex

A Scaladoc tag not linked to a symbol and not followed by text

A Scaladoc tag not linked to a symbol and not followed by text

val SymbolTagRegex: Regex

A Scaladoc tag linked to a symbol. Returns the name of the tag, the name of the symbol, and the rest of the line.

A Scaladoc tag linked to a symbol. Returns the name of the tag, the name of the symbol, and the rest of the line.