Skip to content

Commit

Permalink
changed inline @link tag to block-level @see tag (#15616)
Browse files Browse the repository at this point in the history
  • Loading branch information
codesue authored and nosolosw committed May 14, 2019
1 parent 8bc45fa commit 5bbda36
Show file tree
Hide file tree
Showing 10 changed files with 34 additions and 34 deletions.
4 changes: 2 additions & 2 deletions packages/block-editor/src/components/rich-text/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ const { getSelection, getComputedStyle } = window;
/**
* All inserting input types that would insert HTML into the DOM.
*
* @see https://www.w3.org/TR/input-events-2/#interface-InputEvent-Attributes
* @see https://www.w3.org/TR/input-events-2/#interface-InputEvent-Attributes
*
* @type {Set}
*/
Expand Down Expand Up @@ -563,7 +563,7 @@ export class RichText extends Component {
* selection where caret is at directional edge: forward for a delete key,
* reverse for a backspace key.
*
* @link https://en.wikipedia.org/wiki/Caret_navigation
* @see https://en.wikipedia.org/wiki/Caret_navigation
*
* @param {KeyboardEvent} event Keydown event.
*/
Expand Down
4 changes: 2 additions & 2 deletions packages/blocks/src/api/parser.js
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ export function isOfTypes( value, types ) {
* Returns true if value is valid per the given block attribute schema type
* definition, or false otherwise.
*
* @link https://json-schema.org/latest/json-schema-validation.html#rfc.section.6.1.1
* @see https://json-schema.org/latest/json-schema-validation.html#rfc.section.6.1.1
*
* @param {*} value Value to test.
* @param {?(Array<string>|string)} type Block attribute schema type.
Expand All @@ -135,7 +135,7 @@ export function isValidByType( value, type ) {
* Returns true if value is valid per the given block attribute schema enum
* definition, or false otherwise.
*
* @link https://json-schema.org/latest/json-schema-validation.html#rfc.section.6.1.2
* @see https://json-schema.org/latest/json-schema-validation.html#rfc.section.6.1.2
*
* @param {*} value Value to test.
* @param {?Array} enumSet Block attribute schema enum.
Expand Down
8 changes: 4 additions & 4 deletions packages/blocks/src/api/validation.js
Original file line number Diff line number Diff line change
Expand Up @@ -170,8 +170,8 @@ const TEXT_NORMALIZATIONS = [
* references.every( ( reference ) => /^[\da-z]+$/i.test( reference ) )
* ```
*
* @link https://html.spec.whatwg.org/multipage/syntax.html#character-references
* @link https://html.spec.whatwg.org/multipage/named-characters.html#named-character-references
* @see https://html.spec.whatwg.org/multipage/syntax.html#character-references
* @see https://html.spec.whatwg.org/multipage/named-characters.html#named-character-references
*
* @type {RegExp}
*/
Expand All @@ -183,7 +183,7 @@ const REGEXP_NAMED_CHARACTER_REFERENCE = /^[\da-z]+$/i;
* "The ampersand must be followed by a U+0023 NUMBER SIGN character (#),
* followed by one or more ASCII digits, representing a base-ten integer"
*
* @link https://html.spec.whatwg.org/multipage/syntax.html#character-references
* @see https://html.spec.whatwg.org/multipage/syntax.html#character-references
*
* @type {RegExp}
*/
Expand All @@ -197,7 +197,7 @@ const REGEXP_DECIMAL_CHARACTER_REFERENCE = /^#\d+$/;
* U+0058 LATIN CAPITAL LETTER X character (X), which must then be followed by
* one or more ASCII hex digits, representing a hexadecimal integer"
*
* @link https://html.spec.whatwg.org/multipage/syntax.html#character-references
* @see https://html.spec.whatwg.org/multipage/syntax.html#character-references
*
* @type {RegExp}
*/
Expand Down
2 changes: 1 addition & 1 deletion packages/components/src/disabled/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ const { Consumer, Provider } = createContext( false );
*
* See WHATWG HTML Standard: 4.10.18.5: "Enabling and disabling form controls: the disabled attribute".
*
* @link https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#enabling-and-disabling-form-controls:-the-disabled-attribute
* @see https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#enabling-and-disabling-form-controls:-the-disabled-attribute
*
* @type {string[]}
*/
Expand Down
2 changes: 1 addition & 1 deletion packages/docgen/src/test/fixtures/tags-function/code.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
* @since v2
*
* @see addition
* @link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Arithmetic_Operators
* @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Arithmetic_Operators
*
* @param {number} firstParam The first param to add.
* @param {number} secondParam The second param to add.
Expand Down
4 changes: 2 additions & 2 deletions packages/e2e-test-utils/src/press-key-with-modifier.js
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ import { modifiers, SHIFT, ALT, CTRL } from '@wordpress/keycodes';
* that any `Event#preventDefault` which would have normally occurred in the
* application as a result of Ctrl+A is respected.
*
* @link https://github.com/GoogleChrome/puppeteer/issues/1313
* @link https://w3c.github.io/uievents/tools/key-event-viewer.html
* @see https://github.com/GoogleChrome/puppeteer/issues/1313
* @see https://w3c.github.io/uievents/tools/key-event-viewer.html
*
* @return {Promise} Promise resolving once the SelectAll emulation completes.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ const getGalleryDetailsMediaFrame = () => {
/**
* Custom gallery details frame.
*
* @link https://github.com/xwp/wp-core-media-widgets/blob/905edbccfc2a623b73a93dac803c5335519d7837/wp-admin/js/widgets/media-gallery-widget.js
* @see https://github.com/xwp/wp-core-media-widgets/blob/905edbccfc2a623b73a93dac803c5335519d7837/wp-admin/js/widgets/media-gallery-widget.js
* @class GalleryDetailsMediaFrame
* @constructor
*/
Expand Down
12 changes: 6 additions & 6 deletions packages/escape-html/src/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import __unstableEscapeGreaterThan from './escape-greater';
* U+0020 SPACE, U+0022 ("), U+0027 ('), U+003E (>), U+002F (/), U+003D (=),
* and noncharacters."
*
* @link https://html.spec.whatwg.org/multipage/syntax.html#attributes-2
* @see https://html.spec.whatwg.org/multipage/syntax.html#attributes-2
*
* @type {RegExp}
*/
Expand All @@ -22,9 +22,9 @@ const REGEXP_INVALID_ATTRIBUTE_NAME = /[\u007F-\u009F "'>/="\uFDD0-\uFDEF]/;
* named, decimal, or hexadecimal character references are escaped. Invalid
* named references (i.e. ambiguous ampersand) are are still permitted.
*
* @link https://w3c.github.io/html/syntax.html#character-references
* @link https://w3c.github.io/html/syntax.html#ambiguous-ampersand
* @link https://w3c.github.io/html/syntax.html#named-character-references
* @see https://w3c.github.io/html/syntax.html#character-references
* @see https://w3c.github.io/html/syntax.html#ambiguous-ampersand
* @see https://w3c.github.io/html/syntax.html#named-character-references
*
* @param {string} value Original string.
*
Expand Down Expand Up @@ -59,7 +59,7 @@ export function escapeLessThan( value ) {
/**
* Returns an escaped attribute value.
*
* @link https://w3c.github.io/html/syntax.html#elements-attributes
* @see https://w3c.github.io/html/syntax.html#elements-attributes
*
* "[...] the text cannot contain an ambiguous ampersand [...] must not contain
* any literal U+0022 QUOTATION MARK characters (")"
Expand All @@ -83,7 +83,7 @@ export function escapeAttribute( value ) {
/**
* Returns an escaped HTML element value.
*
* @link https://w3c.github.io/html/syntax.html#writing-html-documents-elements
* @see https://w3c.github.io/html/syntax.html#writing-html-documents-elements
*
* "the text must not contain the character U+003C LESS-THAN SIGN (<) or an
* ambiguous ampersand."
Expand Down
2 changes: 1 addition & 1 deletion packages/redux-routine/src/is-generator.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/**
* Returns true if the given object is a generator, or false otherwise.
*
* @link https://www.ecma-international.org/ecma-262/6.0/#sec-generator-objects
* @see https://www.ecma-international.org/ecma-262/6.0/#sec-generator-objects
*
* @param {*} object Object to test.
*
Expand Down
28 changes: 14 additions & 14 deletions packages/token-list/src/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import { uniq, compact, without } from 'lodash';
/**
* A set of tokens.
*
* @link https://dom.spec.whatwg.org/#domtokenlist
* @see https://dom.spec.whatwg.org/#domtokenlist
*/
export default class TokenList {
/**
Expand All @@ -27,7 +27,7 @@ export default class TokenList {
/**
* Returns the associated set as string.
*
* @link https://dom.spec.whatwg.org/#dom-domtokenlist-value
* @see https://dom.spec.whatwg.org/#dom-domtokenlist-value
*
* @return {string} Token set as string.
*/
Expand All @@ -38,7 +38,7 @@ export default class TokenList {
/**
* Replaces the associated set with a new string value.
*
* @link https://dom.spec.whatwg.org/#dom-domtokenlist-value
* @see https://dom.spec.whatwg.org/#dom-domtokenlist-value
*
* @param {string} value New token set as string.
*/
Expand All @@ -51,7 +51,7 @@ export default class TokenList {
/**
* Returns the number of tokens.
*
* @link https://dom.spec.whatwg.org/#dom-domtokenlist-length
* @see https://dom.spec.whatwg.org/#dom-domtokenlist-length
*
* @return {number} Number of tokens.
*/
Expand All @@ -62,8 +62,8 @@ export default class TokenList {
/**
* Returns the stringified form of the TokenList.
*
* @link https://dom.spec.whatwg.org/#DOMTokenList-stringification-behavior
* @link https://www.ecma-international.org/ecma-262/9.0/index.html#sec-tostring
* @see https://dom.spec.whatwg.org/#DOMTokenList-stringification-behavior
* @see https://www.ecma-international.org/ecma-262/9.0/index.html#sec-tostring
*
* @return {string} Token set as string.
*/
Expand All @@ -74,7 +74,7 @@ export default class TokenList {
/**
* Returns an iterator for the TokenList, iterating items of the set.
*
* @link https://dom.spec.whatwg.org/#domtokenlist
* @see https://dom.spec.whatwg.org/#domtokenlist
*
* @return {Generator} TokenList iterator.
*/
Expand All @@ -85,7 +85,7 @@ export default class TokenList {
/**
* Returns the token with index `index`.
*
* @link https://dom.spec.whatwg.org/#dom-domtokenlist-item
* @see https://dom.spec.whatwg.org/#dom-domtokenlist-item
*
* @param {number} index Index at which to return token.
*
Expand All @@ -98,7 +98,7 @@ export default class TokenList {
/**
* Returns true if `token` is present, and false otherwise.
*
* @link https://dom.spec.whatwg.org/#dom-domtokenlist-contains
* @see https://dom.spec.whatwg.org/#dom-domtokenlist-contains
*
* @param {string} item Token to test.
*
Expand All @@ -111,7 +111,7 @@ export default class TokenList {
/**
* Adds all arguments passed, except those already present.
*
* @link https://dom.spec.whatwg.org/#dom-domtokenlist-add
* @see https://dom.spec.whatwg.org/#dom-domtokenlist-add
*
* @param {...string} items Items to add.
*/
Expand All @@ -122,7 +122,7 @@ export default class TokenList {
/**
* Removes arguments passed, if they are present.
*
* @link https://dom.spec.whatwg.org/#dom-domtokenlist-remove
* @see https://dom.spec.whatwg.org/#dom-domtokenlist-remove
*
* @param {...string} items Items to remove.
*/
Expand All @@ -136,7 +136,7 @@ export default class TokenList {
* as add()). If force is false, removes token (same as remove()). Returns
* true if `token` is now present, and false otherwise.
*
* @link https://dom.spec.whatwg.org/#dom-domtokenlist-toggle
* @see https://dom.spec.whatwg.org/#dom-domtokenlist-toggle
*
* @param {string} token Token to toggle.
* @param {?boolean} force Presence to force.
Expand All @@ -161,7 +161,7 @@ export default class TokenList {
* Replaces `token` with `newToken`. Returns true if `token` was replaced
* with `newToken`, and false otherwise.
*
* @link https://dom.spec.whatwg.org/#dom-domtokenlist-replace
* @see https://dom.spec.whatwg.org/#dom-domtokenlist-replace
*
* @param {string} token Token to replace with `newToken`.
* @param {string} newToken Token to use in place of `token`.
Expand All @@ -185,7 +185,7 @@ export default class TokenList {
*
* Always returns `true` in this implementation.
*
* @link https://dom.spec.whatwg.org/#dom-domtokenlist-supports
* @see https://dom.spec.whatwg.org/#dom-domtokenlist-supports
*
* @return {boolean} Whether token is supported.
*/
Expand Down

0 comments on commit 5bbda36

Please sign in to comment.