From 450b7d5cde4e16b4557ed8a01a0ba57db0762b06 Mon Sep 17 00:00:00 2001 From: Dave Borowitz Date: Fri, 12 Jun 2015 14:44:37 -0400 Subject: [PATCH] Enable Eclipse Javadoc warnings about malformed syntax Fix warnings about unmatched {} in inline tags. Enabling any more than this set of warnings introduces hundreds of warnings about things like missing @throws tags, which we may want to fix, but is a lot more work. Change-Id: Ic671fb600d2e1ba49b7e855158811c6c98b6cda1 --- .settings/org.eclipse.jdt.core.prefs | 14 ++++++++++++++ .../gerrit/common/data/ParameterizedString.java | 2 +- .../gerrit/extensions/api/changes/ReviewInput.java | 2 +- .../extensions/registration/DynamicItem.java | 2 -- .../gerrit/extensions/registration/DynamicMap.java | 2 -- .../gerrit/extensions/registration/DynamicSet.java | 2 -- .../com/google/gerrit/client/api/PluginName.java | 2 +- .../com/google/gerrit/client/groups/GroupList.java | 2 +- .../google/gerrit/httpd/raw/SshInfoServlet.java | 4 ++-- .../gerrit/server/query/change/PredicateArgs.java | 2 +- .../java/com/google/gerrit/sshd/SshDaemon.java | 2 +- 11 files changed, 22 insertions(+), 14 deletions(-) diff --git a/.settings/org.eclipse.jdt.core.prefs b/.settings/org.eclipse.jdt.core.prefs index 0fa494d319..f66a0ff3c6 100644 --- a/.settings/org.eclipse.jdt.core.prefs +++ b/.settings/org.eclipse.jdt.core.prefs @@ -7,6 +7,7 @@ org.eclipse.jdt.core.compiler.annotation.nullable=org.eclipse.jdt.annotation.Nul org.eclipse.jdt.core.compiler.annotation.nullanalysis=disabled org.eclipse.jdt.core.compiler.codegen.targetPlatform=1.7 org.eclipse.jdt.core.compiler.compliance=1.7 +org.eclipse.jdt.core.compiler.doc.comment.support=enabled org.eclipse.jdt.core.compiler.problem.annotationSuperInterface=ignore org.eclipse.jdt.core.compiler.problem.autoboxing=ignore org.eclipse.jdt.core.compiler.problem.comparingIdentical=warning @@ -28,12 +29,25 @@ org.eclipse.jdt.core.compiler.problem.includeNullInfoFromAsserts=disabled org.eclipse.jdt.core.compiler.problem.incompatibleNonInheritedInterfaceMethod=warning org.eclipse.jdt.core.compiler.problem.incompleteEnumSwitch=warning org.eclipse.jdt.core.compiler.problem.indirectStaticAccess=ignore +org.eclipse.jdt.core.compiler.problem.invalidJavadoc=warning +org.eclipse.jdt.core.compiler.problem.invalidJavadocTags=enabled +org.eclipse.jdt.core.compiler.problem.invalidJavadocTagsDeprecatedRef=enabled +org.eclipse.jdt.core.compiler.problem.invalidJavadocTagsNotVisibleRef=enabled +org.eclipse.jdt.core.compiler.problem.invalidJavadocTagsVisibility=private org.eclipse.jdt.core.compiler.problem.localVariableHiding=ignore org.eclipse.jdt.core.compiler.problem.methodWithConstructorName=warning org.eclipse.jdt.core.compiler.problem.missingDefaultCase=ignore org.eclipse.jdt.core.compiler.problem.missingDeprecatedAnnotation=ignore org.eclipse.jdt.core.compiler.problem.missingEnumCaseDespiteDefault=disabled org.eclipse.jdt.core.compiler.problem.missingHashCodeMethod=warning +org.eclipse.jdt.core.compiler.problem.missingJavadocComments=ignore +org.eclipse.jdt.core.compiler.problem.missingJavadocCommentsOverriding=disabled +org.eclipse.jdt.core.compiler.problem.missingJavadocCommentsVisibility=public +org.eclipse.jdt.core.compiler.problem.missingJavadocTagDescription=return_tag +org.eclipse.jdt.core.compiler.problem.missingJavadocTags=ignore +org.eclipse.jdt.core.compiler.problem.missingJavadocTagsMethodTypeParameters=disabled +org.eclipse.jdt.core.compiler.problem.missingJavadocTagsOverriding=disabled +org.eclipse.jdt.core.compiler.problem.missingJavadocTagsVisibility=protected org.eclipse.jdt.core.compiler.problem.missingOverrideAnnotation=warning org.eclipse.jdt.core.compiler.problem.missingOverrideAnnotationForInterfaceMethodImplementation=enabled org.eclipse.jdt.core.compiler.problem.missingSerialVersion=warning diff --git a/gerrit-common/src/main/java/com/google/gerrit/common/data/ParameterizedString.java b/gerrit-common/src/main/java/com/google/gerrit/common/data/ParameterizedString.java index 4ed296fc7e..a92af2b441 100644 --- a/gerrit-common/src/main/java/com/google/gerrit/common/data/ParameterizedString.java +++ b/gerrit-common/src/main/java/com/google/gerrit/common/data/ParameterizedString.java @@ -21,7 +21,7 @@ import java.util.HashMap; import java.util.List; import java.util.Map; -/** Performs replacements on strings such as {@code Hello ${user}}. */ +/** Performs replacements on strings such as Hello ${user}. */ public class ParameterizedString { /** Obtain a string which has no parameters and always produces the value. */ public static ParameterizedString asis(final String constant) { diff --git a/gerrit-extension-api/src/main/java/com/google/gerrit/extensions/api/changes/ReviewInput.java b/gerrit-extension-api/src/main/java/com/google/gerrit/extensions/api/changes/ReviewInput.java index 2d2e4e96b5..873c560fb9 100644 --- a/gerrit-extension-api/src/main/java/com/google/gerrit/extensions/api/changes/ReviewInput.java +++ b/gerrit-extension-api/src/main/java/com/google/gerrit/extensions/api/changes/ReviewInput.java @@ -21,7 +21,7 @@ import java.util.LinkedHashMap; import java.util.List; import java.util.Map; -/** Input passed to {@code POST /changes/{id}/revisions/{id}/review}. */ +/** Input passed to {@code POST /changes/[id]/revisions/[id]/review}. */ public class ReviewInput { @DefaultInput public String message; diff --git a/gerrit-extension-api/src/main/java/com/google/gerrit/extensions/registration/DynamicItem.java b/gerrit-extension-api/src/main/java/com/google/gerrit/extensions/registration/DynamicItem.java index 7de740dc52..1388637ad3 100644 --- a/gerrit-extension-api/src/main/java/com/google/gerrit/extensions/registration/DynamicItem.java +++ b/gerrit-extension-api/src/main/java/com/google/gerrit/extensions/registration/DynamicItem.java @@ -67,9 +67,7 @@ public class DynamicItem { *

* Items must be defined in a Guice module before they can be bound: * 

-   * {@code
    *   DynamicSet.itemOf(binder(), new TypeLiteral>() {});
-   * }
    *
* * @param binder a new binder created in the module. diff --git a/gerrit-extension-api/src/main/java/com/google/gerrit/extensions/registration/DynamicMap.java b/gerrit-extension-api/src/main/java/com/google/gerrit/extensions/registration/DynamicMap.java index b777899418..abf944a4d3 100644 --- a/gerrit-extension-api/src/main/java/com/google/gerrit/extensions/registration/DynamicMap.java +++ b/gerrit-extension-api/src/main/java/com/google/gerrit/extensions/registration/DynamicMap.java @@ -67,12 +67,10 @@ public abstract class DynamicMap implements Iterable> { * Maps must be defined in a Guice module before they can be bound: * * 
-   * {@code
    * DynamicMap.mapOf(binder(), new TypeLiteral>(){});
    * bind(new TypeLiteral>() {})
    *   .annotatedWith(Exports.named("foo"))
    *   .to(Impl.class);
-   * }
    *
* * @param binder a new binder created in the module. diff --git a/gerrit-extension-api/src/main/java/com/google/gerrit/extensions/registration/DynamicSet.java b/gerrit-extension-api/src/main/java/com/google/gerrit/extensions/registration/DynamicSet.java index 8bc39a51ae..82613c77f7 100644 --- a/gerrit-extension-api/src/main/java/com/google/gerrit/extensions/registration/DynamicSet.java +++ b/gerrit-extension-api/src/main/java/com/google/gerrit/extensions/registration/DynamicSet.java @@ -61,9 +61,7 @@ public class DynamicSet implements Iterable { *

* Sets must be defined in a Guice module before they can be bound: * 

-   * {@code
    *   DynamicSet.setOf(binder(), new TypeLiteral>() {});
-   * }
    *
* * @param binder a new binder created in the module. diff --git a/gerrit-gwtui/src/main/java/com/google/gerrit/client/api/PluginName.java b/gerrit-gwtui/src/main/java/com/google/gerrit/client/api/PluginName.java index 67b8a980a9..a560711cdc 100644 --- a/gerrit-gwtui/src/main/java/com/google/gerrit/client/api/PluginName.java +++ b/gerrit-gwtui/src/main/java/com/google/gerrit/client/api/PluginName.java @@ -25,7 +25,7 @@ import com.google.gwt.core.client.JsArrayString; * JavaScript call stack and identifying the URL of the script file calling * {@code Gerrit.install()}. The simple approach applied here is looking at * the source URLs and extracting the name out of the string, e.g.: - * {@code "http://localhost:8080/plugins/{name}/static/foo.js"}. + * {@code "http://localhost:8080/plugins/[name]/static/foo.js"}. */ class PluginName { private static final String UNKNOWN = ""; diff --git a/gerrit-gwtui/src/main/java/com/google/gerrit/client/groups/GroupList.java b/gerrit-gwtui/src/main/java/com/google/gerrit/client/groups/GroupList.java index 94e5e58bee..a24e1dc245 100644 --- a/gerrit-gwtui/src/main/java/com/google/gerrit/client/groups/GroupList.java +++ b/gerrit-gwtui/src/main/java/com/google/gerrit/client/groups/GroupList.java @@ -19,7 +19,7 @@ import com.google.gerrit.reviewdb.client.AccountGroup; import com.google.gwt.core.client.JsArray; import com.google.gwt.user.client.rpc.AsyncCallback; -/** Groups available from {@code /groups/} or {@code /accounts/{id}/groups}. */ +/** Groups available from {@code /groups/} or {@code /accounts/[id]/groups}. */ public class GroupList extends JsArray { public static void my(AsyncCallback callback) { new RestApi("/accounts/self/groups").get(callback); diff --git a/gerrit-httpd/src/main/java/com/google/gerrit/httpd/raw/SshInfoServlet.java b/gerrit-httpd/src/main/java/com/google/gerrit/httpd/raw/SshInfoServlet.java index b85cdf0083..888b3fb58d 100644 --- a/gerrit-httpd/src/main/java/com/google/gerrit/httpd/raw/SshInfoServlet.java +++ b/gerrit-httpd/src/main/java/com/google/gerrit/httpd/raw/SshInfoServlet.java @@ -32,9 +32,9 @@ import javax.servlet.http.HttpServletResponse; /** * Servlet hosting an SSH daemon on another port. During a standard HTTP GET * request the servlet returns the hostname and port number back to the client - * in the form {@code ${host} ${port}}. + * in the form ${host} ${port}. *

- * Use a Git URL such as {@code ssh://${email}@${host}:${port}/${path}}, + * Use a Git URL such as ssh://${email}@${host}:${port}/${path}, * e.g. {@code ssh://sop@google.com@gerrit.com:8010/tools/gerrit.git} to * access the SSH daemon itself. *

diff --git a/gerrit-server/src/main/java/com/google/gerrit/server/query/change/PredicateArgs.java b/gerrit-server/src/main/java/com/google/gerrit/server/query/change/PredicateArgs.java index 3e794b7945..23350d2477 100644 --- a/gerrit-server/src/main/java/com/google/gerrit/server/query/change/PredicateArgs.java +++ b/gerrit-server/src/main/java/com/google/gerrit/server/query/change/PredicateArgs.java @@ -38,7 +38,7 @@ public class PredicateArgs { * Parses query arguments into {@link #keyValue} and/or {@link #positional}.. *

* Labels for these arguments should be kept in ChangeQueryBuilder - * as {@code ARG_ID_{argument name}}. + * as {@code ARG_ID_[argument name]}. * * @param args arguments to be parsed * @throws QueryParseException diff --git a/gerrit-sshd/src/main/java/com/google/gerrit/sshd/SshDaemon.java b/gerrit-sshd/src/main/java/com/google/gerrit/sshd/SshDaemon.java index 33ffb47ffb..935a2905b2 100644 --- a/gerrit-sshd/src/main/java/com/google/gerrit/sshd/SshDaemon.java +++ b/gerrit-sshd/src/main/java/com/google/gerrit/sshd/SshDaemon.java @@ -129,7 +129,7 @@ import java.util.List; /** * SSH daemon to communicate with Gerrit. *

- * Use a Git URL such as {@code ssh://${email}@${host}:${port}/${path}}, + * Use a Git URL such as ssh://${email}@${host}:${port}/${path}, * e.g. {@code ssh://sop@google.com@gerrit.com:8010/tools/gerrit.git} to * access the SSH daemon itself. *