Skip to content

Commit a0c7ad5

Browse files
committed
improve javadoc
1 parent 0d2003a commit a0c7ad5

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

opengrok-indexer/src/main/java/org/opengrok/indexer/configuration/Configuration.java

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -305,13 +305,15 @@ public final class Configuration {
305305

306306
private boolean historyBasedReindex;
307307

308-
/*
308+
/**
309309
* types of handling history for remote SCM repositories:
310-
* ON - index history and display it in webapp
311-
* OFF - do not index or display history in webapp
312-
* DIRBASED - index history only for repositories capable
313-
* of getting history for directories
314-
* UIONLY - display history only in webapp (do not index it)
310+
* <ul>
311+
* <li><code>ON</code> - index history and display it in webapp</li>
312+
* <li><code>OFF</code> - do not index or display history in webapp</li>
313+
* <li><code>DIRBASED</code> - index history only for repositories capable
314+
* of getting history for directories</li>
315+
* <li><code>UIONLY</code> - display history only in webapp (do not index it)</li>
316+
* </ul>
315317
*/
316318
public enum RemoteSCM {
317319
ON, OFF, DIRBASED, UIONLY

0 commit comments

Comments
 (0)