Replace <code> with {@code} in javadoc

{@code foo} is shorter and easier to read and write than
<code>foo</code>, which is why it was introduced years ago in the
javadoc processor.  Make consistent use of it throughout the
documentation comments.

Change-Id: I59d428cb6c5015453629398b0697891b83c8e91d
This commit is contained in:
Shawn Pearce 2013-11-24 13:12:17 -08:00
parent b112635e9a
commit dd218662c0
43 changed files with 97 additions and 97 deletions

View File

@ -87,10 +87,10 @@ public class AccountInfo {
* <p> * <p>
* Example output: * Example output:
* <ul> * <ul>
* <li><code>A U. Thor &lt;author@example.com&gt;</code>: full populated</li> * <li>{@code A U. Thor &lt;author@example.com&gt;}: full populated</li>
* <li><code>A U. Thor (12)</code>: missing email address</li> * <li>{@code A U. Thor (12)}: missing email address</li>
* <li><code>Anonymous Coward &lt;author@example.com&gt;</code>: missing name</li> * <li>{@code Anonymous Coward &lt;author@example.com&gt;}: missing name</li>
* <li><code>Anonymous Coward (12)</code>: missing name and email address</li> * <li>{@code Anonymous Coward (12)}: missing name and email address</li>
* </ul> * </ul>
*/ */
public String getNameEmail(String anonymousCowardName) { public String getNameEmail(String anonymousCowardName) {

View File

@ -50,9 +50,9 @@ public class AccountInfoCache {
* <p> * <p>
* The return value can take on one of three forms: * The return value can take on one of three forms:
* <ul> * <ul>
* <li><code>null</code>, if <code>id == null</code>.</li> * <li>{@code null}, if {@code id == null}.</li>
* <li>a valid info block, if <code>id</code> was loaded.</li> * <li>a valid info block, if {@code id} was loaded.</li>
* <li>an anonymous info block, if <code>id</code> was not loaded.</li> * <li>an anonymous info block, if {@code id} was not loaded.</li>
* </ul> * </ul>
* *
* @param id the id desired. * @param id the id desired.

View File

@ -148,7 +148,7 @@ public class CommentDetail {
} }
/** /**
* Add the comments to <code>outResult</code>, depth first * Add the comments to {@code outResult}, depth first
*/ */
private static void addChildren(Map<String, List<PatchLineComment>> parentMap, private static void addChildren(Map<String, List<PatchLineComment>> parentMap,
List<PatchLineComment> children, List<PatchLineComment> outResult) { List<PatchLineComment> children, List<PatchLineComment> outResult) {

View File

@ -50,9 +50,9 @@ public class GroupInfoCache {
* <p> * <p>
* The return value can take on one of three forms: * The return value can take on one of three forms:
* <ul> * <ul>
* <li><code>null</code>, if <code>id == null</code>.</li> * <li>{@code null}, if {@code id == null}.</li>
* <li>a valid info block, if <code>id</code> was loaded.</li> * <li>a valid info block, if {@code id} was loaded.</li>
* <li>an anonymous info block, if <code>id</code> was not loaded.</li> * <li>an anonymous info block, if {@code id} was not loaded.</li>
* </ul> * </ul>
* *
* @param uuid the id desired. * @param uuid the id desired.

View File

@ -21,7 +21,7 @@ import java.util.HashMap;
import java.util.List; import java.util.List;
import java.util.Map; import java.util.Map;
/** Performs replacements on strings such as <code>Hello ${user}</code>. */ /** Performs replacements on strings such as {@code Hello ${user}}. */
public class ParameterizedString { public class ParameterizedString {
/** Obtain a string which has no parameters and always produces the value. */ /** Obtain a string which has no parameters and always produces the value. */
public static ParameterizedString asis(final String constant) { public static ParameterizedString asis(final String constant) {

View File

@ -51,7 +51,7 @@ public interface PatchDetailService extends RemoteJsonService {
* {@link AsyncCallback#onSuccess(Object)} is invoked and the change * {@link AsyncCallback#onSuccess(Object)} is invoked and the change
* details are passed as parameter; if the change gets deleted because * details are passed as parameter; if the change gets deleted because
* the draft patch set that was deleted was the only patch set in the * the draft patch set that was deleted was the only patch set in the
* change, then <code>null</code> is passed as result to * change, then {@code null} is passed as result to
* {@link AsyncCallback#onSuccess(Object)} * {@link AsyncCallback#onSuccess(Object)}
*/ */
@Audit @Audit

View File

@ -50,7 +50,7 @@ public interface SuggestService extends RemoteJsonService {
* Suggests reviewers. A reviewer can be a user or a group. Inactive users, * Suggests reviewers. A reviewer can be a user or a group. Inactive users,
* the system groups {@link AccountGroup#ANONYMOUS_USERS} and * the system groups {@link AccountGroup#ANONYMOUS_USERS} and
* {@link AccountGroup#REGISTERED_USERS} and groups that have more than the * {@link AccountGroup#REGISTERED_USERS} and groups that have more than the
* configured <code>addReviewer.maxAllowed</code> members are not suggested as * configured {@code addReviewer.maxAllowed} members are not suggested as
* reviewers. * reviewers.
* @param changeId the change for which reviewers should be suggested * @param changeId the change for which reviewers should be suggested
*/ */

View File

@ -259,7 +259,7 @@ public class GerritDebugLauncher extends ServletContainerLauncher {
protected final class MyWebAppContext extends WebAppContext { protected final class MyWebAppContext extends WebAppContext {
/** /**
* Parent ClassLoader for the Jetty web app, which can only load JVM * Parent ClassLoader for the Jetty web app, which can only load JVM
* classes. We would just use <code>null</code> for the parent ClassLoader * classes. We would just use {@code null} for the parent ClassLoader
* except this makes Jetty unhappy. * except this makes Jetty unhappy.
*/ */
private final ClassLoader bootStrapOnlyClassLoader = private final ClassLoader bootStrapOnlyClassLoader =

View File

@ -24,7 +24,7 @@ import java.util.ArrayList;
* Suggestions supplied by the implementation of * Suggestions supplied by the implementation of
* {@link #onRequestSuggestions(Request, Callback)} are modified to wrap all * {@link #onRequestSuggestions(Request, Callback)} are modified to wrap all
* occurrences of the {@link SuggestOracle.Request#getQuery()} substring in HTML * occurrences of the {@link SuggestOracle.Request#getQuery()} substring in HTML
* <code>&lt;strong&gt;</code> tags, so they can be emphasized to the user. * {@code &lt;strong&gt;} tags, so they can be emphasized to the user.
*/ */
public abstract class HighlightSuggestOracle extends SuggestOracle { public abstract class HighlightSuggestOracle extends SuggestOracle {
private static String escape(String ds) { private static String escape(String ds) {

View File

@ -49,7 +49,7 @@ public class LinkFindReplace implements FindReplace {
/** /**
* @param find regular expression pattern to match substrings with. * @param find regular expression pattern to match substrings with.
* @param link replacement link href. Capture groups within * @param link replacement link href. Capture groups within
* <code>find</code> can be referenced with <code>$<i>n</i></code>. * {@code find} can be referenced with {@code $<i>n</i>}.
*/ */
public LinkFindReplace(String find, String link) { public LinkFindReplace(String find, String link) {
this.pat = RegExp.compile(find); this.pat = RegExp.compile(find);

View File

@ -31,7 +31,7 @@ public class RawFindReplace implements FindReplace {
/** /**
* @param find regular expression pattern to match substrings with. * @param find regular expression pattern to match substrings with.
* @param replace replacement expression. Capture groups within * @param replace replacement expression. Capture groups within
* <code>find</code> can be referenced with <code>$<i>n</i></code>. * {@code find} can be referenced with {@code $<i>n</i>}.
*/ */
public RawFindReplace(String find, String replace) { public RawFindReplace(String find, String replace) {
this.pat = RegExp.compile(find); this.pat = RegExp.compile(find);

View File

@ -213,7 +213,7 @@ public abstract class SafeHtml
} }
/** /**
* Replace first occurrence of <code>regex</code> with <code>repl</code> . * Replace first occurrence of {@code regex} with {@code repl} .
* <p> * <p>
* <b>WARNING:</b> This replacement is being performed against an otherwise * <b>WARNING:</b> This replacement is being performed against an otherwise
* safe HTML string. The caller must ensure that the replacement does not * safe HTML string. The caller must ensure that the replacement does not
@ -221,7 +221,7 @@ public abstract class SafeHtml
* *
* @param regex regular expression pattern to match the substring with. * @param regex regular expression pattern to match the substring with.
* @param repl replacement expression. Capture groups within * @param repl replacement expression. Capture groups within
* <code>regex</code> can be referenced with <code>$<i>n</i></code>. * {@code regex} can be referenced with {@code $<i>n</i>}.
* @return a new string, after the replacement has been made. * @return a new string, after the replacement has been made.
*/ */
public SafeHtml replaceFirst(final String regex, final String repl) { public SafeHtml replaceFirst(final String regex, final String repl) {
@ -229,7 +229,7 @@ public abstract class SafeHtml
} }
/** /**
* Replace each occurrence of <code>regex</code> with <code>repl</code> . * Replace each occurrence of {@code regex} with {@code repl} .
* <p> * <p>
* <b>WARNING:</b> This replacement is being performed against an otherwise * <b>WARNING:</b> This replacement is being performed against an otherwise
* safe HTML string. The caller must ensure that the replacement does not * safe HTML string. The caller must ensure that the replacement does not
@ -237,7 +237,7 @@ public abstract class SafeHtml
* *
* @param regex regular expression pattern to match substrings with. * @param regex regular expression pattern to match substrings with.
* @param repl replacement expression. Capture groups within * @param repl replacement expression. Capture groups within
* <code>regex</code> can be referenced with <code>$<i>n</i></code>. * {@code regex} can be referenced with {@code $<i>n</i>}.
* @return a new string, after the replacements have been made. * @return a new string, after the replacements have been made.
*/ */
public SafeHtml replaceAll(final String regex, final String repl) { public SafeHtml replaceAll(final String regex, final String repl) {

View File

@ -165,8 +165,8 @@ public class SafeHtmlBuilder extends SafeHtml {
* Open an element, appending "<tagName>" to the buffer. * Open an element, appending "<tagName>" to the buffer.
* <p> * <p>
* After the element is open the attributes may be manipulated until the next * After the element is open the attributes may be manipulated until the next
* <code>append</code>, <code>openElement</code>, <code>closeSelf</code> or * {@code append}, {@code openElement}, {@code closeSelf} or
* <code>closeElement</code> call. * {@code closeElement} call.
* *
* @param tagName name of the HTML element to open. * @param tagName name of the HTML element to open.
*/ */

View File

@ -35,7 +35,7 @@ import javax.servlet.http.HttpServletResponse;
* URL changes, so user agents would request a different resource. We force * URL changes, so user agents would request a different resource. We force
* these resources to have very long expiration times. * these resources to have very long expiration times.
* <p> * <p>
* To use, add the following block to your <code>web.xml</code>: * To use, add the following block to your {@code web.xml}:
* *
* <pre> * <pre>
* &lt;filter&gt; * &lt;filter&gt;

View File

@ -20,12 +20,12 @@ import com.google.gwt.user.client.ui.Widget;
/** /**
* Widget to display within a {@link ViewSite}. * Widget to display within a {@link ViewSite}.
*<p> *<p>
* Implementations must override <code>protected void onLoad()</code> and * Implementations must override {@code protected void onLoad()} and
* arrange for {@link #display()} to be invoked once the DOM within the view is * arrange for {@link #display()} to be invoked once the DOM within the view is
* consistent for presentation to the user. Typically this means that the * consistent for presentation to the user. Typically this means that the
* subclass can start RPCs within <code>onLoad()</code> and then invoke * subclass can start RPCs within {@code onLoad()} and then invoke
* <code>display()</code> from within the AsyncCallback's * {@code display()} from within the AsyncCallback's
* <code>onSuccess(Object)</code> method. * {@code onSuccess(Object)} method.
*/ */
public abstract class View extends Composite { public abstract class View extends Composite {
ViewSite<? extends View> site; ViewSite<? extends View> site;

View File

@ -22,7 +22,7 @@ import com.google.gwt.user.client.ui.SimplePanel;
* Hosts a single {@link View}. * Hosts a single {@link View}.
* <p> * <p>
* View instances are attached inside of an invisible DOM node, permitting their * View instances are attached inside of an invisible DOM node, permitting their
* <code>onLoad()</code> method to be invoked and to update the DOM prior to the * {@code onLoad()} method to be invoked and to update the DOM prior to the
* elements being made visible in the UI. * elements being made visible in the UI.
* <p> * <p>
* Complaint View instances must invoke {@link View#display()} once the DOM is * Complaint View instances must invoke {@link View#display()} once the DOM is
@ -48,7 +48,7 @@ public class ViewSite<V extends View> extends Composite {
* Set the next view to display. * Set the next view to display.
* <p> * <p>
* The view will be attached to the DOM tree within a hidden container, * The view will be attached to the DOM tree within a hidden container,
* permitting its <code>onLoad()</code> method to execute and update the DOM * permitting its {@code onLoad()} method to execute and update the DOM
* without the user seeing the result. * without the user seeing the result.
* *
* @param view the next view to display. * @param view the next view to display.

View File

@ -129,10 +129,10 @@ public class FormatUtil {
* <p> * <p>
* Example output: * Example output:
* <ul> * <ul>
* <li><code>A U. Thor &lt;author@example.com&gt;</code>: full populated</li> * <li>{@code A U. Thor &lt;author@example.com&gt;}: full populated</li>
* <li><code>A U. Thor (12)</code>: missing email address</li> * <li>{@code A U. Thor (12)}: missing email address</li>
* <li><code>Anonymous Coward &lt;author@example.com&gt;</code>: missing name</li> * <li>{@code Anonymous Coward &lt;author@example.com&gt;}: missing name</li>
* <li><code>Anonymous Coward (12)</code>: missing name and email address</li> * <li>{@code Anonymous Coward (12)}: missing name and email address</li>
* </ul> * </ul>
*/ */
public static String nameEmail(AccountInfo info) { public static String nameEmail(AccountInfo info) {

View File

@ -108,7 +108,7 @@ public class ComplexDisclosurePanel extends Composite implements
/** /**
* Changes the visible state of this panel's content. * Changes the visible state of this panel's content.
* *
* @param isOpen <code>true</code> to open, <code>false</code> to close * @param isOpen {@code true} to open, {@code false} to close
*/ */
public void setOpen(final boolean isOpen) { public void setOpen(final boolean isOpen) {
main.setOpen(isOpen); main.setOpen(isOpen);

View File

@ -65,7 +65,7 @@ public abstract class FancyFlexTable<RowItem> extends Composite {
* @param comparator comparator by which the items in the table are sorted * @param comparator comparator by which the items in the table are sorted
* @param item the item that should be found * @param item the item that should be found
* @return if the item is found the number of the row that contains the item; * @return if the item is found the number of the row that contains the item;
* if the item is not found <code>-1</code> * if the item is not found {@code -1}
*/ */
protected int findRowItem(Comparator<RowItem> comparator, RowItem item) { protected int findRowItem(Comparator<RowItem> comparator, RowItem item) {
int row = lookupRowItem(comparator, item); int row = lookupRowItem(comparator, item);
@ -84,7 +84,7 @@ public abstract class FancyFlexTable<RowItem> extends Composite {
* @param item the new item that should be inserted * @param item the new item that should be inserted
* @return if the item is not yet contained in the table, the number of the * @return if the item is not yet contained in the table, the number of the
* row where the new item should be inserted; if the item is already * row where the new item should be inserted; if the item is already
* contained in the table <code>-1</code> * contained in the table {@code -1}
*/ */
protected int getInsertRow(Comparator<RowItem> comparator, RowItem item) { protected int getInsertRow(Comparator<RowItem> comparator, RowItem item) {
int row = lookupRowItem(comparator, item); int row = lookupRowItem(comparator, item);

View File

@ -19,7 +19,7 @@ public interface FilteredUserInterface {
* Return the value by which the user interface is currently filtered. * Return the value by which the user interface is currently filtered.
* *
* @return value by which the user interface is currently filtered, * @return value by which the user interface is currently filtered,
* <code>null</code> or empty String if currently no filter is applied * {@code null} or empty String if currently no filter is applied
*/ */
public String getCurrentFilter(); public String getCurrentFilter();
} }

View File

@ -44,7 +44,7 @@ public class Hyperlink extends com.google.gwt.user.client.ui.Hyperlink {
* Creates a hyperlink with its text and target history token specified. * Creates a hyperlink with its text and target history token specified.
* *
* @param text the hyperlink's text * @param text the hyperlink's text
* @param asHTML <code>true</code> to treat the specified text as html * @param asHTML {@code true} to treat the specified text as html
* @param token the history token to which it will link * @param token the history token to which it will link
* @see #setTargetHistoryToken * @see #setTargetHistoryToken
*/ */

View File

@ -37,7 +37,7 @@ import javax.servlet.http.HttpServletResponse;
/** /**
* This class provides a mechanism to use a configurable robots.txt file, * This class provides a mechanism to use a configurable robots.txt file,
* outside of the .war of the application. In order to configure it add the * outside of the .war of the application. In order to configure it add the
* following to the <code>httpd</code> section of the <code>gerrit.conf</code> * following to the {@code httpd} section of the {@code gerrit.conf}
* file: * file:
* *
* <pre> * <pre>
@ -49,7 +49,7 @@ import javax.servlet.http.HttpServletResponse;
* the site directory, if it is absolute it will be used as is. * the site directory, if it is absolute it will be used as is.
* *
* If the specified file doesn't exist or isn't readable the servlet will * If the specified file doesn't exist or isn't readable the servlet will
* default to the <code>robots.txt</code> file bundled with the .war file of the * default to the {@code robots.txt} file bundled with the .war file of the
* application. * application.
*/ */
@SuppressWarnings("serial") @SuppressWarnings("serial")

View File

@ -32,14 +32,14 @@ import javax.servlet.http.HttpServletResponse;
/** /**
* Servlet hosting an SSH daemon on another port. During a standard HTTP GET * 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 * request the servlet returns the hostname and port number back to the client
* in the form <code>${host} ${port}</code>. * in the form {@code ${host} ${port}}.
* <p> * <p>
* Use a Git URL such as <code>ssh://${email}@${host}:${port}/${path}</code>, * Use a Git URL such as {@code ssh://${email}@${host}:${port}/${path}},
* e.g. <code>ssh://sop@google.com@gerrit.com:8010/tools/gerrit.git</code> to * e.g. {@code ssh://sop@google.com@gerrit.com:8010/tools/gerrit.git} to
* access the SSH daemon itself. * access the SSH daemon itself.
* <p> * <p>
* Versions of Git before 1.5.3 may require setting the username and port * Versions of Git before 1.5.3 may require setting the username and port
* properties in the user's <code>~/.ssh/config</code> file, and using a host * properties in the user's {@code ~/.ssh/config} file, and using a host
* alias through a URL such as <code>gerrit-alias:/tools/gerrit.git: * alias through a URL such as <code>gerrit-alias:/tools/gerrit.git:
* <pre> * <pre>
* Host gerrit-alias * Host gerrit-alias

View File

@ -57,7 +57,7 @@ import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse; import javax.servlet.http.HttpServletResponse;
/** Sends static content from the site 's <code>static/</code> subdirectory. */ /** Sends static content from the site 's {@code static/} subdirectory. */
@SuppressWarnings("serial") @SuppressWarnings("serial")
@Singleton @Singleton
public class StaticServlet extends HttpServlet { public class StaticServlet extends HttpServlet {

View File

@ -53,7 +53,7 @@ public class BaseServiceImplementation {
} }
/** /**
* Executes <code>action.run</code> with an active ReviewDb connection. * Executes {@code action.run} with an active ReviewDb connection.
* <p> * <p>
* A database handle is automatically opened and closed around the action's * A database handle is automatically opened and closed around the action's
* {@link Action#run(ReviewDb)} method. OrmExceptions are caught and passed * {@link Action#run(ReviewDb)} method. OrmExceptions are caught and passed

View File

@ -24,7 +24,7 @@ import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse; import javax.servlet.http.HttpServletResponse;
/** Handles the <code>/OpenID</code> URL for web based single-sign-on. */ /** Handles the {@code /OpenID} URL for web based single-sign-on. */
@SuppressWarnings("serial") @SuppressWarnings("serial")
@Singleton @Singleton
class OpenIdLoginServlet extends HttpServlet { class OpenIdLoginServlet extends HttpServlet {

View File

@ -44,15 +44,15 @@ import java.net.URL;
final class ProxyUtil { final class ProxyUtil {
/** /**
* Configure the JRE's standard HTTP based on <code>http_proxy</code>. * Configure the JRE's standard HTTP based on {@code http_proxy}.
* <p> * <p>
* The popular libcurl library honors the <code>http_proxy</code> environment * The popular libcurl library honors the {@code http_proxy} environment
* variable as a means of specifying an HTTP proxy for requests made behind a * variable as a means of specifying an HTTP proxy for requests made behind a
* firewall. This is not natively recognized by the JRE, so this method can be * firewall. This is not natively recognized by the JRE, so this method can be
* used by command line utilities to configure the JRE before the first * used by command line utilities to configure the JRE before the first
* request is sent. * request is sent.
* *
* @throws MalformedURLException the value in <code>http_proxy</code> is * @throws MalformedURLException the value in {@code http_proxy} is
* unsupportable. * unsupportable.
*/ */
static void configureHttpProxy() throws MalformedURLException { static void configureHttpProxy() throws MalformedURLException {

View File

@ -240,8 +240,8 @@ public final class Project {
/** /**
* Returns the name key of the parent project. * Returns the name key of the parent project.
* *
* @return name key of the parent project, <code>null</code> if this project * @return name key of the parent project, {@code null} if this project
* is the wild project, <code>null</code> or the name key of the wild * is the wild project, {@code null} or the name key of the wild
* project if this project is a direct child of the wild project * project if this project is a direct child of the wild project
*/ */
public Project.NameKey getParent() { public Project.NameKey getParent() {
@ -252,7 +252,7 @@ public final class Project {
* Returns the name key of the parent project. * Returns the name key of the parent project.
* *
* @param allProjectsName name key of the wild project * @param allProjectsName name key of the wild project
* @return name key of the parent project, <code>null</code> if this project * @return name key of the parent project, {@code null} if this project
* is the wild project * is the wild project
*/ */
public Project.NameKey getParent(final Project.NameKey allProjectsName) { public Project.NameKey getParent(final Project.NameKey allProjectsName) {

View File

@ -41,7 +41,7 @@ public final class RevId {
} }
/** /**
* @return if {@link #isComplete()}, <code>this</code>; otherwise a new RevId * @return if {@link #isComplete()}, {@code this}; otherwise a new RevId
* with 'z' appended on the end. * with 'z' appended on the end.
*/ */
public RevId max() { public RevId max() {

View File

@ -33,15 +33,15 @@ public interface SubmoduleSubscriptionAccess extends
throws OrmException; throws OrmException;
/** /**
* Fetches all <code>SubmoduleSubscription</code>s in which some branch of * Fetches all {@code SubmoduleSubscription}s in which some branch of
* <code>superProject</code> subscribes a branch. * {@code superProject} subscribes a branch.
* *
* Use {@link #bySuperProject(Branch.NameKey)} to fetch for a branch instead * Use {@link #bySuperProject(Branch.NameKey)} to fetch for a branch instead
* of a project. * of a project.
* *
* @param superProject the project to fetch subscriptions for * @param superProject the project to fetch subscriptions for
* @return <code>SubmoduleSubscription</code>s that are subscribed by some * @return {@code SubmoduleSubscription}s that are subscribed by some
* branch of <code>superProject</code>. * branch of {@code superProject}.
* @throws OrmException * @throws OrmException
*/ */
@Query("WHERE key.superProject.projectName = ?") @Query("WHERE key.superProject.projectName = ?")
@ -53,15 +53,15 @@ public interface SubmoduleSubscriptionAccess extends
throws OrmException; throws OrmException;
/** /**
* Fetches all <code>SubmoduleSubscription</code>s in which some branch of * Fetches all {@code SubmoduleSubscription}s in which some branch of
* <code>submodule</code> is subscribed. * {@code submodule} is subscribed.
* *
* Use {@link #bySubmodule(Branch.NameKey)} to fetch for a branch instead of * Use {@link #bySubmodule(Branch.NameKey)} to fetch for a branch instead of
* a project. * a project.
* *
* @param submodule the project to fetch subscriptions for. * @param submodule the project to fetch subscriptions for.
* @return <code>SubmoduleSubscription</code>s that subscribe some branch of * @return {@code SubmoduleSubscription}s that subscribe some branch of
* <code>submodule</code>. * {@code submodule}.
* @throws OrmException * @throws OrmException
*/ */
@Query("WHERE submodule.projectName = ?") @Query("WHERE submodule.projectName = ?")

View File

@ -29,9 +29,9 @@ public class ProjectUtil {
* *
* @param repoManager Git repository manager to open the git repository * @param repoManager Git repository manager to open the git repository
* @param branch the branch for which it should be checked if it exists * @param branch the branch for which it should be checked if it exists
* @return <code>true</code> if the specified branch exists or if * @return {@code true} if the specified branch exists or if
* <code>HEAD</code> points to this branch, otherwise * {@code HEAD} points to this branch, otherwise
* <code>false</code> * {@code false}
* @throws RepositoryNotFoundException the repository of the branch's project * @throws RepositoryNotFoundException the repository of the branch's project
* does not exist. * does not exist.
* @throws IOException error while retrieving the branch from the repository. * @throws IOException error while retrieving the branch from the repository.

View File

@ -69,13 +69,13 @@ public class PerformCreateGroup {
* Creates a new group. * Creates a new group.
* *
* @param groupName the name for the new group * @param groupName the name for the new group
* @param groupDescription the description of the new group, <code>null</code> * @param groupDescription the description of the new group, {@code null}
* if no description * if no description
* @param visibleToAll <code>true</code> to make the group visible to all * @param visibleToAll {@code true} to make the group visible to all
* registered users, if <code>false</code> the group is only visible to * registered users, if {@code false} the group is only visible to
* the group owners and Gerrit administrators * the group owners and Gerrit administrators
* @param ownerGroupId the group that should own the new group, if * @param ownerGroupId the group that should own the new group, if
* <code>null</code> the new group will own itself * {@code null} the new group will own itself
* @param initialMembers initial members to be added to the new group * @param initialMembers initial members to be added to the new group
* @param initialGroups initial groups to include in the new group * @param initialGroups initial groups to include in the new group
* @return the id of the new group * @return the id of the new group

View File

@ -109,8 +109,8 @@ public class MergeabilityChecker implements GitReferenceUpdatedListener {
* *
* @param change the change for which the mergeability flag should be updated * @param change the change for which the mergeability flag should be updated
* @return CheckedFuture that updates the mergeability flag of the change and * @return CheckedFuture that updates the mergeability flag of the change and
* returns <code>true</code> if the mergeability flag was updated and * returns {@code true} if the mergeability flag was updated and
* the change was reindexed, and <code>false</code> if the * the change was reindexed, and {@code false} if the
* mergeability flag was not updated and the change was not reindexed * mergeability flag was not updated and the change was not reindexed
*/ */
public CheckedFuture<Boolean, IOException> updateAsync(Change change) { public CheckedFuture<Boolean, IOException> updateAsync(Change change) {

View File

@ -179,7 +179,7 @@ public class MultiProgressMonitor {
* <p> * <p>
* Must be called from the main thread, <em>not</em> a worker thread. Once a * Must be called from the main thread, <em>not</em> a worker thread. Once a
* worker thread calls {@link #end()}, the future has an additional * worker thread calls {@link #end()}, the future has an additional
* <code>maxInterval</code> to finish before it is forcefully cancelled and * {@code maxInterval} to finish before it is forcefully cancelled and
* {@link ExecutionException} is thrown. * {@link ExecutionException} is thrown.
* *
* @param workerFuture a future that returns when worker threads are finished. * @param workerFuture a future that returns when worker threads are finished.

View File

@ -88,8 +88,8 @@ public class NotesBranchUtil {
} }
/** /**
* Create a new commit in the <code>notesBranch</code> by updating existing * Create a new commit in the {@code notesBranch} by updating existing
* or creating new notes from the <code>notes</code> map. * or creating new notes from the {@code notes} map.
* *
* @param notes map of notes * @param notes map of notes
* @param notesBranch notes branch to update * @param notesBranch notes branch to update
@ -106,16 +106,16 @@ public class NotesBranchUtil {
} }
/** /**
* Create a new commit in the <code>notesBranch</code> by creating not yet * Create a new commit in the {@code notesBranch} by creating not yet
* existing notes from the <code>notes</code> map. The notes from the * existing notes from the {@code notes} map. The notes from the
* <code>notes</code> map which already exist in the note-tree of the * {@code notes} map which already exist in the note-tree of the
* tip of the <code>notesBranch</code> will not be updated. * tip of the {@code notesBranch} will not be updated.
* *
* @param notes map of notes * @param notes map of notes
* @param notesBranch notes branch to update * @param notesBranch notes branch to update
* @param commitAuthor author of the commit in the notes branch * @param commitAuthor author of the commit in the notes branch
* @param commitMessage for the commit in the notes branch * @param commitMessage for the commit in the notes branch
* @return map with those notes from the <code>notes</code> that were newly * @return map with those notes from the {@code notes} that were newly
* created * created
* @throws IOException * @throws IOException
* @throws ConcurrentRefUpdateException * @throws ConcurrentRefUpdateException

View File

@ -125,8 +125,8 @@ public abstract class SubmitStrategy {
* @param mergeTip the mergeTip * @param mergeTip the mergeTip
* @param toMerge the commit for which it should be checked whether it can be * @param toMerge the commit for which it should be checked whether it can be
* merged or not * merged or not
* @return <code>true</code> if the given commit can be merged, otherwise * @return {@code true} if the given commit can be merged, otherwise
* <code>false</code> * {@code false}
* @throws MergeException * @throws MergeException
*/ */
public abstract boolean dryRun(CodeReviewCommit mergeTip, public abstract boolean dryRun(CodeReviewCommit mergeTip,
@ -140,7 +140,7 @@ public abstract class SubmitStrategy {
* Do only call this method after the {@link #run(CodeReviewCommit, List)} * Do only call this method after the {@link #run(CodeReviewCommit, List)}
* method has been invoked. * method has been invoked.
* *
* @return the ref log identity, may be <code>null</code> * @return the ref log identity, may be {@code null}
*/ */
public final PersonIdent getRefLogIdent() { public final PersonIdent getRefLogIdent() {
return refLogIdent; return refLogIdent;
@ -168,9 +168,9 @@ public abstract class SubmitStrategy {
* *
* May be overwritten by subclasses. * May be overwritten by subclasses.
* *
* @return <code>true</code> if a merge that failed with * @return {@code true} if a merge that failed with
* {@link Result#LOCK_FAILURE} should be retried, otherwise * {@link Result#LOCK_FAILURE} should be retried, otherwise
* <code>false</code> * {@code false}
*/ */
public boolean retryOnLockFailure() { public boolean retryOnLockFailure() {
return true; return true;

View File

@ -46,7 +46,7 @@ public class ProjectNode implements TreeNode, Comparable<ProjectNode> {
/** /**
* Returns the project parent name. * Returns the project parent name.
* *
* @return Project parent name, <code>null</code> for the 'All-Projects' root * @return Project parent name, {@code null} for the 'All-Projects' root
* project * project
*/ */
public Project.NameKey getParentName() { public Project.NameKey getParentName() {

View File

@ -88,7 +88,7 @@ public class SubmitRuleEvaluator {
* rule. * rule.
* @param filterRuleWrapperName The name of the rule used to evaluate the * @param filterRuleWrapperName The name of the rule used to evaluate the
* filter rule. * filter rule.
* @param skipSubmitFilters if <code>true</code> submit filter will not be * @param skipSubmitFilters if {@code true} submit filter will not be
* applied * applied
* @param rules when non-null the rules will be read from this input stream * @param rules when non-null the rules will be read from this input stream
* instead of refs/meta/config:rules.pl file * instead of refs/meta/config:rules.pl file

View File

@ -28,7 +28,7 @@ public interface DataSourceType {
/** /**
* Return a ScriptRunner that runs the index script. Must not return * Return a ScriptRunner that runs the index script. Must not return
* <code>null</code>, but may return a ScriptRunner that does nothing. * {@code null}, but may return a ScriptRunner that does nothing.
* *
* @throws IOException * @throws IOException
*/ */

View File

@ -51,7 +51,7 @@ public final class MagicBranch {
|| refName.startsWith(NEW_CHANGE); || refName.startsWith(NEW_CHANGE);
} }
/** Returns the ref name prefix for a magic branch, <code>null</code> if the branch is not magic */ /** Returns the ref name prefix for a magic branch, {@code null} if the branch is not magic */
public static String getMagicRefNamePrefix(String refName) { public static String getMagicRefNamePrefix(String refName) {
if (refName.startsWith(NEW_DRAFT_CHANGE)) { if (refName.startsWith(NEW_DRAFT_CHANGE)) {
return NEW_DRAFT_CHANGE; return NEW_DRAFT_CHANGE;

View File

@ -820,7 +820,7 @@ public class SubmoduleOpTest extends LocalDiskRepositoryTestCase {
* subscriptions. * subscriptions.
* <p> * <p>
* In this test a commit is created and considered merged to * In this test a commit is created and considered merged to
* <code>mergedBranch</code> branch. * {@code mergedBranch} branch.
* </p> * </p>
* <p> * <p>
* The destination project the commit was merged is not considered to be a * The destination project the commit was merged is not considered to be a
@ -846,7 +846,7 @@ public class SubmoduleOpTest extends LocalDiskRepositoryTestCase {
* Subscriptions table. * Subscriptions table.
* <p> * <p>
* In this test a commit is created and considered merged to * In this test a commit is created and considered merged to
* <code>mergedBranch</code> branch. * {@code mergedBranch} branch.
* </p> * </p>
* <p> * <p>
* The destination project the commit was merged is not considered to be a * The destination project the commit was merged is not considered to be a
@ -859,7 +859,7 @@ public class SubmoduleOpTest extends LocalDiskRepositoryTestCase {
* @param extractedSubscriptions The subscription rows extracted from * @param extractedSubscriptions The subscription rows extracted from
* gitmodules file. * gitmodules file.
* @param previousSubscriptions The subscription rows to be considering as * @param previousSubscriptions The subscription rows to be considering as
* existing and pointing as target to the <code>mergedBranch</code> * existing and pointing as target to the {@code mergedBranch}
* before updating the table. * before updating the table.
* @throws Exception If an exception occurs. * @throws Exception If an exception occurs.
*/ */

View File

@ -112,12 +112,12 @@ import java.util.List;
/** /**
* SSH daemon to communicate with Gerrit. * SSH daemon to communicate with Gerrit.
* <p> * <p>
* Use a Git URL such as <code>ssh://${email}@${host}:${port}/${path}</code>, * Use a Git URL such as {@code ssh://${email}@${host}:${port}/${path}},
* e.g. <code>ssh://sop@google.com@gerrit.com:8010/tools/gerrit.git</code> to * e.g. {@code ssh://sop@google.com@gerrit.com:8010/tools/gerrit.git} to
* access the SSH daemon itself. * access the SSH daemon itself.
* <p> * <p>
* Versions of Git before 1.5.3 may require setting the username and port * Versions of Git before 1.5.3 may require setting the username and port
* properties in the user's <code>~/.ssh/config</code> file, and using a host * properties in the user's {@code ~/.ssh/config} file, and using a host
* alias through a URL such as <code>gerrit-alias:/tools/gerrit.git: * alias through a URL such as <code>gerrit-alias:/tools/gerrit.git:
* <pre> * <pre>
* Host gerrit-alias * Host gerrit-alias

View File

@ -71,7 +71,7 @@ public class SshUtil {
* Convert an RFC 4716 style key to an OpenSSH style key. * Convert an RFC 4716 style key to an OpenSSH style key.
* *
* @param keyStr the key string to convert. * @param keyStr the key string to convert.
* @return <code>keyStr</code> if conversion failed; otherwise the converted * @return {@code keyStr} if conversion failed; otherwise the converted
* key, in OpenSSH key format. * key, in OpenSSH key format.
*/ */
public static String toOpenSshPublicKey(final String keyStr) { public static String toOpenSshPublicKey(final String keyStr) {