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 1388637ad3..7de740dc52 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,7 +67,9 @@ 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 abf944a4d3..b777899418 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,10 +67,12 @@ 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 82613c77f7..8bc39a51ae 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,7 +61,9 @@ 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-gwtexpui/src/main/java/com/google/gwtexpui/safehtml/client/SafeHtmlBuilder.java b/gerrit-gwtexpui/src/main/java/com/google/gwtexpui/safehtml/client/SafeHtmlBuilder.java index 69da38d396..0e7f7eb940 100644 --- a/gerrit-gwtexpui/src/main/java/com/google/gwtexpui/safehtml/client/SafeHtmlBuilder.java +++ b/gerrit-gwtexpui/src/main/java/com/google/gwtexpui/safehtml/client/SafeHtmlBuilder.java @@ -162,7 +162,7 @@ public class SafeHtmlBuilder extends SafeHtml { } /** - * Open an element, appending "" to the buffer. + * Open an element, appending "{@code }" to the buffer. *

* After the element is open the attributes may be manipulated until the next * {@code append}, {@code openElement}, {@code closeSelf} or 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 83120e0470..b85cdf0083 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 @@ -40,12 +40,14 @@ import javax.servlet.http.HttpServletResponse; *

* Versions of Git before 1.5.3 may require setting the username and port * properties in the user's {@code ~/.ssh/config} file, and using a host - * alias through a URL such as gerrit-alias:/tools/gerrit.git: + * alias through a URL such as {@code gerrit-alias:/tools/gerrit.git}: * 

+ * {@code
  * Host gerrit-alias
  *  User sop@google.com
  *  Hostname gerrit.com
  *  Port 8010
+ * }
  *
*/ @SuppressWarnings("serial") diff --git a/gerrit-server/src/main/java/com/google/gerrit/server/account/AccountsCollection.java b/gerrit-server/src/main/java/com/google/gerrit/server/account/AccountsCollection.java index efe73228a7..80a451a002 100644 --- a/gerrit-server/src/main/java/com/google/gerrit/server/account/AccountsCollection.java +++ b/gerrit-server/src/main/java/com/google/gerrit/server/account/AccountsCollection.java @@ -77,9 +77,9 @@ public class AccountsCollection implements * Parses a account ID from a request body and returns the user. * * @param id ID of the account, can be a string of the format - * "Full Name ", just the email address, a full name - * if it is unique, an account ID, a user name or 'self' for the - * calling user + * "{@code Full Name }", just the email address, + * a full name if it is unique, an account ID, a user name or + * "{@code self}" for the calling user * @return the user, never null. * @throws UnprocessableEntityException thrown if the account ID cannot be * resolved or if the account is not visible to the calling user @@ -102,9 +102,9 @@ public class AccountsCollection implements * check whether the current user can see the account. * * @param id ID of the account, can be a string of the format - * "Full Name ", just the email address, a full name - * if it is unique, an account ID, a user name or 'self' for the - * calling user + * "{@code Full Name }", just the email address, + * a full name if it is unique, an account ID, a user name or + * "{@code self}" for the calling user * @return the user, null if no user is found for the given account ID * @throws AuthException thrown if 'self' is used as account ID and the * current user is not authenticated diff --git a/gerrit-server/src/main/java/com/google/gerrit/server/change/ReviewerSuggestionCache.java b/gerrit-server/src/main/java/com/google/gerrit/server/change/ReviewerSuggestionCache.java index 554d7603e2..4120e43e1b 100644 --- a/gerrit-server/src/main/java/com/google/gerrit/server/change/ReviewerSuggestionCache.java +++ b/gerrit-server/src/main/java/com/google/gerrit/server/change/ReviewerSuggestionCache.java @@ -36,8 +36,8 @@ import java.util.concurrent.TimeUnit; /** * The suggest oracle may be called many times in rapid succession during the * course of one operation. - * It would be easy to have a simple Cache> with a short - * expiration time of 30s. + * It would be easy to have a simple {@code Cache>} + * with a short expiration time of 30s. * Cache only has a single key we're just using Cache for the expiration behavior. */ @Singleton diff --git a/gerrit-server/src/main/java/com/google/gerrit/server/config/PluginConfigFactory.java b/gerrit-server/src/main/java/com/google/gerrit/server/config/PluginConfigFactory.java index 375467427c..a437085026 100644 --- a/gerrit-server/src/main/java/com/google/gerrit/server/config/PluginConfigFactory.java +++ b/gerrit-server/src/main/java/com/google/gerrit/server/config/PluginConfigFactory.java @@ -239,13 +239,14 @@ public class PluginConfigFactory implements ReloadPluginListener { /** * Returns the configuration for the specified plugin that is stored in the - * plugin configuration file 'etc/.config'. + * plugin configuration file '{@code etc/.config}'. * * The plugin configuration is only loaded once and is then cached. * * @param pluginName the name of the plugin for which the configuration should * be returned - * @return the plugin configuration from the 'etc/.config' file + * @return the plugin configuration from the + * '{@code etc/.config}' file */ public synchronized Config getGlobalPluginConfig(String pluginName) { if (pluginConfigs.containsKey(pluginName)) { @@ -274,15 +275,15 @@ public class PluginConfigFactory implements ReloadPluginListener { /** * Returns the configuration for the specified plugin that is stored in the - * '.config' file in the 'refs/meta/config' branch of the - * specified project. + * '{@code .config}' file in the 'refs/meta/config' branch of + * the specified project. * * @param projectName the name of the project for which the plugin * configuration should be returned * @param pluginName the name of the plugin for which the configuration should * be returned - * @return the plugin configuration from the '.config' file of - * the specified project + * @return the plugin configuration from the '{@code .config}' + * file of the specified project * @throws NoSuchProjectException thrown if the specified project does not * exist */ @@ -293,15 +294,15 @@ public class PluginConfigFactory implements ReloadPluginListener { /** * Returns the configuration for the specified plugin that is stored in the - * '.config' file in the 'refs/meta/config' branch of the - * specified project. + * '{@code .config}' file in the 'refs/meta/config' branch of + * the specified project. * * @param projectState the project for which the plugin configuration should * be returned * @param pluginName the name of the plugin for which the configuration should * be returned - * @return the plugin configuration from the '.config' file of - * the specified project + * @return the plugin configuration from the '{@code .config}' + * file of the specified project */ public Config getProjectPluginConfig(ProjectState projectState, String pluginName) { @@ -310,10 +311,10 @@ public class PluginConfigFactory implements ReloadPluginListener { /** * Returns the configuration for the specified plugin that is stored in the - * '.config' file in the 'refs/meta/config' branch of the - * specified project. Parameters which are not set in the - * '.config' of this project are inherited from the parent - * project's '.config' files. + * '{@code .config}' file in the 'refs/meta/config' branch of + * the specified project. Parameters which are not set in the + * '{@code .config}' of this project are inherited from the + * parent project's '{@code .config}' files. * * E.g.: child project: [mySection "mySubsection"] myKey = childValue * @@ -327,9 +328,9 @@ public class PluginConfigFactory implements ReloadPluginListener { * configuration should be returned * @param pluginName the name of the plugin for which the configuration should * be returned - * @return the plugin configuration from the '.config' file of - * the specified project with inheriting non-set parameters from the - * parent projects + * @return the plugin configuration from the '{@code .config}' + * file of the specified project with inheriting non-set parameters + * from the parent projects * @throws NoSuchProjectException thrown if the specified project does not * exist */ @@ -340,10 +341,10 @@ public class PluginConfigFactory implements ReloadPluginListener { /** * Returns the configuration for the specified plugin that is stored in the - * '.config' file in the 'refs/meta/config' branch of the - * specified project. Parameters which are not set in the - * '.config' of this project are inherited from the parent - * project's '.config' files. + * '{@code .config}' file in the 'refs/meta/config' branch of + * the specified project. Parameters which are not set in the + * '{@code .config}' of this project are inherited from the + * parent project's '{@code .config}' files. * * E.g.: child project: [mySection "mySubsection"] myKey = childValue * @@ -357,9 +358,9 @@ public class PluginConfigFactory implements ReloadPluginListener { * be returned * @param pluginName the name of the plugin for which the configuration should * be returned - * @return the plugin configuration from the '.config' file of - * the specified project with inheriting non-set parameters from the - * parent projects + * @return the plugin configuration from the '{@code .config}' + * file of the specified project with inheriting non-set parameters + * from the parent projects */ public Config getProjectPluginConfigWithInheritance(ProjectState projectState, String pluginName) { diff --git a/gerrit-server/src/main/java/com/google/gerrit/server/plugins/PluginEntry.java b/gerrit-server/src/main/java/com/google/gerrit/server/plugins/PluginEntry.java index 7242e98289..74ded733a7 100644 --- a/gerrit-server/src/main/java/com/google/gerrit/server/plugins/PluginEntry.java +++ b/gerrit-server/src/main/java/com/google/gerrit/server/plugins/PluginEntry.java @@ -23,7 +23,7 @@ import java.util.Map; * Plugin static resource entry * * Bean representing a static resource inside a plugin. - * All static resources are available at /static + * All static resources are available at {@code /static} * and served by the HttpPluginServlet. */ public class PluginEntry { diff --git a/gerrit-server/src/main/java/com/google/gerrit/server/util/RangeUtil.java b/gerrit-server/src/main/java/com/google/gerrit/server/util/RangeUtil.java index adacb2191d..92873d37da 100644 --- a/gerrit-server/src/main/java/com/google/gerrit/server/util/RangeUtil.java +++ b/gerrit-server/src/main/java/com/google/gerrit/server/util/RangeUtil.java @@ -46,7 +46,7 @@ public final class RangeUtil { /** * Determine the range of values being requested in the given query. * - * @param rangeQuery the raw query, e.g. "added:>12345" + * @param rangeQuery the raw query, e.g. "{@code added:>12345}" * @param minValue the minimum possible value for the field, inclusive * @param maxValue the maximum possible value for the field, inclusive * @return the calculated {@link Range}, or null if the query is invalid 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 39eb720c9b..e400fd4240 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 @@ -135,12 +135,14 @@ import java.util.List; *

* Versions of Git before 1.5.3 may require setting the username and port * properties in the user's {@code ~/.ssh/config} file, and using a host - * alias through a URL such as gerrit-alias:/tools/gerrit.git: + * alias through a URL such as {@code gerrit-alias:/tools/gerrit.git}: * 

+ * {@code
  * Host gerrit-alias
  *  User sop@google.com
  *  Hostname gerrit.com
  *  Port 8010
+ * }
  *
*/ @Singleton