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:
@@ -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.
|
||||
|
||||
Reference in New Issue
Block a user