Skip to content

Commit

Permalink
DOC: Fix UML relations (realize vs is)
Browse files Browse the repository at this point in the history
Implementing an interface is "realize" not "is" arrow.
  • Loading branch information
nhjschulz committed Feb 13, 2024
1 parent 5f79e92 commit 04d096c
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 10 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ constructs.
The state pattern builds on
* A context that delegates operations to one of various state objects,
which is currently the active state.
* A number of states objects that implement context operations to provide
* A number of state objects that implement context operations to provide
state dependent behavior of these operations.

### The CFSM Context
Expand Down Expand Up @@ -192,7 +192,7 @@ The main function implements the game simulation loop. It owns
a CFSM instance as a local cfsm_Fsm structure called ``marioFsm``.

The CFSM setup phase consists of initializing ``marioFsm`` and
then transition to Marios start state "SmallMario". The simplified
then transition to Mario's start state "SmallMario". The simplified
codes looks like this:

```C
Expand Down
4 changes: 2 additions & 2 deletions doc/cfsm_statepattern.puml
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ class State2 {
}

Context -- State
State <|-d- State1
State <|-d- State2
State <|.d. State1
State <|.d. State2

}
@enduml
12 changes: 6 additions & 6 deletions doc/mario_classdiagram.puml
Original file line number Diff line number Diff line change
Expand Up @@ -58,16 +58,16 @@ package "CFSM" {
}

cfsm_Fsm -- Operations
SuperMario -u-|> Operations
CapeMario -u-|> Operations
FireMario -u-|> Operations
DeadMario -u-|> Operations
SmallMario -u-|> Operations
SuperMario .u-|> Operations
CapeMario .u-|> Operations
FireMario .u-|> Operations
DeadMario .u-|> Operations
SmallMario .u-|> Operations

states .> Mario : update

SmallMario <.. Main
Main .> cfsm_Fsm : init as SmallMario\nprocessing and\n event signalling
Main ..> cfsm_Fsm : init as SmallMario\nprocessing and\n event signalling

MarioVariant .l. MarioData
MarioEvent .r. MarioData
Expand Down

0 comments on commit 04d096c

Please sign in to comment.