Skip to content

Commit e0154ad

Browse files
committed
Update documentation
1 parent 8d3b838 commit e0154ad

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

utbot-intellij/src/main/kotlin/org/utbot/intellij/plugin/util/SpringConfigurationsHelper.kt

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,17 @@
11
package org.utbot.intellij.plugin.util
22

33
/**
4-
* Getting from spring Configuration Classes and Spring XML Configuration Files shortened paths
4+
* This class is a converter between full Spring configuration names and shortened versions.
55
*
6-
* How is this done:
7-
* - Parent directories are appended to the file name until the path becomes unique
6+
* Shortened versions are represented on UI.
7+
* Full names are used in further analysis in utbot-spring-analyzer.
88
*
9-
* Example:
10-
* - [["config.web.WebConfig", "config.web2.WebConfig", "config.web.AnotherConfig"]] ->
11-
* [["web.WebConfig", "web2.WebConfig", "AnotherConfig"]]
9+
* The idea of this implementation is to append parent directories to the file name until all names become unique.
10+
*
11+
* Example:
12+
* - [["config.web.WebConfig", "config.web2.WebConfig", "config.web.AnotherConfig"]]
13+
* ->
14+
* [["web.WebConfig", "web2.WebConfig", "AnotherConfig"]]
1215
*/
1316
class SpringConfigurationsHelper(val separator: String) {
1417

0 commit comments

Comments
 (0)