Skip to content

Commit d197e5f

Browse files
committed
fix some javadoc warnings
1 parent 09dedf6 commit d197e5f

File tree

4 files changed

+19
-5
lines changed

4 files changed

+19
-5
lines changed

opengrok-indexer/src/main/java/org/opengrok/indexer/history/HistoryGuru.java

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -278,22 +278,27 @@ private Annotation getAnnotationFromRepository(File file, @Nullable String rev)
278278

279279
/**
280280
* Wrapper for {@link #annotate(File, String, boolean)}.
281+
* @param file the file to annotate
282+
* @param rev the revision to annotate (<code>null</code> means current revision)
283+
* @return file annotation, or <code>null</code>
284+
* @throws IOException on error
281285
*/
282286
@Nullable
283-
public Annotation annotate(File file, String rev) throws IOException {
287+
public Annotation annotate(File file, @Nullable String rev) throws IOException {
284288
return annotate(file, rev, true);
285289
}
286290

287291
/**
288292
* Annotate the specified revision of a file.
289293
*
290294
* @param file the file to annotate
291-
* @param rev the revision to annotate (<code>null</code> means BASE)
292-
* @return file annotation, or <code>null</code> if the <code>HistoryParser</code> does not support annotation
295+
* @param rev the revision to annotate (<code>null</code> means current revision)
296+
* @param fallback whether to fall back to repository method
297+
* @return file annotation, or <code>null</code>
293298
* @throws IOException if I/O exception occurs
294299
*/
295300
@Nullable
296-
public Annotation annotate(File file, String rev, boolean fallback) throws IOException {
301+
public Annotation annotate(File file, @Nullable String rev, boolean fallback) throws IOException {
297302
Annotation annotation = getAnnotation(file, rev, fallback);
298303
if (annotation == null) {
299304
LOGGER.log(Level.FINEST, "no annotation for ''{0}''", file);

opengrok-indexer/src/main/java/org/opengrok/indexer/history/RepositoryFactory.java

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -144,10 +144,17 @@ public static Repository getRepository(File file)
144144
}
145145

146146
/**
147-
* Calls {@link #getRepository(File, CommandTimeoutType, boolean)} with {@code file}, {@code interactive}, and {@code false}.
147+
* Calls {@link #getRepository(File, CommandTimeoutType, boolean)} with {@code file}, {@code interactive},
148+
* and {@code false}.
148149
* @param file file
149150
* @param cmdType command timeout type
150151
* @return repository object
152+
* @throws IllegalAccessException on error
153+
* @throws InvocationTargetException on error
154+
* @throws ForbiddenSymlinkException on error
155+
* @throws InstantiationException on error
156+
* @throws NoSuchMethodException on error
157+
* @throws IOException on error
151158
*/
152159
public static Repository getRepository(File file, CommandTimeoutType cmdType)
153160
throws IllegalAccessException, InvocationTargetException, ForbiddenSymlinkException, InstantiationException,

opengrok-indexer/src/main/java/org/opengrok/indexer/index/NumLinesLOCAggregator.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,7 @@ public Iterator<AccumulatedNumLinesLOC> iterator() {
5252
* Registers the specified counts. Values should be negative when deleting a
5353
* file or when updating a file's analysis to reverse former values before
5454
* re-registering.
55+
* @param counts {@link NumLinesLOC} instance
5556
*/
5657
public void register(NumLinesLOC counts) {
5758
File file = new File(counts.getPath());

opengrok-indexer/src/main/java/org/opengrok/indexer/index/NumLinesLOCUtil.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ public class NumLinesLOCUtil {
3535

3636
/**
3737
* Reads data, if they exist, from the specified document.
38+
* @param doc {@link Document} instance
3839
* @return a defined instance
3940
*/
4041
public static NullableNumLinesLOC read(Document doc) {

0 commit comments

Comments
 (0)