Skip to content

Commit 05f5494

Browse files
committed
Improved documentations on generated graphs
1 parent ed1acd6 commit 05f5494

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

docs/GUIDE.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -119,11 +119,18 @@ The `--generate-graphs` option will output the following reports:
119119

120120
### Components coupling
121121

122+
#### Dependency graph
123+
122124
![Dependency graph](assets/example_internal_deps_graph.jpeg)
123125

124-
Dependency graph, with number of imports of _destination_ from _origin_.
126+
Dependency graph with number of imports of _destination_ from _origin_.
127+
125128
The framework width and border size are directly proportional to the framework's LOC percentage compared to the total LOC. The thickness of the connection arrow between two frameworks is directly proportional to the percentage of imports call compared to the total number of imports.
126129

130+
The tool will generate also the _external dependencies graph_ (which will represent the coupling of the source code with external libraries) and the _aggregate dependencies graph_ (which will represent both internal and external dependencies).
131+
132+
#### Distance from main sequence
133+
127134
![Distance from main sequence](assets/example_deviation_main_sequence.jpeg)
128135

129136
It express the components coupling in terms of stability and abstraction.
@@ -133,7 +140,6 @@ A framework with I < 0.5 and A < 0.5 indicates a library that's rigid to change,
133140

134141
For a more detailed description, please refer to the _Clean Architecture, Robert C. Martin_ book, Chapter 14 _Component Coupling_.
135142

143+
### Code distribution
136144

137-
| Code distribution |
138-
|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|
139145
| ![LOC](assets/lines_of_code_-_loc.jpeg) ![NOC](assets/number_of_comments_-_noc.jpeg) ![Nc](assets/n._of_classes_and_structs.jpeg) ![NOT](assets/number_of_tests_-_not.jpeg) ![Code distribution](assets/code_distribution.jpeg) |

0 commit comments

Comments
 (0)