From 8200770211cf8b2664bd0510a80cc535004d3e4f Mon Sep 17 00:00:00 2001 From: amandelpie Date: Mon, 21 Nov 2022 16:47:48 +0300 Subject: [PATCH] Added some docs --- docs/OverallArchitecture.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/docs/OverallArchitecture.md b/docs/OverallArchitecture.md index 94885aa8e4..e3b0a256ef 100644 --- a/docs/OverallArchitecture.md +++ b/docs/OverallArchitecture.md @@ -159,7 +159,22 @@ TODO (Maxim Pelevin) TODO (Sergey Pospelov) ### Summaries -TODO (Alexey Zinoviev) +The summarization process includes the generation of the following meta-information: +- method names for tests +- display names for tests +- JavaDocs for tests +- simple comments for group of tests (regions) + +Each of these stages can be turned off by changing +the settings located in ```org.utbot.summary.UtSummarySettings```. + +If the summarization process for some reason was failed at one of the stages due to an error or insufficient information, +then the test method receives a unique name and no more meta-information. + +The approach to generating meta-information depends on the type of UtExection for which the meta-information is being created and can vary significantly. +Also, JavaDocs built in two modes: as plain text or in especial format enriched with the custom java tags. + +This subsystem is fully located in the ```utbot-summary``` module. ### Sarif report TODO (Nikita Stroganov)