mirror of
https://github.com/google/nomulus.git
synced 2025-05-16 09:27:16 +02:00
Replace uses of @code in Javascript documentation with Markdown backticks
Rosie CL for []/third_party (local approval/rejection).
[]
b/71392935
Tested:
TAP --sample for global presubmit queue
[]
-------------
Created by MOE: https://github.com/google/moe
MOE_MIGRATED_REVID=184412611
This commit is contained in:
jianglai
parent
98a61b8181
commit
88d453d6a9
15 changed files with 36 additions and 36 deletions
|
|
@ -152,7 +152,7 @@ braintreepayments.ErrorField.prototype.fieldKey;
|
|||
|
||||
|
||||
/**
|
||||
* This will be {@code true} if the associated input is empty.
|
||||
* This will be `true` if the associated input is empty.
|
||||
* @type {(boolean|undefined)}
|
||||
* @const
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -41,7 +41,7 @@ registry.json.Response = function() {};
|
|||
|
||||
|
||||
/**
|
||||
* Request state which can be {@code SUCCESS} or {@code ERROR}.
|
||||
* Request state which can be `SUCCESS` or `ERROR`.
|
||||
* @type {string}
|
||||
*/
|
||||
registry.json.Response.prototype.status;
|
||||
|
|
|
|||
|
|
@ -68,8 +68,8 @@ registry.Component = function(cons) {
|
|||
this.basePath = '';
|
||||
|
||||
/**
|
||||
* Bean counter that's used by {@code addRemBtnHandlers},
|
||||
* e.g. {@code typeCounts['host']++} when user adds or removes.
|
||||
* Bean counter that's used by `addRemBtnHandlers`,
|
||||
* e.g. `typeCounts['host']++` when user adds or removes.
|
||||
* @type {!Object.<string, number>}
|
||||
* @protected
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -135,7 +135,7 @@ registry.EditItem.prototype.isEditing = function() {
|
|||
|
||||
/**
|
||||
* Toggles the editing state of a component. This will first hide the
|
||||
* elements of the {@code shown} class, then adds the {@code editing}
|
||||
* elements of the `shown` class, then adds the `editing`
|
||||
* style to the component, then shows the elements that had the {@code
|
||||
* hidden} class.
|
||||
*/
|
||||
|
|
@ -278,7 +278,7 @@ registry.EditItem.prototype.sendDelete = goog.abstractMethod;
|
|||
|
||||
/**
|
||||
* Subclasses should override to populate update queryParams with form
|
||||
* fields as needed. {@code queryParams.nextId} MUST be set to the
|
||||
* fields as needed. `queryParams.nextId` MUST be set to the
|
||||
* new object's ID.
|
||||
* @param {!Object} queryParams
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -64,7 +64,7 @@ registry.registrar.BrainFrame = function(origin, containerId) {
|
|||
this.container_ = goog.dom.getRequiredElement(containerId);
|
||||
|
||||
/**
|
||||
* Last known height of {@code container_}.
|
||||
* Last known height of `container_`.
|
||||
* @private {number}
|
||||
*/
|
||||
this.containerHeight_ = 0;
|
||||
|
|
@ -79,7 +79,7 @@ registry.registrar.BrainFrame = function(origin, containerId) {
|
|||
this.listen(this.resizeTimer_, goog.Timer.TICK, this.onResizeTimer_);
|
||||
|
||||
/**
|
||||
* Form that wraps {@code container_}.
|
||||
* Form that wraps `container_`.
|
||||
* @private {?Element}
|
||||
* @const
|
||||
*/
|
||||
|
|
@ -204,7 +204,7 @@ registry.registrar.BrainFrame.prototype.onPaymentMethod_ = function(pm) {
|
|||
|
||||
/**
|
||||
* Sends message to parent iframe.
|
||||
* @param {...*} var_args Passed along to {@code goog.object.create}.
|
||||
* @param {...*} var_args Passed along to `goog.object.create`.
|
||||
* @private
|
||||
*/
|
||||
registry.registrar.BrainFrame.prototype.send_ = function(var_args) {
|
||||
|
|
@ -216,7 +216,7 @@ registry.registrar.BrainFrame.prototype.send_ = function(var_args) {
|
|||
|
||||
|
||||
/**
|
||||
* Delegates to {@code window.parent.postMessage}. This method exists because
|
||||
* Delegates to `window.parent.postMessage`. This method exists because
|
||||
* IE will not allow us to mock methods on the window object.
|
||||
* @param {string} message
|
||||
* @param {string} origin
|
||||
|
|
|
|||
|
|
@ -103,7 +103,7 @@ goog.inherits(registry.registrar.Console, registry.Console);
|
|||
* #type/id
|
||||
* </pre>
|
||||
*
|
||||
* <p>The {@code id} part may be appended by {@code ()} to specify the target
|
||||
* <p>The `id` part may be appended by {@code ()} to specify the target
|
||||
* should be a resource create page.
|
||||
*
|
||||
* @override
|
||||
|
|
|
|||
|
|
@ -24,7 +24,7 @@ goog.forwardDeclare('registry.registrar.Console');
|
|||
|
||||
|
||||
/**
|
||||
* The {@code Contact} class respresents a registry contact object and
|
||||
* The `Contact` class respresents a registry contact object and
|
||||
* binds UI CRUD operations to it.
|
||||
* @param {!registry.registrar.Console} console the
|
||||
* console singleton.
|
||||
|
|
|
|||
|
|
@ -59,15 +59,15 @@ goog.forwardDeclare('registry.registrar.Console');
|
|||
*
|
||||
* <p>We fix this problem by embedding the Braintree iframe inside another
|
||||
* sandbox iframe that's hosted from a Cloud Storage bucket. This frame is
|
||||
* defined by {@code brainframe.html}. It's basically an empty shell that sends
|
||||
* a request back to the production environment for {@code brainframe.js}.
|
||||
* defined by `brainframe.html`. It's basically an empty shell that sends
|
||||
* a request back to the production environment for `brainframe.js`.
|
||||
*
|
||||
* <p>The importance of the Cloud Storage bucket is that it is served from a
|
||||
* separate domain. This causes the browser to forbid the iframe from accessing
|
||||
* the contents of the parent frame. The HTML5 {@code sandbox} attribute does
|
||||
* the contents of the parent frame. The HTML5 `sandbox` attribute does
|
||||
* this too, but we can't use it, because the Venmo functionality in the
|
||||
* Braintree JS SDK needs to be able to access {@code document.cookie}, which
|
||||
* is forbidden in a sandbox environment. This HTML5 {@code sandbox} feature is
|
||||
* Braintree JS SDK needs to be able to access `document.cookie`, which
|
||||
* is forbidden in a sandbox environment. This HTML5 `sandbox` feature is
|
||||
* also not available in older versions of Internet Explorer.
|
||||
*
|
||||
* <h3>Business Logic</h3>
|
||||
|
|
@ -140,7 +140,7 @@ registry.registrar.Payment = function(console, xsrfToken) {
|
|||
this.currencyMenu_ = null;
|
||||
|
||||
/**
|
||||
* XHR client to {@code RegistrarPaymentSetupAction}.
|
||||
* XHR client to `RegistrarPaymentSetupAction`.
|
||||
* @private {!registry.Session.<!registry.rpc.PaymentSetup.Request,
|
||||
* !registry.rpc.PaymentSetup.Response>}
|
||||
* @const
|
||||
|
|
@ -151,7 +151,7 @@ registry.registrar.Payment = function(console, xsrfToken) {
|
|||
registry.Session.ContentType.JSON);
|
||||
|
||||
/**
|
||||
* XHR client to {@code RegistrarPaymentAction}.
|
||||
* XHR client to `RegistrarPaymentAction`.
|
||||
* @private {!registry.Session.<!registry.rpc.Payment.Request,
|
||||
* !registry.rpc.Payment.Response>}
|
||||
* @const
|
||||
|
|
@ -271,7 +271,7 @@ registry.registrar.Payment.prototype.onPayment_ = function(response) {
|
|||
|
||||
|
||||
/**
|
||||
* Handler invoked when {@code brainframe.js} sends us a message.
|
||||
* Handler invoked when `brainframe.js` sends us a message.
|
||||
* @param {!goog.events.BrowserEvent} e
|
||||
* @private
|
||||
*/
|
||||
|
|
@ -370,7 +370,7 @@ registry.registrar.Payment.prototype.setPaymentMethod_ = function(pm) {
|
|||
|
||||
/**
|
||||
* Sends message to brainframe.
|
||||
* @param {...*} var_args Passed along to {@code goog.object.create}.
|
||||
* @param {...*} var_args Passed along to `goog.object.create`.
|
||||
* @private
|
||||
*/
|
||||
registry.registrar.Payment.prototype.send_ = function(var_args) {
|
||||
|
|
@ -402,7 +402,7 @@ registry.registrar.Payment.setEnabled_ = function(enabled) {
|
|||
|
||||
|
||||
/**
|
||||
* Returns {@code true} if browser has all the features we need.
|
||||
* Returns `true` if browser has all the features we need.
|
||||
* @return {boolean}
|
||||
* @private
|
||||
* @see "http://caniuse.com/#feat=dispatchevent"
|
||||
|
|
|
|||
|
|
@ -91,7 +91,7 @@ registry.registrar.XmlResourceComponent.prototype.handleFetchItem =
|
|||
|
||||
/**
|
||||
* Sublcasses should override to populate create queryParams with form
|
||||
* fields as needed. {@code queryParams.nextId} MUST be set to the
|
||||
* fields as needed. `queryParams.nextId` MUST be set to the
|
||||
* new object's ID.
|
||||
* @param {!Object} queryParams
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -118,7 +118,7 @@ registry.Session.PARSER_BREAKER_ = ')]}\'\n';
|
|||
|
||||
|
||||
/**
|
||||
* Displays {@code message} to user in bloody butterbar.
|
||||
* Displays `message` to user in bloody butterbar.
|
||||
* @param {string} message
|
||||
* @private
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -50,9 +50,9 @@ registry.util.cssShown = goog.getCssName('shown');
|
|||
|
||||
|
||||
/**
|
||||
* Changes element visibility by toggling CSS {@code shown} to {@code hidden}.
|
||||
* Changes element visibility by toggling CSS `shown` to `hidden`.
|
||||
* @param {!Element|string} element Element or id attribute of element.
|
||||
* @param {boolean} visible Shows {@code element} if true, or else hides it.
|
||||
* @param {boolean} visible Shows `element` if true, or else hides it.
|
||||
*/
|
||||
registry.util.setVisible = function(element, visible) {
|
||||
goog.dom.classlist.addRemove(
|
||||
|
|
@ -117,7 +117,7 @@ registry.util.renderBeforeRow = function(id, tmpl, tmplParams) {
|
|||
* Turns an HTML form's named elements into a JSON data structure with
|
||||
* Pablo's black magick.
|
||||
* @param {string} formName the name of the form to be parsed.
|
||||
* @throws {Error} if {@code formName} couldn't be found.
|
||||
* @throws {Error} if `formName` couldn't be found.
|
||||
* @return {!Object} the parsed form values as an object.
|
||||
*/
|
||||
registry.util.parseForm = function(formName) {
|
||||
|
|
|
|||
|
|
@ -86,8 +86,8 @@ function testButter() {
|
|||
|
||||
|
||||
/**
|
||||
* The EPP login should be triggered if the user {@code isGaeLoggedIn}
|
||||
* but not yet {@code isEppLoggedIn}.
|
||||
* The EPP login should be triggered if the user `isGaeLoggedIn`
|
||||
* but not yet `isEppLoggedIn`.
|
||||
*/
|
||||
function testEppLogin() {
|
||||
// This is a little complex, as handleHashChange triggers an async
|
||||
|
|
|
|||
|
|
@ -25,7 +25,7 @@ goog.require('registry.xml');
|
|||
|
||||
|
||||
/**
|
||||
* Utility method that attaches mocks to a {@code TestCase}. This was
|
||||
* Utility method that attaches mocks to a `TestCase`. This was
|
||||
* originally in the ctor for ConsoleTest and should simply be
|
||||
* inherited but jstd_test breaks inheritance in test cases.
|
||||
* @param {Object} test the test case to configure.
|
||||
|
|
@ -47,7 +47,7 @@ registry.registrar.ConsoleTestUtil.setup = function(test) {
|
|||
|
||||
/**
|
||||
* Simulates visiting a page on the console. Sets path, then mocks
|
||||
* session and calls {@code handleHashChange_}.
|
||||
* session and calls `handleHashChange_`.
|
||||
* @param {Object} test the test case to configure.
|
||||
* @param {Object=} opt_args may include path, isEppLoggedIn.
|
||||
* @param {Function=} opt_moar extra setup after called just before
|
||||
|
|
|
|||
|
|
@ -78,7 +78,7 @@ registry.testing.click = function(element) {
|
|||
|
||||
|
||||
/**
|
||||
* Asserts {@code element} has 'shown' class.
|
||||
* Asserts `element` has 'shown' class.
|
||||
* @param {!Element} element
|
||||
*/
|
||||
registry.testing.assertVisible = function(element) {
|
||||
|
|
@ -88,7 +88,7 @@ registry.testing.assertVisible = function(element) {
|
|||
|
||||
|
||||
/**
|
||||
* Asserts {@code element} has 'hidden' class.
|
||||
* Asserts `element` has 'hidden' class.
|
||||
* @param {!Element} element
|
||||
*/
|
||||
registry.testing.assertHidden = function(element) {
|
||||
|
|
@ -98,7 +98,7 @@ registry.testing.assertHidden = function(element) {
|
|||
|
||||
|
||||
/**
|
||||
* Like {@code assertObjectEquals} but with a better error message.
|
||||
* Like `assertObjectEquals` but with a better error message.
|
||||
* @param {?Object} a
|
||||
* @param {?Object} b
|
||||
*/
|
||||
|
|
@ -116,7 +116,7 @@ registry.testing.assertObjectEqualsPretty = function(a, b) {
|
|||
|
||||
|
||||
/**
|
||||
* JSON request/response simulator for {@code ResourceComponent} subclasses.
|
||||
* JSON request/response simulator for `ResourceComponent` subclasses.
|
||||
* @param {string} xsrfToken
|
||||
* @param {string} path server resource path.
|
||||
* @param {!Object} expectReqJson assert this object was sent,
|
||||
|
|
|
|||
|
|
@ -173,7 +173,7 @@ function testEppMessage() {
|
|||
|
||||
|
||||
/**
|
||||
* Asserts {@code xml} turns into {@code json}.
|
||||
* Asserts `xml` turns into `json`.
|
||||
* @param {!Object} json
|
||||
* @param {string} xml
|
||||
*/
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue