Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
5ef00ee
commit 9ffa136
Showing
2 changed files
with
139 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,119 @@ | ||
[[section-building-block-view]] | ||
== Building Block View | ||
|
||
|
||
[[naming-rules:TestsMustEndWithTest]] | ||
.All Unit Tests must end with suffix 'Test' | ||
[source, cypher, role=constraint, depends=junit4:TestClass, severity=blocker] | ||
---- | ||
MATCH | ||
(t) | ||
RETURN | ||
t AS InvalidTestClass | ||
---- | ||
|
||
|
||
=== Level 1 | ||
|
||
|
||
The following diagram shows the main building blocks of the system and their interdependencies: | ||
|
||
<insert overview diagram here> | ||
[plantuml,level1,png] | ||
.... | ||
package de.kontext_e.jqassistant.plugin.plantuml.scanner {} | ||
package de.kontext_e.jqassistant.plugin.plantuml.store.descriptor {} | ||
de.kontext_e.jqassistant.plugin.plantuml.scanner --> de.kontext_e.jqassistant.plugin.plantuml.store.descriptor | ||
.... | ||
|
||
Comments regarding structure and interdependencies at Level 1: | ||
|
||
==== Building Block Name 1 (Black Box Description) | ||
|
||
|
||
<insert the building block’s black box template here> | ||
|
||
==== Building Block Name 2 (Black Box Description) | ||
|
||
<insert the building block’s black box template here> | ||
|
||
==== ... | ||
|
||
<insert the building block’s black box template here> | ||
|
||
==== Building Block Name n (Black Box Description) | ||
|
||
<insert the building block’s black box template here> | ||
|
||
==== Open Issues | ||
|
||
=== Level 2 | ||
|
||
|
||
|
||
==== Building Block Name 1 (White Box Description) | ||
|
||
|
||
<insert diagram of building block 1 here> | ||
|
||
===== Building Block Name 1.1 (Black Box Description) | ||
|
||
|
||
===== Building Block Name 1.2 (Black Box Description) | ||
|
||
Structure according to black box template | ||
|
||
===== ... | ||
|
||
===== Building Block Name 1.n (Black Box Description) | ||
|
||
|
||
===== Description of Relationships | ||
|
||
===== Open Issues | ||
|
||
==== Building Block Name 2 (White Box Description) | ||
|
||
… | ||
|
||
<insert diagram of building block 2 here> | ||
|
||
===== Building Block Name 2.1 (Black Box Description) | ||
|
||
Structure according to black box template | ||
|
||
===== Building Block Name 2.2 (Black Box Description) | ||
|
||
|
||
===== ... | ||
|
||
===== Building Block Name 2.n (Black Box Description) | ||
|
||
|
||
===== Description of Relationships | ||
|
||
===== Open Issues | ||
|
||
==== Building Block Name 3 (White Box Description) | ||
|
||
... | ||
|
||
<insert diagram of building block 3 here> | ||
|
||
===== Building Block Name 3.1 (Black Box Description) | ||
|
||
|
||
===== Building Block Name 3.2 (Black Box Description) | ||
|
||
===== ... | ||
|
||
===== Building Block Name 3.n (Black Box Description) | ||
|
||
|
||
===== Description of Relationships | ||
|
||
===== Open Issues | ||
|
||
=== Level 3 | ||
|