opendev/gerrit
Code Issues Proposed changes

Replace <code> with {@code} in javadoc

Browse Source 
{@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
Download Patch File Download Diff File Expand all files Collapse all files

6
gerrit-reviewdb/src/main/java/com/google/gerrit/reviewdb/client/Project.java
View File

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

2
gerrit-reviewdb/src/main/java/com/google/gerrit/reviewdb/client/RevId.java
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.
*/
public RevId max() {

16
gerrit-reviewdb/src/main/java/com/google/gerrit/reviewdb/server/SubmoduleSubscriptionAccess.java
View File

@@ -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 = ?")