Updated README

This commit is contained in:
Bartek Kryza
2021-07-24 11:27:03 +02:00
parent 524cf36ecd
commit f9bc218d90
6 changed files with 266 additions and 167 deletions

View File

@@ -1,61 +1,39 @@
glob:
- src/*.cc
compilation_database_dir: build
output_directory: puml
diagrams:
communication:
myproject_class:
type: class
glob:
- src/communication/*.cc
- src/communication/codec/*.cc
- src/communication/layers/*.cc
using_namespace: one::communication
namespaces:
- one::communication
- one::communication::layers
- one::communication::codec
classes:
- ConnectionPool
- Communicator
- layers::AsyncResponder
- layers::BinaryTranslator
- layers::Inbox
- layers::Replier
- layers::Retrier
- layers::Sequencer
- layers::Translator
- codec::PacketLogger
- codec::PacketEncoder
- codec::PacketDecoder
methods:
- public
- private
members:
- public
puml:
- 'note top of Communicator : Aggregate template'
http_helper:
type: class
glob:
- src/httpHelper.cc
- src/httpHelperParams.cc
classes:
- FsLogic
args:
- '-I./src'
- '-I./include'
storage_helper:
type: class
classes:
- FileHandle
- StorageHelper
- KeyValueAdapter
- KeyValueHelper
storage_detection:
- src/**.h
- src/**.cc
using_namespace:
- myproject
include:
namespaces:
- myproject
exclude:
namespaces:
- myproject::detail
plantuml:
after:
- 'note left of @A(MyProjectMain) : Main class of myproject library.'
main_sequence_diagram:
type: sequence
begin:
class: aaa
method: bbb
end:
class: ccc
method: ddd
glob:
- src/main.cc
using_namespace:
- ""
start_from:
- usr: "c:@F@main#I#**1C#"
include:
namespaces:
- clanguml
exclude:
namespaces:
- std
- CLI
plantuml:
before:
- "' main test sequence diagram"
after:
- "' end"