Cleaner

dotty.tools.scaladoc.tasty.comments.Cleaner
object Cleaner

Removes HTML tags except simple ones that can be translated or that are definitely harmless, translates Scala/Javadoc tags, and generally cleans the input. Not the fastest code in the world, and should eventually be replaced by a real parser, but works fine for now.

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Self type
Cleaner.type

Members list

Value members

Concrete methods

def clean(comment: String): List[String]

Prepares the comment for pre-parsing: removes documentation markers and extra whitespace, removes dangerous HTML and Javadoc tags, and splits it into lines.

Prepares the comment for pre-parsing: removes documentation markers and extra whitespace, removes dangerous HTML and Javadoc tags, and splits it into lines.

Attributes