docs(analyzer): Improve the KDoc for getModuleInfos()

fviernau · fviernau · commit 7a32036a3ee5 · 2023-10-20T10:52:21.000+02:00
Signed-off-by: Frank Viernau &lt;frank_viernau@epam.com&gt;
diff --git a/analyzer/src/main/kotlin/managers/GoMod.kt b/analyzer/src/main/kotlin/managers/GoMod.kt
@@ -259,8 +259,7 @@ class GoMod(
     }
 
     /**
-     * Return the list of all modules contained in the dependency tree with resolved versions and the 'replace'
-     * directive applied.
+     * Return the list of all modules available via the `go list` command.
      */
     private fun getModuleInfos(projectDir: File): List<ModuleInfo> {
         val list = runGo("list", "-m", "-json", "-buildvcs=false", "all", workingDir = projectDir)

Original file line number	Diff line number	Diff line change
`@@ -259,8 +259,7 @@ class GoMod(`
`259`	`259`	`}`
`260`	`260`
`261`	`261`	`/**`
`262`		`- * Return the list of all modules contained in the dependency tree with resolved versions and the 'replace'`
`263`		`- * directive applied.`
	`262`	+ * Return the list of all modules available via the `go list` command.
`264`	`263`	`*/`
`265`	`264`	`private fun getModuleInfos(projectDir: File): List<ModuleInfo> {`
`266`	`265`	`val list = runGo("list", "-m", "-json", "-buildvcs=false", "all", workingDir = projectDir)`