Increase documentation

Signed-off-by: Vitor Mattos <vitor@php.rio>
This commit is contained in:
Vitor Mattos
2021-07-23 14:17:20 -03:00
committed by Julius Härtl
parent 19c609540b
commit c7a37ea425
5 changed files with 209 additions and 1 deletions

View File

@@ -0,0 +1,17 @@
// Created using [yUML](https://github.com/jaime-olivares/vscode-yuml)
// {type:class}
// {direction:topDown}
// {generate:true}
[note: Classes used on board import. Methods just to illustrate. {bg:cornsilk}]
[ApiController]<-[BoardImportApiController|+import();+getAllowedSystems();+getConfigSchema()]
[BoardImportApiController]uses-.->[BoardImportService|+import();+bootstrap();+validateSystem();#validateConfig();#validateData();]
[Command]<-[BoardImport|+boardImportCommandService|#configure();#execute(input,output)]
[BoardImport]uses-.->[BoardImportCommandService|+bootstrap();+import();+validateSystem();#validateConfig();#validateData()]
[BoardImportCommandService]->[BoardImportService]
[BoardImportService]uses-.->[BoardImportTrelloService]
[BoardImportTrelloService]uses-.->[BoardImportService]
[BoardImportService]-[note: validateSystem is public because is used on Api. {bg:cornsilk}]
[BoardImportTrelloService]-[note: To create an import to another system, create another class similar to this. {bg:cornsilk}]
[BoardImportTrelloService]implements-.-^[<<abstract>> ABoardImportService]