Packages

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
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DiagramFilter
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

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: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from (DiagramDirectiveParser.this)#DiagramFilter toany2stringadd[(DiagramDirectiveParser.this)#DiagramFilter] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): ((DiagramDirectiveParser.this)#DiagramFilter, B)
    Implicit
    This member is added by an implicit conversion from (DiagramDirectiveParser.this)#DiagramFilter toArrowAssoc[(DiagramDirectiveParser.this)#DiagramFilter] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  8. def ensuring(cond: ((DiagramDirectiveParser.this)#DiagramFilter) => Boolean, msg: => Any): (DiagramDirectiveParser.this)#DiagramFilter
    Implicit
    This member is added by an implicit conversion from (DiagramDirectiveParser.this)#DiagramFilter toEnsuring[(DiagramDirectiveParser.this)#DiagramFilter] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: ((DiagramDirectiveParser.this)#DiagramFilter) => Boolean): (DiagramDirectiveParser.this)#DiagramFilter
    Implicit
    This member is added by an implicit conversion from (DiagramDirectiveParser.this)#DiagramFilter toEnsuring[(DiagramDirectiveParser.this)#DiagramFilter] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: => Any): (DiagramDirectiveParser.this)#DiagramFilter
    Implicit
    This member is added by an implicit conversion from (DiagramDirectiveParser.this)#DiagramFilter toEnsuring[(DiagramDirectiveParser.this)#DiagramFilter] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): (DiagramDirectiveParser.this)#DiagramFilter
    Implicit
    This member is added by an implicit conversion from (DiagramDirectiveParser.this)#DiagramFilter toEnsuring[(DiagramDirectiveParser.this)#DiagramFilter] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  14. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  15. final def getClass(): java.lang.Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  16. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  22. def toString(): String
    Definition Classes
    AnyRef → Any
  23. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  24. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  25. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

  1. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from (DiagramDirectiveParser.this)#DiagramFilter toStringFormat[(DiagramDirectiveParser.this)#DiagramFilter] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  2. def →[B](y: B): ((DiagramDirectiveParser.this)#DiagramFilter, B)
    Implicit
    This member is added by an implicit conversion from (DiagramDirectiveParser.this)#DiagramFilter toArrowAssoc[(DiagramDirectiveParser.this)#DiagramFilter] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from AnyRef

Inherited from Any

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

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

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

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

Ungrouped