-
Notifications
You must be signed in to change notification settings - Fork 119
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: Add implementation section to architecture doc (#1961)
Fixes #1960 This PR is adding a section about how to meet architecture requirements in implementation. ![added section](https://github.com/Flank/flank/blob/1960_Add_implementation_section_to_architecture_doc/docs/architecture.md#implementation-) ## Checklist - [x] Update diagram links before merge
- Loading branch information
Showing
4 changed files
with
148 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,62 @@ | ||
@startuml | ||
'https://plantuml.com/object-diagram | ||
|
||
left to right direction | ||
|
||
package layer1 { | ||
package File1 { | ||
[public function 1] | ||
} | ||
package nested1 { | ||
package File2 { | ||
[internal function 2] | ||
} | ||
package File3 { | ||
[internal function 1] | ||
[private function 1] | ||
[private function 2] | ||
} | ||
package File4 { | ||
[internal function 3] | ||
} | ||
} | ||
} | ||
package layer2 { | ||
package tool1 { | ||
package File5 { | ||
[public function 2] | ||
} | ||
package nested2 { | ||
package File6 { | ||
[internal function 4] | ||
[internal function 5] | ||
[internal function 6] | ||
} | ||
} | ||
} | ||
package api { | ||
package File7 { | ||
() "functional interface 1" | ||
} | ||
package File8 { | ||
() "functional interface 2" | ||
} | ||
} | ||
} | ||
|
||
[public function 1] --> [internal function 3] | ||
[public function 1] --> [internal function 1] | ||
[public function 1] --> [internal function 2] | ||
|
||
[internal function 1] -right-> [private function 1] | ||
[internal function 1] --> [private function 2] | ||
[internal function 3] ---> [public function 2] | ||
|
||
[internal function 2] ---> () "functional interface 2" | ||
[internal function 1] ---> () "functional interface 1" | ||
|
||
[public function 2] --> [internal function 4] | ||
[public function 2] --> [internal function 5] | ||
[public function 2] ---> [internal function 6] | ||
|
||
@enduml |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
@startuml | ||
'https://plantuml.com/object-diagram | ||
|
||
left to right direction | ||
|
||
[public function] --> [internal function 1] | ||
[public function] --> [internal function 2] | ||
[public function] --> [internal function 3] | ||
[public function] --> [internal function 4] | ||
[public function] --> [internal function 7] | ||
[internal function 2] --> [private function 5] | ||
[internal function 2] --> [private function 6] | ||
[internal function 7] --> [private function 8] | ||
[internal function 7] --> [private function 9] | ||
[internal function 7] --> [private function 10] | ||
[internal function 7] --> [private function 11] | ||
|
||
|
||
@enduml |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
@startuml | ||
'https://plantuml.com/object-diagram | ||
|
||
[public function] -right-> [any function 1] | ||
[any function 1] -right-> [any function 2] | ||
[any function 2] -right-> [any function 3] | ||
[any function 3] -down-> [any function 4] | ||
[any function 4] -left-> [any function 5] | ||
[any function 5] -left-> [any function 6] | ||
[any function 6] -left-> [any function 7] | ||
[any function 7] -down-> [any function 8] | ||
[any function 8] -right-> [any function 9] | ||
[any function 9] -right-> [any function 10] | ||
[any function 10] -right-> [any function 11] | ||
|
||
@enduml |