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
This commit is contained in:
Dave Borowitz 2015-06-12 14:44:37 -04:00 committed by David Pursehouse
parent 408f004e21
commit 450b7d5cde
11 changed files with 22 additions and 14 deletions

View File

@ -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

View File

@ -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 <code>Hello ${user}</code>. */
public class ParameterizedString {
/** Obtain a string which has no parameters and always produces the value. */
public static ParameterizedString asis(final String constant) {

View File

@ -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;

View File

@ -67,9 +67,7 @@ public class DynamicItem<T> {
* <p>
* Items must be defined in a Guice module before they can be bound:
* <pre>
* {@code
* DynamicSet.itemOf(binder(), new TypeLiteral<Thing<Foo>>() {});
* }
* </pre>
*
* @param binder a new binder created in the module.

View File

@ -67,12 +67,10 @@ public abstract class DynamicMap<T> implements Iterable<DynamicMap.Entry<T>> {
* Maps must be defined in a Guice module before they can be bound:
*
* <pre>
* {@code
* DynamicMap.mapOf(binder(), new TypeLiteral<Thing<Bar>>(){});
* bind(new TypeLiteral<Thing<Bar>>() {})
* .annotatedWith(Exports.named(&quot;foo&quot;))
* .to(Impl.class);
* }
* </pre>
*
* @param binder a new binder created in the module.

View File

@ -61,9 +61,7 @@ public class DynamicSet<T> implements Iterable<T> {
* <p>
* Sets must be defined in a Guice module before they can be bound:
* <pre>
* {@code
* DynamicSet.setOf(binder(), new TypeLiteral<Thing<Foo>>() {});
* }
* </pre>
*
* @param binder a new binder created in the module.

View File

@ -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 = "<unknown>";

View File

@ -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<GroupInfo> {
public static void my(AsyncCallback<GroupList> callback) {
new RestApi("/accounts/self/groups").get(callback);

View File

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

View File

@ -38,7 +38,7 @@ public class PredicateArgs {
* 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}}.
* as {@code ARG_ID_[argument name]}.
*
* @param args arguments to be parsed
* @throws QueryParseException

View File

@ -129,7 +129,7 @@ import java.util.List;
/**
* SSH daemon to communicate with Gerrit.
* <p>
* Use a Git URL such as {@code ssh://${email}@${host}:${port}/${path}},
* Use a Git URL such as <code>ssh://${email}@${host}:${port}/${path}</code>,
* e.g. {@code ssh://sop@google.com@gerrit.com:8010/tools/gerrit.git} to
* access the SSH daemon itself.
* <p>