update comment

vladak · vladak · commit 4ee36cd3ac83 · 2022-02-23T10:31:11.000+01:00
diff --git a/opengrok-indexer/src/main/java/org/opengrok/indexer/history/HistoryGuru.java b/opengrok-indexer/src/main/java/org/opengrok/indexer/history/HistoryGuru.java
@@ -729,7 +729,8 @@ public void clearCacheFile(String path) {
 
     /**
      * Remove history data for a list of repositories. Those that are
-     * successfully cleared are removed from the internal list of repositories.
+     * successfully cleared may be removed from the internal list of repositories,
+     * depending on the {@code removeRepositories} parameter.
      *
      * @param repositories list of repository paths relative to source root
      * @param removeRepositories set true to also remove the repositories from internal structures

Original file line number	Diff line number	Diff line change
`@@ -729,7 +729,8 @@ public void clearCacheFile(String path) {`
`729`	`729`
`730`	`730`	`/**`
`731`	`731`	`* Remove history data for a list of repositories. Those that are`
`732`		`- * successfully cleared are removed from the internal list of repositories.`
	`732`	`+ * successfully cleared may be removed from the internal list of repositories,`
	`733`	`+ * depending on the {@code removeRepositories} parameter.`
`733`	`734`	`*`
`734`	`735`	`* @param repositories list of repository paths relative to source root`
`735`	`736`	`* @param removeRepositories set true to also remove the repositories from internal structures`