scala.tools.nsc.doc.model.diagram.DiagramDirectiveParser

DiagramFilter

trait DiagramFilter extends AnyRef

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

Vlad: There's an explanation I owe to people using diagrams and not finding a way to hide a specific class from all diagrams at once. So why did I choose to allow you to only control the diagrams at class level? So, the reason is you would break the separate scaladoc compilation: If you have an "@diagram hideMyClass" annotation in class A and you run scaladoc on it along with its subclass B A will not appear in B's diagram. But if you scaladoc only on B, A's comment will not be parsed and the instructions to hide class A from all diagrams will not be available. Thus I prefer to force you to control the diagrams of each class locally. The problem does not appear with scalac, as scalac stores all its necessary information (like scala signatures) serialized in the .class file. But we couldn't store doc comments in the class file, could we? (Turns out we could, but that's another story)

Any flaming for this decision should go to [email protected]

Source
DiagramDirectiveParser.scala
Linear Supertypes
AnyRef, Any
Known Subclasses
AnnotationDiagramFilter, FullDiagram, NoDiagramAtAll
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. DiagramFilter
  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

Abstract Value Members

  1. abstract def hideDiagram: Boolean

    A flag to hide the diagram completely

  2. abstract def hideEdge(clazz1: Node, clazz2: Node): Boolean

    Hide an edge from the diagram

  3. abstract def hideIncomingImplicits: Boolean

    Hide incoming implicit conversions (for type hierarchy diagrams)

  4. abstract def hideInheritedNodes: Boolean

    Show related classes from other objects/traits/packages (for content diagrams)

  5. abstract def hideNode(clazz: Node): Boolean

    Hide a node from the diagram

  6. abstract def hideOutgoingImplicits: Boolean

    Hide outgoing implicit conversions (for type hierarchy diagrams)

  7. abstract def hideSubclasses: Boolean

    Hide subclasses (for type hierarchy diagrams)

  8. abstract def hideSuperclasses: Boolean

    Hide superclasses (for type hierarchy diagrams)

Concrete 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.this)#DiagramFilter to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd

  5. def ->[B](y: B): ((DiagramDirectiveParser.this)#DiagramFilter, B)

    Implicit information
    This member is added by an implicit conversion from (DiagramDirectiveParser.this)#DiagramFilter to ArrowAssoc[(DiagramDirectiveParser.this)#DiagramFilter] 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. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  9. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()

  10. def ensuring(cond: ((DiagramDirectiveParser.this)#DiagramFilter) ⇒ Boolean, msg: ⇒ Any): (DiagramDirectiveParser.this)#DiagramFilter

    Implicit information
    This member is added by an implicit conversion from (DiagramDirectiveParser.this)#DiagramFilter to Ensuring[(DiagramDirectiveParser.this)#DiagramFilter] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  11. def ensuring(cond: ((DiagramDirectiveParser.this)#DiagramFilter) ⇒ Boolean): (DiagramDirectiveParser.this)#DiagramFilter

    Implicit information
    This member is added by an implicit conversion from (DiagramDirectiveParser.this)#DiagramFilter to Ensuring[(DiagramDirectiveParser.this)#DiagramFilter] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  12. def ensuring(cond: Boolean, msg: ⇒ Any): (DiagramDirectiveParser.this)#DiagramFilter

    Implicit information
    This member is added by an implicit conversion from (DiagramDirectiveParser.this)#DiagramFilter to Ensuring[(DiagramDirectiveParser.this)#DiagramFilter] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  13. def ensuring(cond: Boolean): (DiagramDirectiveParser.this)#DiagramFilter

    Implicit information
    This member is added by an implicit conversion from (DiagramDirectiveParser.this)#DiagramFilter to Ensuring[(DiagramDirectiveParser.this)#DiagramFilter] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  14. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  15. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  16. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()

  17. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from (DiagramDirectiveParser.this)#DiagramFilter to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()

  18. final def getClass(): java.lang.Class[_]

    Definition Classes
    AnyRef → Any

  19. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  20. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

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

    Definition Classes
    AnyRef

  22. final def notify(): Unit

    Definition Classes
    AnyRef

  23. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  24. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef

  25. def toString(): String

    Definition Classes
    AnyRef → Any

  26. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()

  27. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()

  28. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()

  29. def →[B](y: B): ((DiagramDirectiveParser.this)#DiagramFilter, B)

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

Shadowed Implict Value Members

  1. val self: Any

    Implicit information
    This member is added by an implicit conversion from (DiagramDirectiveParser.this)#DiagramFilter 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:
    (diagramFilter: StringAdd).self
    Definition Classes
    StringAdd

  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from (DiagramDirectiveParser.this)#DiagramFilter 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:
    (diagramFilter: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. def x: (DiagramDirectiveParser.this)#DiagramFilter

    Implicit information
    This member is added by an implicit conversion from (DiagramDirectiveParser.this)#DiagramFilter to ArrowAssoc[(DiagramDirectiveParser.this)#DiagramFilter] 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:
    (diagramFilter: ArrowAssoc[(DiagramDirectiveParser.this)#DiagramFilter]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: (DiagramDirectiveParser.this)#DiagramFilter

    Implicit information
    This member is added by an implicit conversion from (DiagramDirectiveParser.this)#DiagramFilter to Ensuring[(DiagramDirectiveParser.this)#DiagramFilter] 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:
    (diagramFilter: Ensuring[(DiagramDirectiveParser.this)#DiagramFilter]).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.this)#DiagramFilter to StringAdd

Inherited by implicit conversion any2stringfmt from (DiagramDirectiveParser.this)#DiagramFilter to StringFormat

Inherited by implicit conversion any2ArrowAssoc from (DiagramDirectiveParser.this)#DiagramFilter to ArrowAssoc[(DiagramDirectiveParser.this)#DiagramFilter]

Inherited by implicit conversion any2Ensuring from (DiagramDirectiveParser.this)#DiagramFilter to Ensuring[(DiagramDirectiveParser.this)#DiagramFilter]

Ungrouped