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:
parent
b112635e9a
commit
dd218662c0
@ -87,10 +87,10 @@ public class AccountInfo {
|
||||
* <p>
|
||||
* Example output:
|
||||
* <ul>
|
||||
* <li><code>A U. Thor <author@example.com></code>: full populated</li>
|
||||
* <li><code>A U. Thor (12)</code>: missing email address</li>
|
||||
* <li><code>Anonymous Coward <author@example.com></code>: missing name</li>
|
||||
* <li><code>Anonymous Coward (12)</code>: missing name and email address</li>
|
||||
* <li>{@code A U. Thor <author@example.com>}: full populated</li>
|
||||
* <li>{@code A U. Thor (12)}: missing email address</li>
|
||||
* <li>{@code Anonymous Coward <author@example.com>}: missing name</li>
|
||||
* <li>{@code Anonymous Coward (12)}: missing name and email address</li>
|
||||
* </ul>
|
||||
*/
|
||||
public String getNameEmail(String anonymousCowardName) {
|
||||
|
@ -50,9 +50,9 @@ public class AccountInfoCache {
|
||||
* <p>
|
||||
* The return value can take on one of three forms:
|
||||
* <ul>
|
||||
* <li><code>null</code>, if <code>id == null</code>.</li>
|
||||
* <li>a valid info block, if <code>id</code> was loaded.</li>
|
||||
* <li>an anonymous info block, if <code>id</code> was not loaded.</li>
|
||||
* <li>{@code null}, if {@code id == null}.</li>
|
||||
* <li>a valid info block, if {@code id} was loaded.</li>
|
||||
* <li>an anonymous info block, if {@code id} was not loaded.</li>
|
||||
* </ul>
|
||||
*
|
||||
* @param id the id desired.
|
||||
|
@ -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,
|
||||
List<PatchLineComment> children, List<PatchLineComment> outResult) {
|
||||
|
@ -50,9 +50,9 @@ public class GroupInfoCache {
|
||||
* <p>
|
||||
* The return value can take on one of three forms:
|
||||
* <ul>
|
||||
* <li><code>null</code>, if <code>id == null</code>.</li>
|
||||
* <li>a valid info block, if <code>id</code> was loaded.</li>
|
||||
* <li>an anonymous info block, if <code>id</code> was not loaded.</li>
|
||||
* <li>{@code null}, if {@code id == null}.</li>
|
||||
* <li>a valid info block, if {@code id} was loaded.</li>
|
||||
* <li>an anonymous info block, if {@code id} was not loaded.</li>
|
||||
* </ul>
|
||||
*
|
||||
* @param uuid the id desired.
|
||||
|
@ -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}</code>. */
|
||||
/** Performs replacements on strings such as {@code Hello ${user}}. */
|
||||
public class ParameterizedString {
|
||||
/** Obtain a string which has no parameters and always produces the value. */
|
||||
public static ParameterizedString asis(final String constant) {
|
||||
|
@ -51,7 +51,7 @@ public interface PatchDetailService extends RemoteJsonService {
|
||||
* {@link AsyncCallback#onSuccess(Object)} is invoked and the change
|
||||
* 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
|
||||
* change, then <code>null</code> is passed as result to
|
||||
* change, then {@code null} is passed as result to
|
||||
* {@link AsyncCallback#onSuccess(Object)}
|
||||
*/
|
||||
@Audit
|
||||
|
@ -50,7 +50,7 @@ public interface SuggestService extends RemoteJsonService {
|
||||
* Suggests reviewers. A reviewer can be a user or a group. Inactive users,
|
||||
* the system groups {@link AccountGroup#ANONYMOUS_USERS} and
|
||||
* {@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.
|
||||
* @param changeId the change for which reviewers should be suggested
|
||||
*/
|
||||
|
@ -259,7 +259,7 @@ public class GerritDebugLauncher extends ServletContainerLauncher {
|
||||
protected final class MyWebAppContext extends WebAppContext {
|
||||
/**
|
||||
* 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.
|
||||
*/
|
||||
private final ClassLoader bootStrapOnlyClassLoader =
|
||||
|
@ -24,7 +24,7 @@ import java.util.ArrayList;
|
||||
* Suggestions supplied by the implementation of
|
||||
* {@link #onRequestSuggestions(Request, Callback)} are modified to wrap all
|
||||
* occurrences of the {@link SuggestOracle.Request#getQuery()} substring in HTML
|
||||
* <code><strong></code> tags, so they can be emphasized to the user.
|
||||
* {@code <strong>} tags, so they can be emphasized to the user.
|
||||
*/
|
||||
public abstract class HighlightSuggestOracle extends SuggestOracle {
|
||||
private static String escape(String ds) {
|
||||
|
@ -49,7 +49,7 @@ public class LinkFindReplace implements FindReplace {
|
||||
/**
|
||||
* @param find regular expression pattern to match substrings with.
|
||||
* @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) {
|
||||
this.pat = RegExp.compile(find);
|
||||
|
@ -31,7 +31,7 @@ public class RawFindReplace implements FindReplace {
|
||||
/**
|
||||
* @param find regular expression pattern to match substrings with.
|
||||
* @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) {
|
||||
this.pat = RegExp.compile(find);
|
||||
|
@ -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>
|
||||
* <b>WARNING:</b> This replacement is being performed against an otherwise
|
||||
* 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 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.
|
||||
*/
|
||||
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>
|
||||
* <b>WARNING:</b> This replacement is being performed against an otherwise
|
||||
* 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 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.
|
||||
*/
|
||||
public SafeHtml replaceAll(final String regex, final String repl) {
|
||||
|
@ -165,8 +165,8 @@ public class SafeHtmlBuilder extends SafeHtml {
|
||||
* Open an element, appending "<tagName>" to the buffer.
|
||||
* <p>
|
||||
* After the element is open the attributes may be manipulated until the next
|
||||
* <code>append</code>, <code>openElement</code>, <code>closeSelf</code> or
|
||||
* <code>closeElement</code> call.
|
||||
* {@code append}, {@code openElement}, {@code closeSelf} or
|
||||
* {@code closeElement} call.
|
||||
*
|
||||
* @param tagName name of the HTML element to open.
|
||||
*/
|
||||
|
@ -35,7 +35,7 @@ import javax.servlet.http.HttpServletResponse;
|
||||
* URL changes, so user agents would request a different resource. We force
|
||||
* these resources to have very long expiration times.
|
||||
* <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>
|
||||
* <filter>
|
||||
|
@ -20,12 +20,12 @@ import com.google.gwt.user.client.ui.Widget;
|
||||
/**
|
||||
* Widget to display within a {@link ViewSite}.
|
||||
*<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
|
||||
* consistent for presentation to the user. Typically this means that the
|
||||
* subclass can start RPCs within <code>onLoad()</code> and then invoke
|
||||
* <code>display()</code> from within the AsyncCallback's
|
||||
* <code>onSuccess(Object)</code> method.
|
||||
* subclass can start RPCs within {@code onLoad()} and then invoke
|
||||
* {@code display()} from within the AsyncCallback's
|
||||
* {@code onSuccess(Object)} method.
|
||||
*/
|
||||
public abstract class View extends Composite {
|
||||
ViewSite<? extends View> site;
|
||||
|
@ -22,7 +22,7 @@ import com.google.gwt.user.client.ui.SimplePanel;
|
||||
* Hosts a single {@link View}.
|
||||
* <p>
|
||||
* 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.
|
||||
* <p>
|
||||
* 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.
|
||||
* <p>
|
||||
* 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.
|
||||
*
|
||||
* @param view the next view to display.
|
||||
|
@ -129,10 +129,10 @@ public class FormatUtil {
|
||||
* <p>
|
||||
* Example output:
|
||||
* <ul>
|
||||
* <li><code>A U. Thor <author@example.com></code>: full populated</li>
|
||||
* <li><code>A U. Thor (12)</code>: missing email address</li>
|
||||
* <li><code>Anonymous Coward <author@example.com></code>: missing name</li>
|
||||
* <li><code>Anonymous Coward (12)</code>: missing name and email address</li>
|
||||
* <li>{@code A U. Thor <author@example.com>}: full populated</li>
|
||||
* <li>{@code A U. Thor (12)}: missing email address</li>
|
||||
* <li>{@code Anonymous Coward <author@example.com>}: missing name</li>
|
||||
* <li>{@code Anonymous Coward (12)}: missing name and email address</li>
|
||||
* </ul>
|
||||
*/
|
||||
public static String nameEmail(AccountInfo info) {
|
||||
|
@ -108,7 +108,7 @@ public class ComplexDisclosurePanel extends Composite implements
|
||||
/**
|
||||
* 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) {
|
||||
main.setOpen(isOpen);
|
||||
|
@ -65,7 +65,7 @@ public abstract class FancyFlexTable<RowItem> extends Composite {
|
||||
* @param comparator comparator by which the items in the table are sorted
|
||||
* @param item the item that should be found
|
||||
* @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) {
|
||||
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
|
||||
* @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
|
||||
* contained in the table <code>-1</code>
|
||||
* contained in the table {@code -1}
|
||||
*/
|
||||
protected int getInsertRow(Comparator<RowItem> comparator, RowItem item) {
|
||||
int row = lookupRowItem(comparator, item);
|
||||
|
@ -19,7 +19,7 @@ public interface FilteredUserInterface {
|
||||
* Return the 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();
|
||||
}
|
||||
|
@ -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.
|
||||
*
|
||||
* @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
|
||||
* @see #setTargetHistoryToken
|
||||
*/
|
||||
|
@ -37,7 +37,7 @@ import javax.servlet.http.HttpServletResponse;
|
||||
/**
|
||||
* 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
|
||||
* 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:
|
||||
*
|
||||
* <pre>
|
||||
@ -49,7 +49,7 @@ import javax.servlet.http.HttpServletResponse;
|
||||
* 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
|
||||
* 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.
|
||||
*/
|
||||
@SuppressWarnings("serial")
|
||||
|
@ -32,14 +32,14 @@ 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}</code>.
|
||||
* in the form {@code ${host} ${port}}.
|
||||
* <p>
|
||||
* 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</code> to
|
||||
* 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} to
|
||||
* access the SSH daemon itself.
|
||||
* <p>
|
||||
* 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:
|
||||
* <pre>
|
||||
* Host gerrit-alias
|
||||
|
@ -57,7 +57,7 @@ import javax.servlet.http.HttpServletRequest;
|
||||
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")
|
||||
@Singleton
|
||||
public class StaticServlet extends HttpServlet {
|
||||
|
@ -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>
|
||||
* A database handle is automatically opened and closed around the action's
|
||||
* {@link Action#run(ReviewDb)} method. OrmExceptions are caught and passed
|
||||
|
@ -24,7 +24,7 @@ import javax.servlet.http.HttpServlet;
|
||||
import javax.servlet.http.HttpServletRequest;
|
||||
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")
|
||||
@Singleton
|
||||
class OpenIdLoginServlet extends HttpServlet {
|
||||
|
@ -44,15 +44,15 @@ import java.net.URL;
|
||||
|
||||
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>
|
||||
* 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
|
||||
* 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
|
||||
* request is sent.
|
||||
*
|
||||
* @throws MalformedURLException the value in <code>http_proxy</code> is
|
||||
* @throws MalformedURLException the value in {@code http_proxy} is
|
||||
* unsupportable.
|
||||
*/
|
||||
static void configureHttpProxy() throws MalformedURLException {
|
||||
|
@ -240,8 +240,8 @@ public final class Project {
|
||||
/**
|
||||
* Returns the name key of the parent project.
|
||||
*
|
||||
* @return name key of the parent project, <code>null</code> if this project
|
||||
* is the wild project, <code>null</code> or the name key of the wild
|
||||
* @return name key of the parent project, {@code null} if this project
|
||||
* 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
|
||||
*/
|
||||
public Project.NameKey getParent() {
|
||||
@ -252,7 +252,7 @@ public final class Project {
|
||||
* Returns the name key of the parent 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
|
||||
*/
|
||||
public Project.NameKey getParent(final Project.NameKey allProjectsName) {
|
||||
|
@ -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.
|
||||
*/
|
||||
public RevId max() {
|
||||
|
@ -33,15 +33,15 @@ public interface SubmoduleSubscriptionAccess extends
|
||||
throws OrmException;
|
||||
|
||||
/**
|
||||
* Fetches all <code>SubmoduleSubscription</code>s in which some branch of
|
||||
* <code>superProject</code> subscribes a branch.
|
||||
* Fetches all {@code SubmoduleSubscription}s in which some branch of
|
||||
* {@code superProject} subscribes a branch.
|
||||
*
|
||||
* Use {@link #bySuperProject(Branch.NameKey)} to fetch for a branch instead
|
||||
* of a project.
|
||||
*
|
||||
* @param superProject the project to fetch subscriptions for
|
||||
* @return <code>SubmoduleSubscription</code>s that are subscribed by some
|
||||
* branch of <code>superProject</code>.
|
||||
* @return {@code SubmoduleSubscription}s that are subscribed by some
|
||||
* branch of {@code superProject}.
|
||||
* @throws OrmException
|
||||
*/
|
||||
@Query("WHERE key.superProject.projectName = ?")
|
||||
@ -53,15 +53,15 @@ public interface SubmoduleSubscriptionAccess extends
|
||||
throws OrmException;
|
||||
|
||||
/**
|
||||
* Fetches all <code>SubmoduleSubscription</code>s in which some branch of
|
||||
* <code>submodule</code> is subscribed.
|
||||
* Fetches all {@code SubmoduleSubscription}s in which some branch of
|
||||
* {@code submodule} is subscribed.
|
||||
*
|
||||
* Use {@link #bySubmodule(Branch.NameKey)} to fetch for a branch instead of
|
||||
* a project.
|
||||
*
|
||||
* @param submodule the project to fetch subscriptions for.
|
||||
* @return <code>SubmoduleSubscription</code>s that subscribe some branch of
|
||||
* <code>submodule</code>.
|
||||
* @return {@code SubmoduleSubscription}s that subscribe some branch of
|
||||
* {@code submodule}.
|
||||
* @throws OrmException
|
||||
*/
|
||||
@Query("WHERE submodule.projectName = ?")
|
||||
|
@ -29,9 +29,9 @@ public class ProjectUtil {
|
||||
*
|
||||
* @param repoManager Git repository manager to open the git repository
|
||||
* @param branch the branch for which it should be checked if it exists
|
||||
* @return <code>true</code> if the specified branch exists or if
|
||||
* <code>HEAD</code> points to this branch, otherwise
|
||||
* <code>false</code>
|
||||
* @return {@code true} if the specified branch exists or if
|
||||
* {@code HEAD} points to this branch, otherwise
|
||||
* {@code false}
|
||||
* @throws RepositoryNotFoundException the repository of the branch's project
|
||||
* does not exist.
|
||||
* @throws IOException error while retrieving the branch from the repository.
|
||||
|
@ -69,13 +69,13 @@ public class PerformCreateGroup {
|
||||
* Creates a 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
|
||||
* @param visibleToAll <code>true</code> to make the group visible to all
|
||||
* registered users, if <code>false</code> the group is only visible to
|
||||
* @param visibleToAll {@code true} to make the group visible to all
|
||||
* registered users, if {@code false} the group is only visible to
|
||||
* the group owners and Gerrit administrators
|
||||
* @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 initialGroups initial groups to include in the new group
|
||||
* @return the id of the new group
|
||||
|
@ -109,8 +109,8 @@ public class MergeabilityChecker implements GitReferenceUpdatedListener {
|
||||
*
|
||||
* @param change the change for which the mergeability flag should be updated
|
||||
* @return CheckedFuture that updates the mergeability flag of the change and
|
||||
* returns <code>true</code> if the mergeability flag was updated and
|
||||
* the change was reindexed, and <code>false</code> if the
|
||||
* returns {@code true} if the mergeability flag was updated and
|
||||
* the change was reindexed, and {@code false} if the
|
||||
* mergeability flag was not updated and the change was not reindexed
|
||||
*/
|
||||
public CheckedFuture<Boolean, IOException> updateAsync(Change change) {
|
||||
|
@ -179,7 +179,7 @@ public class MultiProgressMonitor {
|
||||
* <p>
|
||||
* 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
|
||||
* <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.
|
||||
*
|
||||
* @param workerFuture a future that returns when worker threads are finished.
|
||||
|
@ -88,8 +88,8 @@ public class NotesBranchUtil {
|
||||
}
|
||||
|
||||
/**
|
||||
* Create a new commit in the <code>notesBranch</code> by updating existing
|
||||
* or creating new notes from the <code>notes</code> map.
|
||||
* Create a new commit in the {@code notesBranch} by updating existing
|
||||
* or creating new notes from the {@code notes} map.
|
||||
*
|
||||
* @param notes map of notes
|
||||
* @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
|
||||
* existing notes from the <code>notes</code> map. The notes from the
|
||||
* <code>notes</code> map which already exist in the note-tree of the
|
||||
* tip of the <code>notesBranch</code> will not be updated.
|
||||
* Create a new commit in the {@code notesBranch} by creating not yet
|
||||
* existing notes from the {@code notes} map. The notes from the
|
||||
* {@code notes} map which already exist in the note-tree of the
|
||||
* tip of the {@code notesBranch} will not be updated.
|
||||
*
|
||||
* @param notes map of notes
|
||||
* @param notesBranch notes branch to update
|
||||
* @param commitAuthor author of 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
|
||||
* @throws IOException
|
||||
* @throws ConcurrentRefUpdateException
|
||||
|
@ -125,8 +125,8 @@ public abstract class SubmitStrategy {
|
||||
* @param mergeTip the mergeTip
|
||||
* @param toMerge the commit for which it should be checked whether it can be
|
||||
* merged or not
|
||||
* @return <code>true</code> if the given commit can be merged, otherwise
|
||||
* <code>false</code>
|
||||
* @return {@code true} if the given commit can be merged, otherwise
|
||||
* {@code false}
|
||||
* @throws MergeException
|
||||
*/
|
||||
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)}
|
||||
* 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() {
|
||||
return refLogIdent;
|
||||
@ -168,9 +168,9 @@ public abstract class SubmitStrategy {
|
||||
*
|
||||
* 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
|
||||
* <code>false</code>
|
||||
* {@code false}
|
||||
*/
|
||||
public boolean retryOnLockFailure() {
|
||||
return true;
|
||||
|
@ -46,7 +46,7 @@ public class ProjectNode implements TreeNode, Comparable<ProjectNode> {
|
||||
/**
|
||||
* 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
|
||||
*/
|
||||
public Project.NameKey getParentName() {
|
||||
|
@ -88,7 +88,7 @@ public class SubmitRuleEvaluator {
|
||||
* rule.
|
||||
* @param filterRuleWrapperName The name of the rule used to evaluate the
|
||||
* filter rule.
|
||||
* @param skipSubmitFilters if <code>true</code> submit filter will not be
|
||||
* @param skipSubmitFilters if {@code true} submit filter will not be
|
||||
* applied
|
||||
* @param rules when non-null the rules will be read from this input stream
|
||||
* instead of refs/meta/config:rules.pl file
|
||||
|
@ -28,7 +28,7 @@ public interface DataSourceType {
|
||||
|
||||
/**
|
||||
* 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
|
||||
*/
|
||||
|
@ -51,7 +51,7 @@ public final class MagicBranch {
|
||||
|| 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) {
|
||||
if (refName.startsWith(NEW_DRAFT_CHANGE)) {
|
||||
return NEW_DRAFT_CHANGE;
|
||||
|
@ -820,7 +820,7 @@ public class SubmoduleOpTest extends LocalDiskRepositoryTestCase {
|
||||
* subscriptions.
|
||||
* <p>
|
||||
* In this test a commit is created and considered merged to
|
||||
* <code>mergedBranch</code> branch.
|
||||
* {@code mergedBranch} branch.
|
||||
* </p>
|
||||
* <p>
|
||||
* The destination project the commit was merged is not considered to be a
|
||||
@ -846,7 +846,7 @@ public class SubmoduleOpTest extends LocalDiskRepositoryTestCase {
|
||||
* Subscriptions table.
|
||||
* <p>
|
||||
* In this test a commit is created and considered merged to
|
||||
* <code>mergedBranch</code> branch.
|
||||
* {@code mergedBranch} branch.
|
||||
* </p>
|
||||
* <p>
|
||||
* 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
|
||||
* gitmodules file.
|
||||
* @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.
|
||||
* @throws Exception If an exception occurs.
|
||||
*/
|
||||
|
@ -112,12 +112,12 @@ import java.util.List;
|
||||
/**
|
||||
* SSH daemon to communicate with Gerrit.
|
||||
* <p>
|
||||
* 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</code> to
|
||||
* 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} to
|
||||
* access the SSH daemon itself.
|
||||
* <p>
|
||||
* 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:
|
||||
* <pre>
|
||||
* Host gerrit-alias
|
||||
|
@ -71,7 +71,7 @@ public class SshUtil {
|
||||
* Convert an RFC 4716 style key to an OpenSSH style key.
|
||||
*
|
||||
* @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.
|
||||
*/
|
||||
public static String toOpenSshPublicKey(final String keyStr) {
|
||||
|
Loading…
Reference in New Issue
Block a user