opendev/gerrit
Code Issues Proposed changes

Miscellaneous Javadoc cleanups to cut down on Eclipse warnings

Browse Source 
Change-Id: Ifd80c546641db979911e3339fa40ab3585ca69a1
This commit is contained in:
Dave Borowitz
2013-10-08 11:06:19 -07:00
parent 6da366f2b3
commit 23da0d9f13
24 changed files with 58 additions and 66 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
gerrit-server/src/main/java/com/google/gerrit/common/ChangeHooks.java
View File

@@ -167,7 +167,6 @@ public interface ChangeHooks {
* @param uploader The gerrit user running the command
* @param oldId The ref's old id
* @param newId The ref's new id
* @param account The gerrit user who moved the ref
*/
public HookResult doRefUpdateHook(Project project, String refName,
Account uploader, ObjectId oldId, ObjectId newId);

18
gerrit-server/src/main/java/com/google/gerrit/server/account/GroupBackends.java
View File

@@ -17,7 +17,6 @@ package com.google.gerrit.server.account;
import com.google.common.collect.Iterables;
import com.google.gerrit.common.Nullable;
import com.google.gerrit.common.data.GroupReference;
import com.google.gerrit.reviewdb.client.Project;
import com.google.gerrit.server.project.ProjectControl;
import java.util.Collection;
@@ -37,8 +36,8 @@ public class GroupBackends {
};
/**
* Runs {@link GroupBackend#suggest(String, Project)} and filters the result to return
* the best suggestion, or null if one does not exist.
* Runs {@link GroupBackend#suggest(String, ProjectControl)} and filters the
* result to return the best suggestion, or null if one does not exist.
*
* @param groupBackend the group backend
* @param name the name for which to suggest groups
@@ -49,9 +48,10 @@ public class GroupBackends {
String name) {
return findBestSuggestion(groupBackend, name, null);
}
/**
* Runs {@link GroupBackend#suggest(String, Project)} and filters the result to return
* the best suggestion, or null if one does not exist.
* Runs {@link GroupBackend#suggest(String, ProjectControl)} and filters the
* result to return the best suggestion, or null if one does not exist.
*
* @param groupBackend the group backend
* @param name the name for which to suggest groups
@@ -75,8 +75,8 @@ public class GroupBackends {
}
/**
* Runs {@link GroupBackend#suggest(String, Project)} and filters the result to return
* the exact suggestion, or null if one does not exist.
* Runs {@link GroupBackend#suggest(String, ProjectControl)} and filters the
* result to return the exact suggestion, or null if one does not exist.
*
* @param groupBackend the group backend
* @param name the name for which to suggest groups
@@ -89,8 +89,8 @@ public class GroupBackends {
}
/**
* Runs {@link GroupBackend#suggest(String, Project)} and filters the result to return
* the exact suggestion, or null if one does not exist.
* Runs {@link GroupBackend#suggest(String, ProjectControl)} and filters the
* result to return the exact suggestion, or null if one does not exist.
*
* @param groupBackend the group backend
* @param name the name for which to suggest groups

2
gerrit-server/src/main/java/com/google/gerrit/server/avatar/AvatarProvider.java
View File

@@ -42,7 +42,7 @@ public interface AvatarProvider {
/**
* Gets a URL for a user to modify their avatar image.
*
* @param user The user wishing to change their avatar image
* @param forUser The user wishing to change their avatar image
* @return a URL the user should visit to modify their avatar, or null if
* modification is not possible.
*/

2
gerrit-server/src/main/java/com/google/gerrit/server/git/validators/CommitValidationListener.java
View File

@@ -30,7 +30,7 @@ public interface CommitValidationListener {
/**
* Commit validation.
*
* @param received commit event details
* @param receiveEvent commit event details
* @return list of validation messages
* @throws CommitValidationException if validation fails
*/

2
gerrit-server/src/main/java/com/google/gerrit/server/git/validators/CommitValidators.java
View File

@@ -550,7 +550,7 @@ public class CommitValidators {
*
* @return the canonical URL (with any trailing slash removed) if it is
* configured, otherwise fall back to "http://hostname" where hostname
* is the value returned by {@link #getGerritHost()}.
* is the value returned by {@link #getGerritHost(String)}.
*/
private static String getGerritUrl(String canonicalWebUrl) {
if (canonicalWebUrl != null) {

16
gerrit-server/src/main/java/com/google/gerrit/server/query/change/PredicateArgs.java
View File

@@ -22,8 +22,8 @@ import java.util.List;
import java.util.Map;
/**
* This class is used to extract comma separated values in a predicate
*
* This class is used to extract comma separated values in a predicate.
* <p>
* If tags for the values are present (e.g. "branch=jb_2.3,vote=approved") then
* the args are placed in a map that maps tag to value (e.g., "branch" to "jb_2.3").
* If no tag is present (e.g. "jb_2.3,approved") then the args are placed into a
@@ -35,14 +35,12 @@ public class PredicateArgs {
public Map<String, String> keyValue;
/**
* Parses query arguments into keyValue and/or positional values
* labels for these arguments should be kept in ChangeQueryBuilder
* as ARG_ID_{argument name}.
* Parses query arguments into {@link #keyValue} and/or {@link #positional}..
* <p>
* Labels for these arguments should be kept in ChangeQueryBuilder
* as {@code ARG_ID_{argument name}}.
*
* @param args - arguments to be parsed
*
* @return - the static values keyValue and positional will contain
* the parsed values.
* @param args arguments to be parsed
* @throws QueryParseException
*/
PredicateArgs(String args) throws QueryParseException {

4
gerrit-server/src/main/java/com/google/gerrit/server/ssh/SshAdvertisedAddresses.java
View File

@@ -21,8 +21,8 @@ import com.google.inject.BindingAnnotation;
import java.lang.annotation.Retention;
/**
* Marker on the list of {@link SocketAddress}es configured to be advertised by
* the server.
* Marker on the list of {@link java.net.SocketAddress}es configured to be
* advertised by the server.
*/
@Retention(RUNTIME)
@BindingAnnotation

4
gerrit-server/src/main/java/com/google/gerrit/server/ssh/SshListenAddresses.java
View File

@@ -21,8 +21,8 @@ import com.google.inject.BindingAnnotation;
import java.lang.annotation.Retention;
/**
* Marker on the list of {@link SocketAddress}es on which the SSH daemon is
* configured to listen.
* Marker on the list of {@link java.net.SocketAddress}es on which the SSH
* daemon is configured to listen.
*/
@Retention(RUNTIME)
@BindingAnnotation