improve javadoc

vladak · vladak · commit 5b754c91fd99 · 2023-09-25T17:03:29.000+02:00
diff --git a/opengrok-indexer/src/main/java/org/opengrok/indexer/index/IndexCheck.java b/opengrok-indexer/src/main/java/org/opengrok/indexer/index/IndexCheck.java
@@ -182,6 +182,8 @@ public static boolean isOkay(@NotNull Configuration configuration, IndexCheckMod
     }
 
     /**
+     * Perform specified check on given index directory. All exceptions except {@code IOException} are swallowed
+     * and result in return value of 1.
      * @param indexPath directory with index
      * @return 0 on success, 1 on failure (index check failed)
      * @throws IOException on I/O error

Original file line number	Diff line number	Diff line change
`@@ -182,6 +182,8 @@ public static boolean isOkay(@NotNull Configuration configuration, IndexCheckMod`
`182`	`182`	`}`
`183`	`183`
`184`	`184`	`/**`
	`185`	`+ * Perform specified check on given index directory. All exceptions except {@code IOException} are swallowed`
	`186`	`+ * and result in return value of 1.`
`185`	`187`	`* @param indexPath directory with index`
`186`	`188`	`* @return 0 on success, 1 on failure (index check failed)`
`187`	`189`	`* @throws IOException on I/O error`