mirror of
https://github.com/Nimac0/SDL_Minigame
synced 2026-01-12 09:03:42 +00:00
Added diagrams for documentation
This commit is contained in:
parent
78f1b11d01
commit
f36632c9fd
2
.gitignore
vendored
2
.gitignore
vendored
@ -73,3 +73,5 @@ Thumbs.db
|
||||
Desktop.ini
|
||||
|
||||
compile_commands.json
|
||||
|
||||
*.puml
|
||||
|
||||
62
docs/diagrams/.clang-uml
Normal file
62
docs/diagrams/.clang-uml
Normal file
@ -0,0 +1,62 @@
|
||||
compilation_database_dir: ../..
|
||||
output_directory: .
|
||||
diagrams:
|
||||
|
||||
includes:
|
||||
type: include
|
||||
relative_to: ../..
|
||||
glob:
|
||||
- src/*.cpp
|
||||
- include/*.h
|
||||
generate_system_headers: true
|
||||
include:
|
||||
paths:
|
||||
- src
|
||||
- include
|
||||
plantuml:
|
||||
before:
|
||||
- 'skinparam linetype ortho'
|
||||
|
||||
includes_no_external:
|
||||
type: include
|
||||
relative_to: ../..
|
||||
glob:
|
||||
- src/*.cpp
|
||||
- include/*.h
|
||||
include:
|
||||
paths:
|
||||
- src
|
||||
- include
|
||||
plantuml:
|
||||
before:
|
||||
- 'skinparam linetype ortho'
|
||||
|
||||
classes:
|
||||
type: class
|
||||
relative_to: ../..
|
||||
glob:
|
||||
- src/*.cpp
|
||||
- include/*.h
|
||||
include:
|
||||
paths:
|
||||
- src
|
||||
- include
|
||||
plantuml:
|
||||
before:
|
||||
- 'skinparam linetype ortho'
|
||||
|
||||
load_map_example_sequence:
|
||||
type: sequence
|
||||
relative_to: ../..
|
||||
glob:
|
||||
- src/*.cpp
|
||||
- include/*.h
|
||||
include:
|
||||
paths:
|
||||
- src
|
||||
- include
|
||||
start_from:
|
||||
- function: "Map::loadMap(const char *,int,int)"
|
||||
plantuml:
|
||||
before:
|
||||
- 'skinparam linetype ortho'
|
||||
1
docs/diagrams/classes.svg
Normal file
1
docs/diagrams/classes.svg
Normal file
File diff suppressed because one or more lines are too long
|
After Width: | Height: | Size: 101 KiB |
12
docs/diagrams/howto.md
Normal file
12
docs/diagrams/howto.md
Normal file
@ -0,0 +1,12 @@
|
||||
Need [clang-uml](https://clang-uml.github.io/index.html)
|
||||
|
||||
```sh
|
||||
clang-uml
|
||||
clang-uml --add-compile-flag -I/usr/lib/clang/16/include # might need additional flags, example for my machine
|
||||
clang-uml --print-from -n load_map_example_sequence # to get availabel commands for sequence diagram
|
||||
```
|
||||
|
||||
then use plant uml to generate an actual `.svg` vector graphic
|
||||
```sh
|
||||
plantuml -tsvg *.puml
|
||||
```
|
||||
1
docs/diagrams/includes.svg
Normal file
1
docs/diagrams/includes.svg
Normal file
File diff suppressed because one or more lines are too long
|
After Width: | Height: | Size: 81 KiB |
1
docs/diagrams/includes_no_external.svg
Normal file
1
docs/diagrams/includes_no_external.svg
Normal file
File diff suppressed because one or more lines are too long
|
After Width: | Height: | Size: 52 KiB |
1
docs/diagrams/sequence.svg
Normal file
1
docs/diagrams/sequence.svg
Normal file
File diff suppressed because one or more lines are too long
|
After Width: | Height: | Size: 19 KiB |
Loading…
x
Reference in New Issue
Block a user