Fix warnings when generating JavaDoc
Change-Id: Ie3606db7c10141339e99bd97806066c251338cdc Signed-off-by: Edwin Kempin <edwin.kempin@sap.com>
This commit is contained in:
		
				
					committed by
					
						
						Shawn Pearce
					
				
			
			
				
	
			
			
			
						parent
						
							bb360ebe06
						
					
				
				
					commit
					74066d9e10
				
			@@ -24,7 +24,7 @@ public enum CapabilityScope {
 | 
				
			|||||||
   *
 | 
					   *
 | 
				
			||||||
   * If {@code @RequiresCapability} is used within the core Gerrit Code Review
 | 
					   * If {@code @RequiresCapability} is used within the core Gerrit Code Review
 | 
				
			||||||
   * server (and thus is outside of a plugin) the scope is the core server and
 | 
					   * server (and thus is outside of a plugin) the scope is the core server and
 | 
				
			||||||
   * will use {@link com.google.gerrit.common.data.GlobalCapability}.
 | 
					   * will use {@code com.google.gerrit.common.data.GlobalCapability}.
 | 
				
			||||||
   */
 | 
					   */
 | 
				
			||||||
  CONTEXT,
 | 
					  CONTEXT,
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 
 | 
				
			|||||||
@@ -28,19 +28,19 @@ import java.lang.annotation.Target;
 | 
				
			|||||||
 * Plugins or extensions using auto-registration should apply this annotation to
 | 
					 * Plugins or extensions using auto-registration should apply this annotation to
 | 
				
			||||||
 * any non-abstract class they want exported for access.
 | 
					 * any non-abstract class they want exported for access.
 | 
				
			||||||
 * <p>
 | 
					 * <p>
 | 
				
			||||||
 * For SSH commands the @Export annotation names the subcommand:
 | 
					 * For SSH commands the {@literal @Export} annotation names the subcommand:
 | 
				
			||||||
 *
 | 
					 *
 | 
				
			||||||
 * <pre>
 | 
					 * <pre>
 | 
				
			||||||
 *   @Export("print")
 | 
					 *   {@literal @Export("print")}
 | 
				
			||||||
 *   class MyCommand extends SshCommand {
 | 
					 *   class MyCommand extends SshCommand {
 | 
				
			||||||
 * </pre>
 | 
					 * </pre>
 | 
				
			||||||
 *
 | 
					 *
 | 
				
			||||||
 * For HTTP servlets, the @Export annotation names the URL the servlet is bound
 | 
					 * For HTTP servlets, the {@literal @Export} annotation names the URL the
 | 
				
			||||||
 * to, relative to the plugin or extension's namespace within the Gerrit
 | 
					 * servlet is bound to, relative to the plugin or extension's namespace within
 | 
				
			||||||
 * container.
 | 
					 * the Gerrit container.
 | 
				
			||||||
 *
 | 
					 *
 | 
				
			||||||
 * <pre>
 | 
					 * <pre>
 | 
				
			||||||
 *  @Export("/index.html")
 | 
					 *  {@literal @Export("/index.html")}
 | 
				
			||||||
 *  class ShowIndexHtml extends HttpServlet {
 | 
					 *  class ShowIndexHtml extends HttpServlet {
 | 
				
			||||||
 * </pre>
 | 
					 * </pre>
 | 
				
			||||||
 */
 | 
					 */
 | 
				
			||||||
 
 | 
				
			|||||||
@@ -29,7 +29,7 @@ import java.lang.annotation.Target;
 | 
				
			|||||||
 * the canonical web URL under which the plugin is available:
 | 
					 * the canonical web URL under which the plugin is available:
 | 
				
			||||||
 *
 | 
					 *
 | 
				
			||||||
 * <pre>
 | 
					 * <pre>
 | 
				
			||||||
 *  @Inject
 | 
					 *  {@literal @Inject}
 | 
				
			||||||
 *  MyType(@PluginCanonicalWebUrl String myUrl) {
 | 
					 *  MyType(@PluginCanonicalWebUrl String myUrl) {
 | 
				
			||||||
 *  ...
 | 
					 *  ...
 | 
				
			||||||
 *  }
 | 
					 *  }
 | 
				
			||||||
 
 | 
				
			|||||||
@@ -29,7 +29,7 @@ import java.lang.annotation.Target;
 | 
				
			|||||||
 * a directory where it can store configuration or other data that is private:
 | 
					 * a directory where it can store configuration or other data that is private:
 | 
				
			||||||
 *
 | 
					 *
 | 
				
			||||||
 * <pre>
 | 
					 * <pre>
 | 
				
			||||||
 * @Inject
 | 
					 * {@literal @Inject}
 | 
				
			||||||
 * MyType(@PluginData java.io.File myDir) {
 | 
					 * MyType(@PluginData java.io.File myDir) {
 | 
				
			||||||
 *   new FileInputStream(new File(myDir, "my.config"));
 | 
					 *   new FileInputStream(new File(myDir, "my.config"));
 | 
				
			||||||
 * }
 | 
					 * }
 | 
				
			||||||
 
 | 
				
			|||||||
@@ -29,7 +29,7 @@ import java.lang.annotation.Target;
 | 
				
			|||||||
 * the name that an administrator has installed the plugin or extension under:
 | 
					 * the name that an administrator has installed the plugin or extension under:
 | 
				
			||||||
 *
 | 
					 *
 | 
				
			||||||
 * <pre>
 | 
					 * <pre>
 | 
				
			||||||
 *  @Inject
 | 
					 *  {@literal @Inject}
 | 
				
			||||||
 *  MyType(@PluginName String myName) {
 | 
					 *  MyType(@PluginName String myName) {
 | 
				
			||||||
 *  ...
 | 
					 *  ...
 | 
				
			||||||
 *  }
 | 
					 *  }
 | 
				
			||||||
 
 | 
				
			|||||||
@@ -21,8 +21,8 @@ import java.lang.annotation.Retention;
 | 
				
			|||||||
import java.lang.annotation.Target;
 | 
					import java.lang.annotation.Target;
 | 
				
			||||||
 | 
					
 | 
				
			||||||
/**
 | 
					/**
 | 
				
			||||||
 * Annotation on {@link com.google.gerrit.sshd.SshCommand} or
 | 
					 * Annotation on {@code com.google.gerrit.sshd.SshCommand} or
 | 
				
			||||||
 * {@link com.google.gerrit.httpd.restapi.RestApiServlet} declaring a
 | 
					 * {@code com.google.gerrit.httpd.restapi.RestApiServlet} declaring a
 | 
				
			||||||
 * capability must be granted.
 | 
					 * capability must be granted.
 | 
				
			||||||
 */
 | 
					 */
 | 
				
			||||||
@Target({ElementType.TYPE})
 | 
					@Target({ElementType.TYPE})
 | 
				
			||||||
 
 | 
				
			|||||||
@@ -17,7 +17,7 @@ import java.net.HttpURLConnection;
 | 
				
			|||||||
import java.net.URL;
 | 
					import java.net.URL;
 | 
				
			||||||
import java.net.URLConnection;
 | 
					import java.net.URLConnection;
 | 
				
			||||||
 | 
					
 | 
				
			||||||
/** {@link ContactStoreConnection} with an underlying {@HttpURLConnection}. */
 | 
					/** {@link ContactStoreConnection} with an underlying {@literal @HttpURLConnection}. */
 | 
				
			||||||
public class HttpContactStoreConnection implements ContactStoreConnection {
 | 
					public class HttpContactStoreConnection implements ContactStoreConnection {
 | 
				
			||||||
  public static Module module() {
 | 
					  public static Module module() {
 | 
				
			||||||
    return new AbstractModule() {
 | 
					    return new AbstractModule() {
 | 
				
			||||||
 
 | 
				
			|||||||
@@ -24,7 +24,7 @@ import com.google.gerrit.server.index.ChangeIndexer;
 | 
				
			|||||||
 | 
					
 | 
				
			||||||
import org.eclipse.jgit.lib.ObjectInserter;
 | 
					import org.eclipse.jgit.lib.ObjectInserter;
 | 
				
			||||||
import org.eclipse.jgit.lib.PersonIdent;
 | 
					import org.eclipse.jgit.lib.PersonIdent;
 | 
				
			||||||
import org.eclipse.jgit.lib.RefUpdate;
 | 
					import org.eclipse.jgit.lib.RefUpdate.Result;
 | 
				
			||||||
import org.eclipse.jgit.lib.Repository;
 | 
					import org.eclipse.jgit.lib.Repository;
 | 
				
			||||||
import org.eclipse.jgit.revwalk.RevCommit;
 | 
					import org.eclipse.jgit.revwalk.RevCommit;
 | 
				
			||||||
import org.eclipse.jgit.revwalk.RevFlag;
 | 
					import org.eclipse.jgit.revwalk.RevFlag;
 | 
				
			||||||
@@ -164,12 +164,12 @@ public abstract class SubmitStrategy {
 | 
				
			|||||||
 | 
					
 | 
				
			||||||
  /**
 | 
					  /**
 | 
				
			||||||
   * Returns whether a merge that failed with
 | 
					   * Returns whether a merge that failed with
 | 
				
			||||||
   * {@link RefUpdate.Result#LOCK_FAILURE} should be retried.
 | 
					   * {@link Result#LOCK_FAILURE} should be retried.
 | 
				
			||||||
   *
 | 
					   *
 | 
				
			||||||
   * May be overwritten by subclasses.
 | 
					   * May be overwritten by subclasses.
 | 
				
			||||||
   *
 | 
					   *
 | 
				
			||||||
   * @return <code>true</code> if a merge that failed with
 | 
					   * @return <code>true</code> if a merge that failed with
 | 
				
			||||||
   *         {@link RefUpdate.Result#LOCK_FAILURE} should be retried, otherwise
 | 
					   *         {@link Result#LOCK_FAILURE} should be retried, otherwise
 | 
				
			||||||
   *         <code>false</code>
 | 
					   *         <code>false</code>
 | 
				
			||||||
   */
 | 
					   */
 | 
				
			||||||
  public boolean retryOnLockFailure() {
 | 
					  public boolean retryOnLockFailure() {
 | 
				
			||||||
 
 | 
				
			|||||||
@@ -40,7 +40,7 @@ import java.util.List;
 | 
				
			|||||||
 * other predicates should override {@link #getChildren()} to return the list of
 | 
					 * other predicates should override {@link #getChildren()} to return the list of
 | 
				
			||||||
 * children nested within the predicate.
 | 
					 * children nested within the predicate.
 | 
				
			||||||
 *
 | 
					 *
 | 
				
			||||||
 * @type <T> type of object the predicate can evaluate in memory.
 | 
					 * @param <T> type of object the predicate can evaluate in memory.
 | 
				
			||||||
 */
 | 
					 */
 | 
				
			||||||
public abstract class Predicate<T> {
 | 
					public abstract class Predicate<T> {
 | 
				
			||||||
  /** A predicate that matches any input, always, with no cost. */
 | 
					  /** A predicate that matches any input, always, with no cost. */
 | 
				
			||||||
 
 | 
				
			|||||||
@@ -51,7 +51,7 @@ import java.util.Map;
 | 
				
			|||||||
 * Rewrite methods are applied in order by declared name, so naming methods with
 | 
					 * Rewrite methods are applied in order by declared name, so naming methods with
 | 
				
			||||||
 * a numeric prefix to ensure a specific ordering (if required) is suggested.
 | 
					 * a numeric prefix to ensure a specific ordering (if required) is suggested.
 | 
				
			||||||
 *
 | 
					 *
 | 
				
			||||||
 * @type <T> type of object the predicate can evaluate in memory.
 | 
					 * @param <T> type of object the predicate can evaluate in memory.
 | 
				
			||||||
 */
 | 
					 */
 | 
				
			||||||
public abstract class QueryRewriter<T> {
 | 
					public abstract class QueryRewriter<T> {
 | 
				
			||||||
  /**
 | 
					  /**
 | 
				
			||||||
 
 | 
				
			|||||||
@@ -18,6 +18,7 @@ import static com.google.common.base.Preconditions.checkArgument;
 | 
				
			|||||||
 | 
					
 | 
				
			||||||
import com.google.common.collect.ImmutableBiMap;
 | 
					import com.google.common.collect.ImmutableBiMap;
 | 
				
			||||||
import com.google.gerrit.reviewdb.client.Change;
 | 
					import com.google.gerrit.reviewdb.client.Change;
 | 
				
			||||||
 | 
					import com.google.gerrit.reviewdb.client.Change.Status;
 | 
				
			||||||
import com.google.gerrit.reviewdb.server.ReviewDb;
 | 
					import com.google.gerrit.reviewdb.server.ReviewDb;
 | 
				
			||||||
import com.google.gerrit.server.index.ChangeField;
 | 
					import com.google.gerrit.server.index.ChangeField;
 | 
				
			||||||
import com.google.gerrit.server.index.IndexPredicate;
 | 
					import com.google.gerrit.server.index.IndexPredicate;
 | 
				
			||||||
@@ -29,7 +30,7 @@ import java.util.ArrayList;
 | 
				
			|||||||
import java.util.List;
 | 
					import java.util.List;
 | 
				
			||||||
 | 
					
 | 
				
			||||||
/**
 | 
					/**
 | 
				
			||||||
 * Predicate for a {@link Change.Status}.
 | 
					 * Predicate for a {@link Status}.
 | 
				
			||||||
 * <p>
 | 
					 * <p>
 | 
				
			||||||
 * The actual name of this operator can differ, it usually comes as {@code
 | 
					 * The actual name of this operator can differ, it usually comes as {@code
 | 
				
			||||||
 * status:} but may also be {@code is:} to help do-what-i-meanery for end-users
 | 
					 * status:} but may also be {@code is:} to help do-what-i-meanery for end-users
 | 
				
			||||||
 
 | 
				
			|||||||
		Reference in New Issue
	
	Block a user