Skip to content

Commit

Permalink
[LSC] Replace more uses of @code within .js files with Markdown backt…
Browse files Browse the repository at this point in the history
…icks.

-------------
Created by MOE: https://github.com/google/moe
MOE_MIGRATED_REVID=185484635
  • Loading branch information
concavelenz committed Feb 16, 2018
1 parent 89de36c commit c2e97ad
Show file tree
Hide file tree
Showing 30 changed files with 59 additions and 59 deletions.
2 changes: 1 addition & 1 deletion closure/goog/html/safestylesheet.js
Expand Up @@ -51,7 +51,7 @@ goog.require('goog.string.TypedString');
* goog.html.SafeStyleSheet.unwrap(styleSheet2)} must itself be a value that
* satisfies the SafeStyleSheet type constraint. This requirement implies that
* for any value `styleSheet` of this type,
* {@code goog.html.SafeStyleSheet.unwrap(styleSheet1)} must end in
* `goog.html.SafeStyleSheet.unwrap(styleSheet1)` must end in
* "beginning of rule" context.
* A SafeStyleSheet can be constructed via security-reviewed unchecked
Expand Down
4 changes: 2 additions & 2 deletions closure/goog/html/sanitizer/htmlsanitizer.js
Expand Up @@ -229,8 +229,8 @@ goog.html.sanitizer.HtmlSanitizer.wrapUrlPolicy_ = function(urlPolicy) {


/**
* The builder for the HTML Sanitizer. All methods except build return {@code
* this}.
* The builder for the HTML Sanitizer. All methods except build return
* `this`.
* @final @constructor @struct
*/
goog.html.sanitizer.HtmlSanitizer.Builder = function() {
Expand Down
10 changes: 5 additions & 5 deletions closure/goog/html/sanitizer/noclobber.js
Expand Up @@ -48,7 +48,7 @@ var userAgentProduct = goog.require('goog.userAgent.product');
*/

/**
* Shorthand for {@code Object.getOwnPropertyDescriptor(...).get} to improve
* Shorthand for `Object.getOwnPropertyDescriptor(...).get` to improve
* readability during initialization of `Methods`.
* @param {string} className
* @param {string} property
Expand Down Expand Up @@ -160,8 +160,8 @@ function genericMethodCall(fn, object, fallbackMethodName, args) {

/**
* Returns an element's attributes without falling prey to things like
* <form><input name="attributes"></form>. Equivalent to {@code
* node.attributes}.
* <form><input name="attributes"></form>. Equivalent to
* `node.attributes`.
* @param {!Element} element
* @return {!NamedNodeMap}
*/
Expand Down Expand Up @@ -237,8 +237,8 @@ function removeElementAttribute(element, attrName) {

/**
* Returns a node's innerHTML property value without falling prey to things like
* <form><input name="innerHTML"></form>. Equivalent to {@code
* element.innerHTML}.
* <form><input name="innerHTML"></form>. Equivalent to
* `element.innerHTML`.
* @param {!Element} element
* @return {string}
*/
Expand Down
4 changes: 2 additions & 2 deletions closure/goog/html/trustedresourceurl.js
Expand Up @@ -40,8 +40,8 @@ goog.require('goog.string.TypedString');
* this type.
*
* Instances of this type must be created via the factory method,
* (`fromConstant`, `fromConstants`, `format` or {@code
* formatWithParams}), and not by invoking its constructor. The constructor
* (`fromConstant`, `fromConstants`, `format` or
* `formatWithParams`), and not by invoking its constructor. The constructor
* intentionally takes no parameters and the type is immutable; hence only a
* default instance corresponding to the empty string can be obtained via
* constructor invocation.
Expand Down
4 changes: 2 additions & 2 deletions closure/goog/i18n/datetimeformat.js
Expand Up @@ -354,7 +354,7 @@ goog.i18n.DateTimeFormat.enforceAsciiDigits_ = false;

/**
* If RLM unicode characters should be removed from date/time patterns (useful
* when enforcing ASCII digits for Arabic). See {@code #setEnforceAsciiDigits}.
* when enforcing ASCII digits for Arabic). See `#setEnforceAsciiDigits`.
* @type {boolean}
* @private
*/
Expand Down Expand Up @@ -388,7 +388,7 @@ goog.i18n.DateTimeFormat.setEnforceAsciiDigits = function(enforceAsciiDigits) {

/**
* @return {boolean} Whether enforcing ASCII digits for all locales. See
* {@code #setEnforceAsciiDigits} for more details.
* `#setEnforceAsciiDigits` for more details.
*/
goog.i18n.DateTimeFormat.isEnforceAsciiDigits = function() {
return goog.i18n.DateTimeFormat.enforceAsciiDigits_;
Expand Down
10 changes: 5 additions & 5 deletions closure/goog/iter/iter.js
Expand Up @@ -776,7 +776,7 @@ goog.iter.accumulate = function(iterable) {
* Creates an iterator that returns arrays containing the ith elements from the
* provided iterables. The returned arrays will be the same size as the number
* of iterables given in `var_args`. Once the shortest iterable is
* exhausted, subsequent calls to {@code next()} will throw
* exhausted, subsequent calls to `next()` will throw
* `goog.iter.StopIteration`.
* @see http://docs.python.org/2/library/itertools.html#itertools.izip
* @param {...!goog.iter.Iterator<VALUE>|!goog.iter.Iterable} var_args Any
Expand Down Expand Up @@ -806,7 +806,7 @@ goog.iter.zip = function(var_args) {
* provided iterables. The returned arrays will be the same size as the number
* of iterables given in `var_args`. Shorter iterables will be extended
* with `fillValue`. Once the longest iterable is exhausted, subsequent
* calls to {@code next()} will throw `goog.iter.StopIteration`.
* calls to `next()` will throw `goog.iter.StopIteration`.
* @see http://docs.python.org/2/library/itertools.html#itertools.izip_longest
* @param {VALUE} fillValue The object or value used to fill shorter iterables.
* @param {...!goog.iter.Iterator<VALUE>|!goog.iter.Iterable} var_args Any
Expand Down Expand Up @@ -853,11 +853,11 @@ goog.iter.zipLongest = function(fillValue, var_args) {

/**
* Creates an iterator that filters `iterable` based on a series of
* `selectors`. On each call to {@code next()}, one item is taken from
* `selectors`. On each call to `next()`, one item is taken from
* both the `iterable` and `selectors` iterators. If the item from
* `selectors` evaluates to true, the item from `iterable` is given.
* Otherwise, it is skipped. Once either `iterable` or `selectors`
* is exhausted, subsequent calls to {@code next()} will throw
* is exhausted, subsequent calls to `next()` will throw
* `goog.iter.StopIteration`.
* @see http://docs.python.org/2/library/itertools.html#itertools.compress
* @param {!goog.iter.Iterator<VALUE>|!goog.iter.Iterable} iterable The
Expand Down Expand Up @@ -1115,7 +1115,7 @@ goog.iter.limit = function(iterable, limitSize) {
* Creates an iterator that is advanced `count` steps ahead. Consumed
* values are silently discarded. If `count` is greater than the number
* of elements in `iterable`, an empty iterator is returned. Subsequent
* calls to {@code next()} will throw `goog.iter.StopIteration`.
* calls to `next()` will throw `goog.iter.StopIteration`.
* @param {!goog.iter.Iterator<VALUE>|!goog.iter.Iterable} iterable The
* iterable to consume.
* @param {number} count The number of elements to consume from the iterator.
Expand Down
4 changes: 2 additions & 2 deletions closure/goog/json/json.js
Expand Up @@ -102,8 +102,8 @@ goog.json.errorLogger_ = goog.nullFunction;


/**
* Sets an error logger to use if there's a recoverable parsing error and {@code
* goog.json.TRY_NATIVE_JSON} is enabled.
* Sets an error logger to use if there's a recoverable parsing error and
* `goog.json.TRY_NATIVE_JSON` is enabled.
* @param {function(string, !Error)} errorLogger The first parameter is the
* error message, the second is the exception thrown by `JSON.parse`.
*/
Expand Down
2 changes: 1 addition & 1 deletion closure/goog/labs/mock/mock.js
Expand Up @@ -394,7 +394,7 @@ goog.labs.mock.MockManager_ = function() {


/**
* Allows callers of {@code #verify} to override the default verification
* Allows callers of `#verify` to override the default verification
* mode of this MockManager.
*
* @param {!goog.labs.mock.verification.VerificationMode} verificationMode
Expand Down
8 changes: 4 additions & 4 deletions closure/goog/labs/mock/verificationmode.js
Expand Up @@ -27,11 +27,11 @@ goog.provide('goog.labs.mock.verification.VerificationMode');
/**
* A mode which defines how mock invocations should be verified.
* When an instance of `VerificationMode` is passed to
* `goog.labs.mock.verify`, then that instances's {@code #verify}
* `goog.labs.mock.verify`, then that instances's `#verify`
* method will be used to verify the invocation.
*
* If {@code #verify} returns false, then the test will fail and the
* description returned from {@code #describe} will be shown in the
* If `#verify` returns false, then the test will fail and the
* description returned from `#describe` will be shown in the
* test failure message. Sample usage:
*
* goog.module('my.package.MyClassTest');
Expand Down Expand Up @@ -125,7 +125,7 @@ goog.labs.mock.verification.atMost = function(maxNumberOfInvocations) {

/**
* Returns a `VerificationMode` which verifies a method was never
* called. An alias for {@code VerificatonMode.times(0)}.
* called. An alias for `VerificatonMode.times(0)`.
*
* @return {!goog.labs.mock.verification.VerificationMode}
*/
Expand Down
4 changes: 2 additions & 2 deletions closure/goog/labs/pubsub/broadcastpubsub.js
Expand Up @@ -373,8 +373,8 @@ goog.labs.pubsub.BroadcastPubSub.IE8_TIMESTAMP_UNIQUE_OFFSET_MS_ = .01;
* This key is a static member shared by all instances of BroadcastPubSub in the
* same Window context. To avoid read-update-write contention, this key is only
* written in a single context in the cleanupIe8StorageEvents_ function. Since
* instances in other contexts will read this key there is code in the {@code
* publish} function to make sure timestamps are unique even within the same
* instances in other contexts will read this key there is code in the
* `publish` function to make sure timestamps are unique even within the same
* millisecond.
*
* @private @const {string}
Expand Down
2 changes: 1 addition & 1 deletion closure/goog/labs/structs/multimap.js
Expand Up @@ -115,7 +115,7 @@ goog.labs.structs.Multimap.prototype.addAllFromMultimap = function(map) {
* Replaces all the values for the given key with the given values.
* @param {K} key The key whose values are to be replaced.
* @param {!Array<V>} values The new values. If empty, this is
* equivalent to {@code removeAll(key)}.
* equivalent to `removeAll(key)`.
*/
goog.labs.structs.Multimap.prototype.replaceValues = function(key, values) {
this.removeAll(key);
Expand Down
2 changes: 1 addition & 1 deletion closure/goog/net/streams/jsonstreamparser.js
Expand Up @@ -227,7 +227,7 @@ Parser.prototype.done = function() {

/**
* Get the part of input that is after the end of the stream. Call this only
* when {@code this.done()} is true.
* when `this.done()` is true.
*
* @return {string} The extra input
*
Expand Down
4 changes: 2 additions & 2 deletions closure/goog/object/object.js
Expand Up @@ -708,8 +708,8 @@ goog.object.isImmutableView = function(obj) {
* Get all properties names on a given Object regardless of enumerability.
*
* <p> If the browser does not support `Object.getOwnPropertyNames` nor
* `Object.getPrototypeOf` then this is equivalent to using {@code
* goog.object.getKeys}
* `Object.getPrototypeOf` then this is equivalent to using
* `goog.object.getKeys`
*
* @param {?Object} obj The object to get the properties of.
* @param {boolean=} opt_includeObjectPrototype Whether properties defined on
Expand Down
6 changes: 3 additions & 3 deletions closure/goog/promise/promise.js
Expand Up @@ -97,21 +97,21 @@ goog.Promise = function(resolver, opt_context) {
this.result_ = undefined;

/**
* For Promises created by calling {@code then()}, the originating parent.
* For Promises created by calling `then()`, the originating parent.
* @private {goog.Promise}
*/
this.parent_ = null;

/**
* The linked list of `onFulfilled` and `onRejected` callbacks
* added to this Promise by calls to {@code then()}.
* added to this Promise by calls to `then()`.
* @private {?goog.Promise.CallbackEntry_}
*/
this.callbackEntries_ = null;

/**
* The tail of the linked list of `onFulfilled` and `onRejected`
* callbacks added to this Promise by calls to {@code then()}.
* callbacks added to this Promise by calls to `then()`.
* @private {?goog.Promise.CallbackEntry_}
*/
this.callbackEntriesTail_ = null;
Expand Down
2 changes: 1 addition & 1 deletion closure/goog/soy/data.js
Expand Up @@ -429,7 +429,7 @@ goog.soy.data.SanitizedHtmlAttribute.isCompatibleWith = function(value) {
/**
* Content of type {@link goog.soy.data.SanitizedContentKind.STYLE}.
*
* The content is non-attacker-exploitable CSS, such as {@code color:#c3d9ff}.
* The content is non-attacker-exploitable CSS, such as `color:#c3d9ff`.
* The content direction is LTR.
*
* @extends {goog.soy.data.SanitizedContent}
Expand Down
4 changes: 2 additions & 2 deletions closure/goog/soy/renderer.js
Expand Up @@ -25,7 +25,7 @@
* </pre>
*
* The injected data can then be referred to in any soy templates as
* part of a magic "ij" parameter. For example, {@code $ij.dataKey}
* part of a magic "ij" parameter. For example, `$ij.dataKey`
* will evaluate to 'value' with the above injected data.
*
* @author henrywong@google.com (Henry Wong)
Expand All @@ -51,7 +51,7 @@ goog.require('goog.soy.data.SanitizedContentKind');
* @param {goog.soy.InjectedDataSupplier=} opt_injectedDataSupplier A supplier
* that provides an injected data.
* @param {goog.dom.DomHelper=} opt_domHelper Optional DOM helper;
* defaults to that provided by {@code goog.dom.getDomHelper()}.
* defaults to that provided by `goog.dom.getDomHelper()`.
* @constructor
*/
goog.soy.Renderer = function(opt_injectedDataSupplier, opt_domHelper) {
Expand Down
4 changes: 2 additions & 2 deletions closure/goog/structs/circularbuffer.js
Expand Up @@ -71,7 +71,7 @@ goog.structs.CircularBuffer.prototype.add = function(item) {
/**
* Returns the item at the specified index.
* @param {number} index The index of the item. The index of an item can change
* after calls to {@code add()} if the buffer is at maximum size.
* after calls to `add()` if the buffer is at maximum size.
* @return {T} The item at the specified index.
*/
goog.structs.CircularBuffer.prototype.get = function(index) {
Expand All @@ -83,7 +83,7 @@ goog.structs.CircularBuffer.prototype.get = function(index) {
/**
* Sets the item at the specified index.
* @param {number} index The index of the item. The index of an item can change
* after calls to {@code add()} if the buffer is at maximum size.
* after calls to `add()` if the buffer is at maximum size.
* @param {T} item The item to add.
*/
goog.structs.CircularBuffer.prototype.set = function(index, item) {
Expand Down
4 changes: 2 additions & 2 deletions closure/goog/structs/pool.js
Expand Up @@ -275,7 +275,7 @@ goog.structs.Pool.prototype.createObject = function() {
/**
* Should be overridden to dispose of an object. Default implementation is to
* remove all its members, which should render it useless. Calls the object's
* {@code dispose()} method, if available.
* `dispose()` method, if available.
* @param {T} obj The object to dispose.
*/
goog.structs.Pool.prototype.disposeObject = function(obj) {
Expand All @@ -292,7 +292,7 @@ goog.structs.Pool.prototype.disposeObject = function(obj) {
/**
* Should be overridden to determine whether an object has become unusable and
* should not be returned by getObject(). Calls the object's
* {@code canBeReused()} method, if available.
* `canBeReused()` method, if available.
* @param {T} obj The object to test.
* @return {boolean} Whether the object can be reused.
*/
Expand Down
2 changes: 1 addition & 1 deletion closure/goog/style/style.js
Expand Up @@ -73,7 +73,7 @@ goog.style.setStyle = function(element, style, opt_value) {

/**
* Sets a style value on an element, with parameters swapped to work with
* {@code goog.object.forEach()}. Prepends a vendor-specific prefix when
* `goog.object.forEach()`. Prepends a vendor-specific prefix when
* necessary.
* @param {Element} element The element to change.
* @param {string|number|boolean|undefined} value Style value.
Expand Down
4 changes: 2 additions & 2 deletions closure/goog/testing/propertyreplacer.js
Expand Up @@ -62,8 +62,8 @@ goog.require('goog.userAgent');
* the real constructor or kept untouched.
* </ul>
*
* Code compiled with property renaming may need to use {@code
* goog.reflect.objectProperty} instead of simply naming the property to
* Code compiled with property renaming may need to use
* `goog.reflect.objectProperty` instead of simply naming the property to
* replace.
*
* @constructor
Expand Down
2 changes: 1 addition & 1 deletion closure/goog/testing/shardingtestcase.js
Expand Up @@ -19,7 +19,7 @@
* <ol>
* <li>Instead of writing your large test in foo_test.html, write it in
* foo_test_template.html</li>
* <li>Add a call to {@code goog.testing.ShardingTestCase.shardByFileName()}
* <li>Add a call to `goog.testing.ShardingTestCase.shardByFileName()`
* near the top of your test, before any test cases or setup methods.</li>
* <li>Symlink foo_test_template.html into different sharded test files
* named foo_1of4_test.html, foo_2of4_test.html, etc, using `ln -s`.</li>
Expand Down
4 changes: 2 additions & 2 deletions closure/goog/testing/testcase.js
Expand Up @@ -1397,7 +1397,7 @@ goog.testing.TestCase.prototype.timeout = function(fn, time) {


/**
* Clears a timeout created by {@code this.timeout()}.
* Clears a timeout created by `this.timeout()`.
* @param {number} id A timeout id.
* @protected
*/
Expand Down Expand Up @@ -1559,7 +1559,7 @@ goog.testing.TestCase.prototype.raiseAssertionException = function(e) {
* Removes the specified exception from being tracked. This only needs to be
* called for internal functions that intentionally catch an exception, such
* as
* {@code #assertThrowsJsUnitException}.
* `#assertThrowsJsUnitException`.
* @param {!goog.testing.JsUnitException} e The exception object to invalidate.
* @package
*/
Expand Down
2 changes: 1 addition & 1 deletion closure/goog/ui/component.js
Expand Up @@ -976,7 +976,7 @@ goog.ui.Component.prototype.addChild = function(child, opt_render) {
* then immediately decorate/render the child.
* </ul>
*
* In particular, {@code parent.addChild(child)} will throw an error if the
* In particular, `parent.addChild(child)` will throw an error if the
* child component is already in the document, but the parent isn't.
*
* Clients of this API may call `addChild` and `addChildAt` with
Expand Down
4 changes: 2 additions & 2 deletions closure/goog/ui/control.js
Expand Up @@ -956,7 +956,7 @@ goog.ui.Control.prototype.setChecked = function(check) {

/**
* Returns true if the component is styled to indicate that it has keyboard
* focus, false otherwise. Note that {@code isFocused()} returning true
* focus, false otherwise. Note that `isFocused()` returning true
* doesn't guarantee that the component's key event target has keyborad focus,
* only that it is styled as such.
* @return {boolean} Whether the component is styled to indicate as having
Expand All @@ -971,7 +971,7 @@ goog.ui.Control.prototype.isFocused = function() {
* Applies or removes styling indicating that the component has keyboard focus.
* Note that unlike the other "set" methods, this method is called as a result
* of the component's element having received or lost keyboard focus, not the
* other way around, so calling {@code setFocused(true)} doesn't guarantee that
* other way around, so calling `setFocused(true)` doesn't guarantee that
* the component's key event target has keyboard focus, only that it is styled
* as such.
* @param {boolean} focused Whether to apply or remove styling to indicate that
Expand Down
2 changes: 1 addition & 1 deletion closure/goog/ui/custombutton.js
Expand Up @@ -29,7 +29,7 @@ goog.require('goog.ui.registry');
/**
* A custom button control. Identical to {@link goog.ui.Button}, except it
* defaults its renderer to {@link goog.ui.CustomButtonRenderer}. One could
* just as easily pass {@code goog.ui.CustomButtonRenderer.getInstance()} to
* just as easily pass `goog.ui.CustomButtonRenderer.getInstance()` to
* the {@link goog.ui.Button} constructor and get the same result. Provided
* for convenience.
*
Expand Down
2 changes: 1 addition & 1 deletion closure/goog/ui/media/media.js
Expand Up @@ -193,7 +193,7 @@ goog.inherits(goog.ui.media.MediaRenderer, goog.ui.ControlRenderer);
/**
* Builds the common DOM structure of medias. Builds an outer div, and appends
* a child div with the `goog.ui.Control.getContent` content. Marks the
* caption with a {@code this.getClassClass()} + '-caption' css flag, so that
* caption with a `this.getClassClass()` + '-caption' css flag, so that
* specific renderers can hide/show the caption as desired.
*
* @param {goog.ui.Control} control The control instance.
Expand Down
4 changes: 2 additions & 2 deletions closure/goog/ui/menubutton.js
Expand Up @@ -279,8 +279,8 @@ goog.ui.MenuButton.prototype.handleMouseUp = function(e) {

/**
* Performs the appropriate action when the menu button is activated by the
* user. Overrides the superclass implementation by not dispatching an {@code
* ACTION} event, because menu buttons exist only to reveal menus, not to
* user. Overrides the superclass implementation by not dispatching an
* `ACTION` event, because menu buttons exist only to reveal menus, not to
* perform actions themselves. Calls {@link #setActive} to deactivate the
* button.
* @param {goog.events.Event} e Mouse or key event that triggered the action.
Expand Down

0 comments on commit c2e97ad

Please sign in to comment.