ahtlon/deck
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

Increase documentation

Browse Source 
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
Download Patch File Download Diff File Expand all files Collapse all files

178
docs/resources/BoardImport.svg Normal file
View File

@@ -0,0 +1,178 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN"
"http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
<!-- Generated by graphviz version 2.40.1 (20161225.0304)
-->
<!-- Title: G Pages: 1 -->
<svg width="361pt" height="738pt"
viewBox="0.00 0.00 361.01 738.00" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
<g id="graph0" class="graph" transform="scale(1 1) rotate(0) translate(4 734)">
<title>G</title>
<polygon fill="#ffffff" stroke="transparent" points="-4,4 -4,-734 357.012,-734 357.012,4 -4,4"/>
<!-- A0 -->
<g id="node1" class="node">
<title>A0</title>
<polygon fill="#fff8dc" stroke="#000000" points="165.909,-730 70.091,-730 70.091,-674 171.909,-674 171.909,-724 165.909,-730"/>
<polyline fill="none" stroke="#000000" points="165.909,-730 165.909,-724 "/>
<polyline fill="none" stroke="#000000" points="171.909,-724 165.909,-724 "/>
<text text-anchor="middle" x="121" y="-717" font-family="Helvetica,sans-Serif" font-size="10.00" fill="#000000">Classes used on</text>
<text text-anchor="middle" x="121" y="-705" font-family="Helvetica,sans-Serif" font-size="10.00" fill="#000000">board import.</text>
<text text-anchor="middle" x="121" y="-693" font-family="Helvetica,sans-Serif" font-size="10.00" fill="#000000">Methods just to</text>
<text text-anchor="middle" x="121" y="-681" font-family="Helvetica,sans-Serif" font-size="10.00" fill="#000000">illustrate.</text>
</g>
<!-- A1 -->
<g id="node2" class="node">
<title>A1</title>
<polygon fill="none" stroke="#000000" points="108.7773,-588 23.2227,-588 23.2227,-552 108.7773,-552 108.7773,-588"/>
<text text-anchor="middle" x="66" y="-567" font-family="Helvetica,sans-Serif" font-size="10.00" fill="#000000">ApiController</text>
</g>
<!-- A2 -->
<g id="node3" class="node">
<title>A2</title>
<polygon fill="none" stroke="#000000" points="0,-422 0,-454 132,-454 132,-422 0,-422"/>
<text text-anchor="start" x="9.607" y="-435" font-family="Helvetica,sans-Serif" font-size="10.00" fill="#000000">BoardImportApiController</text>
<polygon fill="none" stroke="#000000" points="0,-366 0,-422 132,-422 132,-366 0,-366"/>
<text text-anchor="start" x="45.8645" y="-403" font-family="Helvetica,sans-Serif" font-size="10.00" fill="#000000">+import()</text>
<text text-anchor="start" x="16.1335" y="-391" font-family="Helvetica,sans-Serif" font-size="10.00" fill="#000000">+getAllowedSystems()</text>
<text text-anchor="start" x="20.0185" y="-379" font-family="Helvetica,sans-Serif" font-size="10.00" fill="#000000">+getConfigSchema()</text>
</g>
<!-- A1&#45;&gt;A2 -->
<g id="edge1" class="edge">
<title>A1&#45;&gt;A2</title>
<path fill="none" stroke="#000000" d="M66,-541.6693C66,-517.4424 66,-482.1663 66,-454.2238"/>
<polygon fill="#000000" stroke="#000000" points="66,-551.957 61.5001,-541.9569 66,-546.957 66.0001,-541.957 66.0001,-541.957 66.0001,-541.957 66,-546.957 70.5001,-541.957 66,-551.957 66,-551.957"/>
</g>
<!-- A3 -->
<g id="node4" class="node">
<title>A3</title>
<polygon fill="none" stroke="#000000" points="92,-272 92,-304 200,-304 200,-272 92,-272"/>
<text text-anchor="start" x="101.828" y="-285" font-family="Helvetica,sans-Serif" font-size="10.00" fill="#000000">BoardImportService</text>
<polygon fill="none" stroke="#000000" points="92,-192 92,-272 200,-272 200,-192 92,-192"/>
<text text-anchor="start" x="125.8645" y="-253" font-family="Helvetica,sans-Serif" font-size="10.00" fill="#000000">+import()</text>
<text text-anchor="start" x="118.9105" y="-241" font-family="Helvetica,sans-Serif" font-size="10.00" fill="#000000">+bootstrap()</text>
<text text-anchor="start" x="105.857" y="-229" font-family="Helvetica,sans-Serif" font-size="10.00" fill="#000000">+validateSystem()</text>
<text text-anchor="start" x="108.218" y="-217" font-family="Helvetica,sans-Serif" font-size="10.00" fill="#000000">#validateConfig()</text>
<text text-anchor="start" x="112.107" y="-205" font-family="Helvetica,sans-Serif" font-size="10.00" fill="#000000">#validateData()</text>
</g>
<!-- A2&#45;&gt;A3 -->
<g id="edge2" class="edge">
<title>A2&#45;&gt;A3</title>
<path fill="none" stroke="#000000" stroke-dasharray="5,2" d="M87.8604,-365.7328C95.8577,-349.5382 105.0823,-330.8583 113.7939,-313.2174"/>
<polygon fill="#000000" stroke="#000000" points="118.2935,-304.1057 117.9004,-315.0646 116.0795,-308.5889 113.8656,-313.072 113.8656,-313.072 113.8656,-313.072 116.0795,-308.5889 109.8308,-311.0795 118.2935,-304.1057 118.2935,-304.1057"/>
<text text-anchor="middle" x="88.3076" y="-342.7378" font-family="Helvetica,sans-Serif" font-size="10.00" fill="#000000">uses</text>
</g>
<!-- A7 -->
<g id="node8" class="node">
<title>A7</title>
<polygon fill="none" stroke="#000000" points="216.8384,-132 75.1616,-132 75.1616,-96 216.8384,-96 216.8384,-132"/>
<text text-anchor="middle" x="146" y="-111" font-family="Helvetica,sans-Serif" font-size="10.00" fill="#000000">BoardImportTrelloService</text>
</g>
<!-- A3&#45;&gt;A7 -->
<g id="edge6" class="edge">
<title>A3&#45;&gt;A7</title>
<path fill="none" stroke="#000000" stroke-dasharray="5,2" d="M139.3307,-191.9484C139.0775,-174.9176 139.4199,-156.9169 140.358,-142.5095"/>
<polygon fill="#000000" stroke="#000000" points="141.1915,-132.2681 144.8655,-142.6002 140.7859,-137.2516 140.3803,-142.2351 140.3803,-142.2351 140.3803,-142.2351 140.7859,-137.2516 135.8951,-141.87 141.1915,-132.2681 141.1915,-132.2681"/>
<text text-anchor="middle" x="130.6738" y="-170.919" font-family="Helvetica,sans-Serif" font-size="10.00" fill="#000000">uses</text>
</g>
<!-- A8 -->
<g id="node9" class="node">
<title>A8</title>
<polygon fill="#fff8dc" stroke="#000000" points="317.7872,-270 218.2128,-270 218.2128,-226 323.7872,-226 323.7872,-264 317.7872,-270"/>
<polyline fill="none" stroke="#000000" points="317.7872,-270 317.7872,-264 "/>
<polyline fill="none" stroke="#000000" points="323.7872,-264 317.7872,-264 "/>
<text text-anchor="middle" x="271" y="-257" font-family="Helvetica,sans-Serif" font-size="10.00" fill="#000000">validateSystem is</text>
<text text-anchor="middle" x="271" y="-245" font-family="Helvetica,sans-Serif" font-size="10.00" fill="#000000">public because is</text>
<text text-anchor="middle" x="271" y="-233" font-family="Helvetica,sans-Serif" font-size="10.00" fill="#000000">used on Api.</text>
</g>
<!-- A3&#45;&gt;A8 -->
<g id="edge8" class="edge">
<title>A3&#45;&gt;A8</title>
<path fill="none" stroke="#000000" stroke-dasharray="5,2" d="M200.1992,-248C206.1915,-248 212.1837,-248 218.176,-248"/>
</g>
<!-- A4 -->
<g id="node5" class="node">
<title>A4</title>
<polygon fill="none" stroke="#000000" points="264.1131,-720 189.8869,-720 189.8869,-684 264.1131,-684 264.1131,-720"/>
<text text-anchor="middle" x="227" y="-699" font-family="Helvetica,sans-Serif" font-size="10.00" fill="#000000">Command</text>
</g>
<!-- A5 -->
<g id="node6" class="node">
<title>A5</title>
<polygon fill="none" stroke="#000000" points="148,-592 148,-624 307,-624 307,-592 148,-592"/>
<text text-anchor="start" x="199.9955" y="-605" font-family="Helvetica,sans-Serif" font-size="10.00" fill="#000000">BoardImport</text>
<polygon fill="none" stroke="#000000" points="148,-560 148,-592 307,-592 307,-560 148,-560"/>
<text text-anchor="start" x="157.907" y="-573" font-family="Helvetica,sans-Serif" font-size="10.00" fill="#000000">+boardImportCommandService</text>
<polygon fill="none" stroke="#000000" points="148,-516 148,-560 307,-560 307,-516 148,-516"/>
<text text-anchor="start" x="200.8305" y="-541" font-family="Helvetica,sans-Serif" font-size="10.00" fill="#000000">#configure()</text>
<text text-anchor="start" x="177.76" y="-529" font-family="Helvetica,sans-Serif" font-size="10.00" fill="#000000">#execute(input,output)</text>
</g>
<!-- A4&#45;&gt;A5 -->
<g id="edge3" class="edge">
<title>A4&#45;&gt;A5</title>
<path fill="none" stroke="#000000" d="M227,-673.6356C227,-659.1554 227,-641.0451 227,-624.0324"/>
<polygon fill="#000000" stroke="#000000" points="227,-683.9227 222.5001,-673.9227 227,-678.9227 227.0001,-673.9227 227.0001,-673.9227 227.0001,-673.9227 227,-678.9227 231.5001,-673.9228 227,-683.9227 227,-683.9227"/>
</g>
<!-- A6 -->
<g id="node7" class="node">
<title>A6</title>
<polygon fill="none" stroke="#000000" points="150,-434 150,-466 304,-466 304,-434 150,-434"/>
<text text-anchor="start" x="159.7715" y="-447" font-family="Helvetica,sans-Serif" font-size="10.00" fill="#000000">BoardImportCommandService</text>
<polygon fill="none" stroke="#000000" points="150,-354 150,-434 304,-434 304,-354 150,-354"/>
<text text-anchor="start" x="199.9105" y="-415" font-family="Helvetica,sans-Serif" font-size="10.00" fill="#000000">+bootstrap()</text>
<text text-anchor="start" x="206.8645" y="-403" font-family="Helvetica,sans-Serif" font-size="10.00" fill="#000000">+import()</text>
<text text-anchor="start" x="186.857" y="-391" font-family="Helvetica,sans-Serif" font-size="10.00" fill="#000000">+validateSystem()</text>
<text text-anchor="start" x="189.218" y="-379" font-family="Helvetica,sans-Serif" font-size="10.00" fill="#000000">#validateConfig()</text>
<text text-anchor="start" x="193.107" y="-367" font-family="Helvetica,sans-Serif" font-size="10.00" fill="#000000">#validateData()</text>
</g>
<!-- A5&#45;&gt;A6 -->
<g id="edge4" class="edge">
<title>A5&#45;&gt;A6</title>
<path fill="none" stroke="#000000" stroke-dasharray="5,2" d="M227,-515.8313C227,-503.0442 227,-489.2707 227,-476.0248"/>
<polygon fill="#000000" stroke="#000000" points="227,-466.0234 231.5001,-476.0234 227,-471.0234 227.0001,-476.0234 227.0001,-476.0234 227.0001,-476.0234 227,-471.0234 222.5001,-476.0235 227,-466.0234 227,-466.0234"/>
<text text-anchor="middle" x="218.5476" y="-494.7051" font-family="Helvetica,sans-Serif" font-size="10.00" fill="#000000">uses</text>
</g>
<!-- A6&#45;&gt;A3 -->
<g id="edge5" class="edge">
<title>A6&#45;&gt;A3</title>
<path fill="none" stroke="#000000" d="M198.8975,-353.7949C192.3634,-340.7268 185.3528,-326.7057 178.6417,-313.2834"/>
<polygon fill="#000000" stroke="#000000" points="174.0529,-304.1057 182.55,-311.0375 176.289,-308.5779 178.5251,-313.05 178.5251,-313.05 178.5251,-313.05 176.289,-308.5779 174.5001,-315.0625 174.0529,-304.1057 174.0529,-304.1057"/>
</g>
<!-- A7&#45;&gt;A3 -->
<g id="edge7" class="edge">
<title>A7&#45;&gt;A3</title>
<path fill="none" stroke="#000000" stroke-dasharray="5,2" d="M150.8085,-132.2681C152.1233,-145.2693 152.7703,-163.6033 152.7495,-181.8528"/>
<polygon fill="#000000" stroke="#000000" points="152.6693,-191.9484 148.249,-181.9129 152.7091,-186.9485 152.7489,-181.9487 152.7489,-181.9487 152.7489,-181.9487 152.7091,-186.9485 157.2487,-181.9845 152.6693,-191.9484 152.6693,-191.9484"/>
<text text-anchor="middle" x="160.8916" y="-146.5403" font-family="Helvetica,sans-Serif" font-size="10.00" fill="#000000">uses</text>
</g>
<!-- A9 -->
<g id="node10" class="node">
<title>A9</title>
<polygon fill="#fff8dc" stroke="#000000" points="347.024,-142 234.976,-142 234.976,-86 353.024,-86 353.024,-136 347.024,-142"/>
<polyline fill="none" stroke="#000000" points="347.024,-142 347.024,-136 "/>
<polyline fill="none" stroke="#000000" points="353.024,-136 347.024,-136 "/>
<text text-anchor="middle" x="294" y="-129" font-family="Helvetica,sans-Serif" font-size="10.00" fill="#000000">To create an import</text>
<text text-anchor="middle" x="294" y="-117" font-family="Helvetica,sans-Serif" font-size="10.00" fill="#000000">to another system,</text>
<text text-anchor="middle" x="294" y="-105" font-family="Helvetica,sans-Serif" font-size="10.00" fill="#000000">create another class</text>
<text text-anchor="middle" x="294" y="-93" font-family="Helvetica,sans-Serif" font-size="10.00" fill="#000000">similar to this.</text>
</g>
<!-- A7&#45;&gt;A9 -->
<g id="edge9" class="edge">
<title>A7&#45;&gt;A9</title>
<path fill="none" stroke="#000000" stroke-dasharray="5,2" d="M216.8203,-114C222.85,-114 228.8796,-114 234.9093,-114"/>
</g>
<!-- A10 -->
<g id="node11" class="node">
<title>A10</title>
<polygon fill="none" stroke="#000000" points="207.513,-36 84.487,-36 84.487,0 207.513,0 207.513,-36"/>
<text text-anchor="middle" x="146" y="-21" font-family="Helvetica,sans-Serif" font-size="10.00" fill="#000000">&lt;&lt;abstract&gt;&gt;</text>
<text text-anchor="middle" x="146" y="-9" font-family="Helvetica,sans-Serif" font-size="10.00" fill="#000000">ABoardImportService</text>
</g>
<!-- A7&#45;&gt;A10 -->
<g id="edge10" class="edge">
<title>A7&#45;&gt;A10</title>
<path fill="none" stroke="#000000" stroke-dasharray="5,2" d="M146,-95.9431C146,-82.0862 146,-62.6861 146,-46.7075"/>
<polygon fill="none" stroke="#000000" points="149.5001,-46.3023 146,-36.3023 142.5001,-46.3023 149.5001,-46.3023"/>
<text text-anchor="middle" x="137.5476" y="-74.817" font-family="Helvetica,sans-Serif" font-size="10.00" fill="#000000">implements</text>
</g>
</g>
</svg>
Side by Side

After

Width:  |  Height:  |  Size: 12 KiB