marcel/mermaid
1
0
Fork 0
mirror of https://github.com/mermaid-js/mermaid.git synced 2025-09-18 06:49:47 +02:00
Code Issues Packages Projects Releases Wiki Activity

#1146 Updated classDiagram documentation with new relation types

Browse Source
This commit is contained in:
Ashish Jain
2020-01-02 19:35:22 +01:00
parent f2a5d92398
commit f54adb4a3e
1 changed files with 34 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

48
docs/classDiagram.md
View File

@@ -174,17 +174,21 @@ Type | Description
*-- | Composition *-- | Composition
o-- | Aggregation o-- | Aggregation
--> | Association --> | Association
-- | Link -- | Link (Solid)
..> | Dependency
..\|> | Realization
.. | Link (Dashed)
<!--- TODO ..> Dependency--->
``` ```
classDiagram classDiagram
classA <|-- classB classA <|-- classB
classC *-- classD classC *-- classD
classE o-- classF classE o-- classF
classG <-- classH classG <-- classH
classI <.. classJ classI -- classJ
classK .. classL classK <.. classL
classM <|.. classN
classO .. classP
``` ```
@@ -194,30 +198,36 @@ classA <|-- classB
classC *-- classD classC *-- classD
classE o-- classF classE o-- classF
classG <-- classH classG <-- classH
classI <.. classJ classI -- classJ
classK .. classL classK <.. classL
classM <|.. classN
classO .. classP
``` ```
We can use the arrowheads in opposite directions as well : We can use the labels to describe nature of relation between two classes. Also, arrowheads can be used in opposite directions as well :
``` ```
classDiagram classDiagram
classA --|> classB classA --|> classB : Inheritance
classC --* classD classC --* classD : Composition
classE --o classF classE --o classF : Aggregation
classG <--> classH classG --> classH : Association
classI ..> classJ classI -- classJ : Link(Solid)
classK .. classL classK ..> classL : Dependency
classM ..|> classN : Realization
classO .. classP : Link(Dashed)
``` ```
```mermaid ```mermaid
classDiagram classDiagram
classA --|> classB classA --|> classB : Inheritance
classC --* classD classC --* classD : Composition
classE --o classF classE --o classF : Aggregation
classG <--> classH classG --> classH : Association
classI ..> classJ classI -- classJ : Link(Solid)
classK .. classL classK ..> classL : Dependency
classM ..|> classN : Realization
classO .. classP : Link(Dashed)
``` ```