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 scala-internals@googlegroups.com
- Alphabetic
- By Inheritance
- DiagramFilter
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Abstract Value Members
-
abstract
def
hideDiagram: Boolean
A flag to hide the diagram completely
-
abstract
def
hideEdge(clazz1: Node, clazz2: Node): Boolean
Hide an edge from the diagram
-
abstract
def
hideIncomingImplicits: Boolean
Hide incoming implicit conversions (for type hierarchy diagrams)
-
abstract
def
hideInheritedNodes: Boolean
Show related classes from other objects/traits/packages (for content diagrams)
-
abstract
def
hideNode(clazz: Node): Boolean
Hide a node from the diagram
-
abstract
def
hideOutgoingImplicits: Boolean
Hide outgoing implicit conversions (for type hierarchy diagrams)
-
abstract
def
hideSubclasses: Boolean
Hide subclasses (for type hierarchy diagrams)
-
abstract
def
hideSuperclasses: Boolean
Hide superclasses (for type hierarchy diagrams)
Concrete Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
def
+(other: String): String
- Implicit
- This member is added by an implicit conversion from (DiagramDirectiveParser.this)#DiagramFilter to any2stringadd[(DiagramDirectiveParser.this)#DiagramFilter] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
-
def
->[B](y: B): ((DiagramDirectiveParser.this)#DiagramFilter, B)
- Implicit
- This member is added by an implicit conversion from (DiagramDirectiveParser.this)#DiagramFilter to ArrowAssoc[(DiagramDirectiveParser.this)#DiagramFilter] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
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 to Ensuring[(DiagramDirectiveParser.this)#DiagramFilter] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: ((DiagramDirectiveParser.this)#DiagramFilter) ⇒ Boolean): (DiagramDirectiveParser.this)#DiagramFilter
- Implicit
- This member is added by an implicit conversion from (DiagramDirectiveParser.this)#DiagramFilter to Ensuring[(DiagramDirectiveParser.this)#DiagramFilter] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean, msg: ⇒ Any): (DiagramDirectiveParser.this)#DiagramFilter
- Implicit
- This member is added by an implicit conversion from (DiagramDirectiveParser.this)#DiagramFilter to Ensuring[(DiagramDirectiveParser.this)#DiagramFilter] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean): (DiagramDirectiveParser.this)#DiagramFilter
- Implicit
- This member is added by an implicit conversion from (DiagramDirectiveParser.this)#DiagramFilter to Ensuring[(DiagramDirectiveParser.this)#DiagramFilter] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
def
formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from (DiagramDirectiveParser.this)#DiagramFilter to StringFormat[(DiagramDirectiveParser.this)#DiagramFilter] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @inline()
-
final
def
getClass(): java.lang.Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
def
→[B](y: B): ((DiagramDirectiveParser.this)#DiagramFilter, B)
- Implicit
- This member is added by an implicit conversion from (DiagramDirectiveParser.this)#DiagramFilter to ArrowAssoc[(DiagramDirectiveParser.this)#DiagramFilter] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
The Scala compiler and reflection APIs.