comment

Type Members

1. sealed abstract class Block extends AnyRef

   

   A block-level element of text, such as a paragraph or code block.

2. final case class Body(blocks: Seq[Block]) extends Product with Serializable

   

   A body of text.

   A body of text. A comment has a single body, which is composed of at least one block. Inside every body is exactly one summary (see scala.tools.nsc.doc.model.comment.Summary).

3. final case class Bold(text: Inline) extends Inline with Product with Serializable

   

4. final case class Chain(items: Seq[Inline]) extends Inline with Product with Serializable

   

5. sealed class CharReader extends AnyRef

   

6. final case class Code(data: String) extends Block with Product with Serializable

   

7. case class Comment(body: String, short: String, authors: List[String], see: List[String], result: Option[String], throws: Map[String, String], valueParams: Map[String, String], typeParams: Map[String, String], version: Option[String], since: Option[String], todo: List[String], deprecated: Option[String], note: List[String], example: List[String], constructor: Option[String], group: Option[String], groupDesc: Map[String, String], groupNames: Map[String, String], groupPrio: Map[String, String], hideImplicitConversions: List[String]) extends Product with Serializable

   

8. trait CommentCleaner extends AnyRef

   

9. trait CommentParser extends MemberLookup

   

10. final case class DefinitionList(items: SortedMap[Inline, Block]) extends Block with Product with Serializable

    

11. abstract class EntityLink extends Inline

    

12. final case class HorizontalRule() extends Block with Product with Serializable

    

13. final case class HtmlTag(data: String) extends Inline with Product with Serializable

    

14. sealed abstract class Inline extends AnyRef

    

    An section of text inside a block, possibly with formatting.

15. final case class Italic(text: Inline) extends Inline with Product with Serializable

    

16. final case class Link(target: String, title: Inline) extends Inline with Product with Serializable

    

17. sealed trait LinkTo extends AnyRef

    

18. final case class LinkToEntity(entity: Entity) extends LinkTo with Product with Serializable

    

    Linking directly to entities is not picklable because of cyclic references

19. final case class LinkToExternal(name: String, url: String) extends LinkTo with Product with Serializable

    

20. case class MarkdownComment(ent: Entity, parsed: ParsedComment, pos: Position) extends MarkupConversion[Node] with Product with Serializable

    

21. class MarkdownShortener extends AnyRef

    

    The MarkdownShortener takes a node and *mutates* it and all children so that the displayed length of the generated HTML doesn't exceeed maxLen.

    The MarkdownShortener takes a node and *mutates* it and all children so that the displayed length of the generated HTML doesn't exceeed maxLen. This number defaults to 150 characters.

    Note

    calling shorten **will** mutate the Markdown AST node.

22. trait MarkupConversion[T] extends MemberLookup

    

23. final case class Monospace(text: Inline) extends Inline with Product with Serializable

    

24. final case class OrderedList(items: Seq[Block], style: String) extends Block with Product with Serializable

    

25. final case class Paragraph(text: Inline) extends Block with Product with Serializable

    

26. final case class Subscript(text: Inline) extends Inline with Product with Serializable

    

27. final case class Summary(text: Inline) extends Inline with Product with Serializable

    

    The summary of a comment, usually its first sentence.

    The summary of a comment, usually its first sentence. There must be exactly one summary per body.

28. final case class Superscript(text: Inline) extends Inline with Product with Serializable

    

29. final case class Text(text: String) extends Inline with Product with Serializable

    

30. final case class Title(text: Inline, level: Int) extends Block with Product with Serializable

    

31. final case class Tooltip(name: String) extends LinkTo with Product with Serializable

    

32. final case class Underline(text: Inline) extends Inline with Product with Serializable

    

33. final case class UnorderedList(items: Seq[Block]) extends Block with Product with Serializable

    

34. case class WikiComment(ent: Entity, parsed: ParsedComment, pos: Position) extends MarkupConversion[Body] with Product with Serializable