scala.tools.nsc.doc.model.diagram

DiagramFactory

trait DiagramFactory extends DiagramDirectiveParser

This trait takes care of generating the diagram for classes and packages

Self Type
ModelFactory with ModelFactoryTypeSupport with DiagramFactory with CommentFactory with TreeFactory
Source
DiagramFactory.scala
Linear Supertypes
DiagramDirectiveParser, AnyRef, Any
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. DiagramFactory
  2. DiagramDirectiveParser
  3. AnyRef
  4. 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 DiagramFactory to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd

  5. def ->[B](y: B): (DiagramFactory, B)

    Implicit information
    This member is added by an implicit conversion from DiagramFactory to ArrowAssoc[DiagramFactory] 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. def aggregationNode(text: String): NormalNode

  11. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  12. def clone(): AnyRef

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

  13. def ensuring(cond: (DiagramFactory) ⇒ Boolean, msg: ⇒ Any): DiagramFactory

    Implicit information
    This member is added by an implicit conversion from DiagramFactory to Ensuring[DiagramFactory] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  14. def ensuring(cond: (DiagramFactory) ⇒ Boolean): DiagramFactory

    Implicit information
    This member is added by an implicit conversion from DiagramFactory to Ensuring[DiagramFactory] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  15. def ensuring(cond: Boolean, msg: ⇒ Any): DiagramFactory

    Implicit information
    This member is added by an implicit conversion from DiagramFactory to Ensuring[DiagramFactory] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  16. def ensuring(cond: Boolean): DiagramFactory

    Implicit information
    This member is added by an implicit conversion from DiagramFactory to Ensuring[DiagramFactory] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring

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

    Definition Classes
    AnyRef

  18. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  19. def finalize(): Unit

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

  20. def formatted(fmtstr: String): String

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

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

    Definition Classes
    AnyRef → Any

  22. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  23. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  24. def makeContentDiagram(pack: (DiagramFactory.this)#DocTemplateImpl): Option[Diagram]

    Create the content diagram for this template

  25. def makeContentDiagramFilter(template: (DiagramFactory.this)#DocTemplateImpl): (DiagramFactory.this)#DiagramFilter

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

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

    Definition Classes
    DiagramDirectiveParser

  26. def makeInheritanceDiagram(tpl: (DiagramFactory.this)#DocTemplateImpl): Option[Diagram]

    Create the inheritance diagram for this template

  27. def makeInheritanceDiagramFilter(template: (DiagramFactory.this)#DocTemplateImpl): (DiagramFactory.this)#DiagramFilter

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

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

    Definition Classes
    DiagramDirectiveParser

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

    Definition Classes
    AnyRef

  29. final def notify(): Unit

    Definition Classes
    AnyRef

  30. final def notifyAll(): Unit

    Definition Classes
    AnyRef

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

    Definition Classes
    AnyRef

  32. var tFilter: Long

    Attributes
    protected
    Definition Classes
    DiagramDirectiveParser

  33. var tModel: Long

    Attributes
    protected
    Definition Classes
    DiagramDirectiveParser

  34. def toString(): String

    Definition Classes
    AnyRef → Any

  35. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()

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

    Definition Classes
    AnyRef
    Annotations
    @throws()

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

    Definition Classes
    AnyRef
    Annotations
    @throws()

  38. def →[B](y: B): (DiagramFactory, B)

    Implicit information
    This member is added by an implicit conversion from DiagramFactory to ArrowAssoc[DiagramFactory] 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 DiagramFactory 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:
    (diagramFactory: StringAdd).self
    Definition Classes
    StringAdd

  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from DiagramFactory 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:
    (diagramFactory: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. def x: DiagramFactory

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

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: DiagramFactory

    Implicit information
    This member is added by an implicit conversion from DiagramFactory to Ensuring[DiagramFactory] 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:
    (diagramFactory: Ensuring[DiagramFactory]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from DiagramDirectiveParser

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from DiagramFactory to StringAdd

Inherited by implicit conversion any2stringfmt from DiagramFactory to StringFormat

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

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

Ungrouped