com.alecdorrington.cadmus

Members list

Type members

Classlikes

object Scaladoc

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Scaladoc.type
final case class Scaladoc(description: Option[String] = ..., params: Map[String, String] = ..., typeParams: Map[String, String] = ..., returns: Option[String] = ..., tags: List[Tag] = ...)

A Scaladoc comment, read into its parts: the description, the tags naming a parameter, type parameter or result, and every other tag. Each part's text is kept as written, markup and all, with only the comment's delimiters, the margin of each line and the indentation its lines share taken away. Every text is non-blank, but for that of a tag in tags. plain renders them as plain text.

A Scaladoc comment, read into its parts: the description, the tags naming a parameter, type parameter or result, and every other tag. Each part's text is kept as written, markup and all, with only the comment's delimiters, the margin of each line and the indentation its lines share taken away. Every text is non-blank, but for that of a tag in tags. plain renders them as plain text.

Scaladoc.of reads the comment of a type, and Scaladoc.ofMember that of one of its members, at compile time:

Scaladoc.of[Person].flatMap(_.params.get("name"))

Value parameters

description

The description, before the first tag, if there is one.

params

What each @param tag says of a parameter, by the parameter's name.

returns

What the @return tag says of the result, if there is one.

tags

Every other tag, in the order written, including any repeating a parameter's or the result's, and any saying nothing of one.

typeParams

What each @tparam tag says of a type parameter, by its name.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all