Skip to content

Commit 0933427

Browse files
amandelpietamarinvs19
authored andcommitted
Add initial description of summary module for the OverallArchitecture.md (#1405)
Added some docs
1 parent 5c06954 commit 0933427

File tree

1 file changed

+16
-1
lines changed

1 file changed

+16
-1
lines changed

docs/OverallArchitecture.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -162,7 +162,22 @@ TODO (Maxim Pelevin)
162162
TODO (Sergey Pospelov)
163163

164164
### Summaries
165-
TODO (Alexey Zinoviev)
165+
The summarization process includes the generation of the following meta-information:
166+
- method names for tests
167+
- display names for tests
168+
- JavaDocs for tests
169+
- simple comments for group of tests (regions)
170+
171+
Each of these stages can be turned off by changing
172+
the settings located in ```org.utbot.summary.UtSummarySettings```.
173+
174+
If the summarization process for some reason was failed at one of the stages due to an error or insufficient information,
175+
then the test method receives a unique name and no more meta-information.
176+
177+
The approach to generating meta-information depends on the type of UtExection for which the meta-information is being created and can vary significantly.
178+
Also, JavaDocs built in two modes: as plain text or in especial format enriched with the custom java tags.
179+
180+
This subsystem is fully located in the ```utbot-summary``` module.
166181

167182
### Sarif report
168183
TODO (Nikita Stroganov)

0 commit comments

Comments
 (0)