scala.tools.nsc.doc.model.diagram

DiagramDirectiveParser

trait DiagramDirectiveParser extends AnyRef

This trait takes care of parsing @{inheritance, content}Diagram annotations

Self Type
ModelFactory with DiagramFactory with CommentFactory with TreeFactory
Linear Supertypes
AnyRef, Any
Known Subclasses
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. DiagramDirectiveParser
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by any2stringfmt
  3. by any2ArrowAssoc
  4. by any2Ensuring
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. case class AnnotationDiagramFilter(hideDiagram: Boolean, hideIncomingImplicits: Boolean, hideOutgoingImplicits: Boolean, hideSuperclasses: Boolean, hideSubclasses: Boolean, hideInheritedNodes: Boolean, hideNodesFilter: List[Pattern], hideEdgesFilter: List[(Pattern, Pattern)]) extends (DiagramDirectiveParser.this)#DiagramFilter with Product with Serializable

    The AnnotationDiagramFilter trait directs the diagram engine according to an annotation TODO: Should document the annotation, for now see parseDiagramAnnotation in ModelFactory.

  2. trait DiagramFilter extends AnyRef

    The DiagramFilter trait directs the diagram engine about the way the diagram should be displayed

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. def +(other: String): String

    Implicit information
    This member is added by an implicit conversion from DiagramDirectiveParser to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd
  5. def ->[B](y: B): (DiagramDirectiveParser, B)

    Implicit information
    This member is added by an implicit conversion from DiagramDirectiveParser to ArrowAssoc[DiagramDirectiveParser] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  6. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  7. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  8. object FullDiagram extends (DiagramDirectiveParser.this)#DiagramFilter with Product with Serializable

    Show the entire diagram, no filtering

  9. object NoDiagramAtAll extends (DiagramDirectiveParser.this)#DiagramFilter with Product with Serializable

    Hide the diagram completely, no need for special filtering

  10. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  11. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  12. def ensuring(cond: (DiagramDirectiveParser) ⇒ Boolean, msg: ⇒ Any): DiagramDirectiveParser

    Implicit information
    This member is added by an implicit conversion from DiagramDirectiveParser to Ensuring[DiagramDirectiveParser] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: (DiagramDirectiveParser) ⇒ Boolean): DiagramDirectiveParser

    Implicit information
    This member is added by an implicit conversion from DiagramDirectiveParser to Ensuring[DiagramDirectiveParser] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean, msg: ⇒ Any): DiagramDirectiveParser

    Implicit information
    This member is added by an implicit conversion from DiagramDirectiveParser to Ensuring[DiagramDirectiveParser] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: Boolean): DiagramDirectiveParser

    Implicit information
    This member is added by an implicit conversion from DiagramDirectiveParser to Ensuring[DiagramDirectiveParser] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  17. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  18. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  19. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from DiagramDirectiveParser to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  20. final def getClass(): java.lang.Class[_]

    Definition Classes
    AnyRef → Any
  21. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  22. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  23. def makeContentDiagramFilter(template: (DiagramDirectiveParser.this)#DocTemplateImpl): (DiagramDirectiveParser.this)#DiagramFilter

    Main entry point into this trait: generate the filter for content diagrams

  24. def makeInheritanceDiagramFilter(template: (DiagramDirectiveParser.this)#DocTemplateImpl): (DiagramDirectiveParser.this)#DiagramFilter

    Main entry point into this trait: generate the filter for inheritance diagrams

  25. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  26. final def notify(): Unit

    Definition Classes
    AnyRef
  27. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  28. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  29. var tFilter: Long

    Attributes
    protected
  30. var tModel: Long

    Attributes
    protected
  31. def toString(): String

    Definition Classes
    AnyRef → Any
  32. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  33. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  34. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  35. def [B](y: B): (DiagramDirectiveParser, B)

    Implicit information
    This member is added by an implicit conversion from DiagramDirectiveParser to ArrowAssoc[DiagramDirectiveParser] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Shadowed Implicit Value Members

  1. val self: Any

    Implicit information
    This member is added by an implicit conversion from DiagramDirectiveParser to StringAdd performed by method any2stringadd in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (diagramDirectiveParser: StringAdd).self
    Definition Classes
    StringAdd
  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from DiagramDirectiveParser to StringFormat performed by method any2stringfmt in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (diagramDirectiveParser: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. def x: DiagramDirectiveParser

    Implicit information
    This member is added by an implicit conversion from DiagramDirectiveParser to ArrowAssoc[DiagramDirectiveParser] performed by method any2ArrowAssoc in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (diagramDirectiveParser: ArrowAssoc[DiagramDirectiveParser]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: DiagramDirectiveParser

    Implicit information
    This member is added by an implicit conversion from DiagramDirectiveParser to Ensuring[DiagramDirectiveParser] performed by method any2Ensuring in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (diagramDirectiveParser: Ensuring[DiagramDirectiveParser]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from DiagramDirectiveParser to StringAdd

Inherited by implicit conversion any2stringfmt from DiagramDirectiveParser to StringFormat

Inherited by implicit conversion any2ArrowAssoc from DiagramDirectiveParser to ArrowAssoc[DiagramDirectiveParser]

Inherited by implicit conversion any2Ensuring from DiagramDirectiveParser to Ensuring[DiagramDirectiveParser]

Ungrouped