From ac6c4da3a7275c69d12330cf92badd7ec002394e Mon Sep 17 00:00:00 2001 From: Timo Tijhof Date: Thu, 1 Aug 2013 00:53:29 +0200 Subject: [PATCH] doc: @return -> @returns Follows-up 8f05cdbf70. Change-Id: Id2b68e521ab68862f0f635925708a35d10795342 --- .../ve-mw/dm/annotations/ve.dm.MWExternalLinkAnnotation.js | 2 +- .../ve-mw/dm/annotations/ve.dm.MWInternalLinkAnnotation.js | 2 +- modules/ve-mw/dm/nodes/ve.dm.MWBlockImageNode.js | 2 +- modules/ve-mw/init/targets/ve.init.mw.ViewPageTarget.init.js | 2 +- modules/ve-mw/ui/dialogs/ve.ui.MWTransclusionDialog.js | 2 +- modules/ve/ce/ve.ce.DomRange.js | 2 +- modules/ve/dm/annotations/ve.dm.LinkAnnotation.js | 2 +- modules/ve/dm/annotations/ve.dm.TextStyleAnnotation.js | 2 +- modules/ve/ui/ve.ui.Tool.js | 2 +- modules/ve/ve.js | 4 ++-- 10 files changed, 11 insertions(+), 11 deletions(-) diff --git a/modules/ve-mw/dm/annotations/ve.dm.MWExternalLinkAnnotation.js b/modules/ve-mw/dm/annotations/ve.dm.MWExternalLinkAnnotation.js index b2212778d5..2bcd7cc144 100644 --- a/modules/ve-mw/dm/annotations/ve.dm.MWExternalLinkAnnotation.js +++ b/modules/ve-mw/dm/annotations/ve.dm.MWExternalLinkAnnotation.js @@ -53,7 +53,7 @@ ve.dm.MWExternalLinkAnnotation.static.toDomElements = function ( dataElement ) { /* Methods */ /** - * @return {Object} + * @returns {Object} */ ve.dm.MWExternalLinkAnnotation.prototype.getComparableObject = function () { return { diff --git a/modules/ve-mw/dm/annotations/ve.dm.MWInternalLinkAnnotation.js b/modules/ve-mw/dm/annotations/ve.dm.MWInternalLinkAnnotation.js index 023528579c..54eb8df411 100644 --- a/modules/ve-mw/dm/annotations/ve.dm.MWInternalLinkAnnotation.js +++ b/modules/ve-mw/dm/annotations/ve.dm.MWInternalLinkAnnotation.js @@ -88,7 +88,7 @@ ve.dm.MWInternalLinkAnnotation.static.normalizeTitle = function ( title ) { /* Methods */ /** - * @return {Object} + * @returns {Object} */ ve.dm.MWInternalLinkAnnotation.prototype.getComparableObject = function () { return { diff --git a/modules/ve-mw/dm/nodes/ve.dm.MWBlockImageNode.js b/modules/ve-mw/dm/nodes/ve.dm.MWBlockImageNode.js index 3bd67f5cde..784efdfcbb 100644 --- a/modules/ve-mw/dm/nodes/ve.dm.MWBlockImageNode.js +++ b/modules/ve-mw/dm/nodes/ve.dm.MWBlockImageNode.js @@ -206,7 +206,7 @@ ve.dm.MWBlockImageNode.static.toDomElements = function ( data, doc, converter ) * Get the caption node of the image. * * @method - * @return {ve.dm.MWImageCaptionNode|null} Caption node, if present + * @returns {ve.dm.MWImageCaptionNode|null} Caption node, if present */ ve.dm.MWBlockImageNode.prototype.getCaptionNode = function() { var node = this.children[0]; diff --git a/modules/ve-mw/init/targets/ve.init.mw.ViewPageTarget.init.js b/modules/ve-mw/init/targets/ve.init.mw.ViewPageTarget.init.js index 3114cba447..66e994eb03 100644 --- a/modules/ve-mw/init/targets/ve.init.mw.ViewPageTarget.init.js +++ b/modules/ve-mw/init/targets/ve.init.mw.ViewPageTarget.init.js @@ -25,7 +25,7 @@ /** * Use deferreds to avoid loading and instantiating Target multiple times. - * @return {jQuery.Promise} + * @returns {jQuery.Promise} */ function getTarget() { var loadTargetDeferred; diff --git a/modules/ve-mw/ui/dialogs/ve.ui.MWTransclusionDialog.js b/modules/ve-mw/ui/dialogs/ve.ui.MWTransclusionDialog.js index ab20746768..1b4a4c018b 100644 --- a/modules/ve-mw/ui/dialogs/ve.ui.MWTransclusionDialog.js +++ b/modules/ve-mw/ui/dialogs/ve.ui.MWTransclusionDialog.js @@ -295,7 +295,7 @@ ve.ui.MWTransclusionDialog.prototype.onOutlineControlsAdd = function ( type ) { * Get an index for part insertion. * * @method - * @return {number} Index to insert new parts at + * @returns {number} Index to insert new parts at */ ve.ui.MWTransclusionDialog.prototype.getPartInsertionIndex = function () { var parts = this.transclusion.getParts(), diff --git a/modules/ve/ce/ve.ce.DomRange.js b/modules/ve/ce/ve.ce.DomRange.js index 999dfaf21a..ac7b01109a 100644 --- a/modules/ve/ce/ve.ce.DomRange.js +++ b/modules/ve/ce/ve.ce.DomRange.js @@ -42,7 +42,7 @@ ve.ce.DomRange.prototype.equals = function ( other ) { }; /** - * @return {ve.Range} + * @returns {ve.Range} */ ve.ce.DomRange.prototype.getRange = function () { return new ve.Range( diff --git a/modules/ve/dm/annotations/ve.dm.LinkAnnotation.js b/modules/ve/dm/annotations/ve.dm.LinkAnnotation.js index 3462f1ae53..9d3e493341 100644 --- a/modules/ve/dm/annotations/ve.dm.LinkAnnotation.js +++ b/modules/ve/dm/annotations/ve.dm.LinkAnnotation.js @@ -50,7 +50,7 @@ ve.dm.LinkAnnotation.static.toDomElements = function ( dataElement, doc ) { /* Methods */ /** - * @return {Object} + * @returns {Object} */ ve.dm.LinkAnnotation.prototype.getComparableObject = function () { return { diff --git a/modules/ve/dm/annotations/ve.dm.TextStyleAnnotation.js b/modules/ve/dm/annotations/ve.dm.TextStyleAnnotation.js index 2ac11d7365..7fed9604c5 100644 --- a/modules/ve/dm/annotations/ve.dm.TextStyleAnnotation.js +++ b/modules/ve/dm/annotations/ve.dm.TextStyleAnnotation.js @@ -70,7 +70,7 @@ ve.dm.TextStyleAnnotation.static.toDomElements = function ( dataElement, doc ) { /* Methods */ /** - * @return {Object} + * @returns {Object} */ ve.dm.TextStyleAnnotation.prototype.getComparableObject = function () { return { diff --git a/modules/ve/ui/ve.ui.Tool.js b/modules/ve/ui/ve.ui.Tool.js index b961bd28a0..215e843e2e 100644 --- a/modules/ve/ui/ve.ui.Tool.js +++ b/modules/ve/ui/ve.ui.Tool.js @@ -74,7 +74,7 @@ ve.ui.Tool.static.titleMessage = null; * @static * @inheritable * @param {ve.dm.Model} model Model to check - * @return {boolean} Tool can be used to edit model + * @returns {boolean} Tool can be used to edit model */ ve.ui.Tool.static.canEditModel = function () { return false; diff --git a/modules/ve/ve.js b/modules/ve/ve.js index 4faaa7baca..12ac44aa00 100644 --- a/modules/ve/ve.js +++ b/modules/ve/ve.js @@ -45,7 +45,7 @@ * @method * @param {Object} subject Object to check * @param {Function[]} classes Classes to compare with - * @return {boolean} Object inherits from one or more of the classes + * @returns {boolean} Object inherits from one or more of the classes */ ve.isInstanceOfAny = function ( subject, classes ) { var i = classes.length; @@ -121,7 +121,7 @@ * * @param {HTMLElement[]} domElements DOM elements to copy * @param {HTMLDocument} [doc] Document to create the copies in; if unset, simply clone each element - * @return {HTMLElement[]} Copy of domElements with copies of each element + * @returns {HTMLElement[]} Copy of domElements with copies of each element */ ve.copyDomElements = function ( domElements, doc ) { return domElements.map( function ( domElement ) {