wikimedia/mediawiki-extensions-VisualEditor
1
0
Fork 0
mirror of https://gerrit.wikimedia.org/r/mediawiki/extensions/VisualEditor synced 2024-09-25 11:16:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

Remove redundant @method annotations

Browse source 
A @method annotation is only necessary when the docblock is not
directly followed by a function declaration (in which case JSDuck
assumes it documents a property), e.g. when defining an abstract
function or referencing a function from another library.

I verified that JSDuck generates exactly the same output before and
after this change (docs/data-<hash>.js files are identical).

Change-Id: I7edf51a8560ab9978b42800ab1026f0b5555c3bf
This commit is contained in:
Bartosz Dziewoński 2019-08-21 23:13:50 +02:00
parent 5b5e573383
commit 84d548e7b1
39 changed files with 0 additions and 139 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
modules/ve-mw/ce/nodes/ve.ce.MWBlockImageNode.js
View file

@ -208,8 +208,6 @@ ve.ce.MWBlockImageNode.prototype.getCssClass = function ( type, alignment ) {
/**
* Override the default onSetup to add direction-dependent
* classes to the image thumbnail.
*
* @method
*/
ve.ce.MWBlockImageNode.prototype.onSetup = function () {
// Parent method

2
modules/ve-mw/ce/nodes/ve.ce.MWEntityNode.js
View file

@ -42,8 +42,6 @@ ve.ce.MWEntityNode.static.name = 'mwEntity';
/**
* Handle model update events.
*
* @method
*/
ve.ce.MWEntityNode.prototype.onUpdate = function () {
var

2
modules/ve-mw/ce/nodes/ve.ce.MWGalleryNode.js
View file

@ -58,8 +58,6 @@ ve.ce.MWGalleryNode.static.primaryCommandName = 'gallery';
/**
* Handle model update events.
*
* @method
*/
ve.ce.MWGalleryNode.prototype.onUpdate = function () {
var mwAttrs, defaults, mode, imageWidth, imagePadding;

1
modules/ve-mw/ce/nodes/ve.ce.MWImageNode.js
View file

@ -73,7 +73,6 @@ ve.ce.MWImageNode.static.getDescription = function ( model ) {
* Update the rendering of the 'align', src', 'width' and 'height' attributes
* when they change in the model.
*
* @method
* @param {string} key Attribute key
* @param {string} from Old value
* @param {string} to New value

1
modules/ve-mw/ce/nodes/ve.ce.MWInlineImageNode.js
View file

@ -75,7 +75,6 @@ ve.ce.MWInlineImageNode.static.name = 'mwInlineImage';
/**
* Update CSS classes based on current attributes
*
*/
ve.ce.MWInlineImageNode.prototype.updateClasses = function () {
var valign = this.model.getAttribute( 'valign' );

3
modules/ve-mw/ce/nodes/ve.ce.MWLanguageVariantNode.js
View file

@ -79,8 +79,6 @@ ve.ce.MWLanguageVariantNode.static.getDescription = function ( model ) {
/**
* Handle model update events.
*
* @method
*/
ve.ce.MWLanguageVariantNode.prototype.onUpdate = function () {
if ( !this.model.isHidden() ) {
@ -120,7 +118,6 @@ ve.ce.MWLanguageVariantNode.prototype.getInvisibleIconLabel = function () {
/**
* Create a {jQuery} appropriate for holding the output of this
* conversion rule.
* @method
* @return {jQuery}
*/
ve.ce.MWLanguageVariantNode.prototype.appendHolder = function () {

2
modules/ve-mw/ce/nodes/ve.ce.MWMagicLinkNode.js
View file

@ -62,8 +62,6 @@ ve.ce.MWMagicLinkNode.static.getDescription = function ( model ) {
/**
* Handle model update events.
*
* @method
*/
ve.ce.MWMagicLinkNode.prototype.onUpdate = function () {
this.$link

2
modules/ve-mw/ce/nodes/ve.ce.MWNumberedExternalLinkNode.js
View file

@ -80,8 +80,6 @@ ve.ce.MWNumberedExternalLinkNode.static.getDescription = function ( model ) {
/**
* Handle model update events.
*
* @method
*/
ve.ce.MWNumberedExternalLinkNode.prototype.onUpdate = function () {
this.$link.attr( 'href', this.model.getAttribute( 'href' ) );

3
modules/ve-mw/dm/models/ve.dm.MWParameterModel.js
View file

@ -43,7 +43,6 @@ OO.mixinClass( ve.dm.MWParameterModel, OO.EventEmitter );
/**
* Check if parameter is required.
*
* @method
* @return {boolean} Parameter is required
*/
ve.dm.MWParameterModel.prototype.isRequired = function () {
@ -53,7 +52,6 @@ ve.dm.MWParameterModel.prototype.isRequired = function () {
/**
* Check if parameter is suggested.
*
* @method
* @param {string} name Parameter name
* @return {boolean} Parameter is suggested
*/
@ -64,7 +62,6 @@ ve.dm.MWParameterModel.prototype.isSuggested = function () {
/**
* Check if parameter is deprecated.
*
* @method
* @return {boolean} Parameter is deprecated
*/
ve.dm.MWParameterModel.prototype.isDeprecated = function () {

1
modules/ve-mw/dm/models/ve.dm.MWTemplateSpecModel.js
View file

@ -157,7 +157,6 @@ ve.dm.MWTemplateSpecModel.prototype.getDescription = function ( lang ) {
/**
* Get parameter order.
*
* @method
* @return {string[]} Canonically ordered parameter names
*/
ve.dm.MWTemplateSpecModel.prototype.getParameterOrder = function () {

1
modules/ve-mw/dm/models/ve.dm.MWTransclusionPartModel.js
View file

@ -81,7 +81,6 @@ ve.dm.MWTransclusionPartModel.prototype.getWikitext = function () {
/**
* Add all non-existing required and suggested parameters, if any.
*
* @method
* @return {number} Number of parameters added
*/
ve.dm.MWTransclusionPartModel.prototype.addPromptedParameters = function () {

1
modules/ve-mw/dm/nodes/ve.dm.MWBlockImageNode.js
View file

@ -219,7 +219,6 @@ 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
*/
ve.dm.MWBlockImageNode.prototype.getCaptionNode = function () {

1
modules/ve-mw/dm/nodes/ve.dm.MWExtensionNode.js
View file

@ -197,7 +197,6 @@ ve.dm.MWExtensionNode.static.describeChange = function ( key ) {
/**
* Get the extension's name
*
* @method
* @return {string} Extension name
*/
ve.dm.MWExtensionNode.prototype.getExtensionName = function () {

1
modules/ve-mw/dm/nodes/ve.dm.MWGalleryImageNode.js
View file

@ -138,7 +138,6 @@ ve.dm.MWGalleryImageNode.static.describeChange = function ( key ) {
/**
* Get the image's caption node.
*
* @method
* @return {ve.dm.MWImageCaptionNode|null} Caption node, if present
*/
ve.dm.MWGalleryImageNode.prototype.getCaptionNode = function () {

2
modules/ve-mw/dm/nodes/ve.dm.MWGalleryNode.js
View file

@ -106,7 +106,6 @@ ve.dm.MWGalleryNode.static.describeChange = function ( key ) {
/**
* Get the gallery's caption node.
*
* @method
* @return {ve.dm.MWImageCaptionNode|null} Caption node, if present
*/
ve.dm.MWGalleryNode.prototype.getCaptionNode = function () {
@ -117,7 +116,6 @@ ve.dm.MWGalleryNode.prototype.getCaptionNode = function () {
/**
* Get the gallery's image nodes.
*
* @method
* @return {ve.dm.MWGalleryImageNode[]} Gallery image nodes (may be empty if none are present)
*/
ve.dm.MWGalleryNode.prototype.getImageNodes = function () {

1
modules/ve-mw/dm/nodes/ve.dm.MWImageNode.js
View file

@ -325,7 +325,6 @@ ve.dm.MWImageNode.static.getScalablePromise = function ( filename ) {
* Update the rendering of the 'align', src', 'width' and 'height' attributes
* when they change in the model.
*
* @method
* @param {string} key Attribute key
* @param {string} from Old value
* @param {string} to New value

9
modules/ve-mw/dm/nodes/ve.dm.MWLanguageVariantNode.js
View file

@ -76,7 +76,6 @@ ve.dm.MWLanguageVariantNode.static.hiddenType = 'mwLanguageVariantHidden';
* Migrate field names from old Parsoid spec to new field names.
* This method will go away after the next Parsoid flag day.
* @static
* @method
* @private
* @param {Object} dataMwv
* @return {Object}
@ -161,7 +160,6 @@ ve.dm.MWLanguageVariantNode.static.toDomElements = function ( dataElement, doc,
* renderings.
*
* @static
* @method
* @param {jQuery} $element Element to process
* @param {Object|null} opts Preview options
* @param {boolean} [opts.describeAll=false] Treat all rules as if the
@ -189,7 +187,6 @@ ve.dm.MWLanguageVariantNode.static.processVariants = function ( $element, opts )
* Insert language variant preview for specified element.
*
* @static
* @method
* @param {HTMLElement} element Element to insert preview inside of.
* @param {Object} variantInfo Language variant information object.
* @param {Object|null} opts Preview options
@ -213,7 +210,6 @@ ve.dm.MWLanguageVariantNode.static.insertPreviewElements = function ( element, v
* object and the user's currently preferred variant.
*
* @static
* @method
* @private
* @param {Object} variantInfo Language variant information object.
* @param {Object|null} opts Preview options
@ -290,7 +286,6 @@ ve.dm.MWLanguageVariantNode.static.cloneElement = function () {
* among a provided list of language codes.
*
* @static
* @method
* @param {Object[]} [items] An array of objects, each of which have a field
* named `l` equal to a language code.
* @return {number} The index in `items` with the most appropriate language
@ -324,7 +319,6 @@ ve.dm.MWLanguageVariantNode.static.matchLanguage = function ( items ) {
/**
* Helper function to get the description object for this markup node.
*
* @method
* @return {Object}
*/
ve.dm.MWLanguageVariantNode.prototype.getVariantInfo = function () {
@ -334,7 +328,6 @@ ve.dm.MWLanguageVariantNode.prototype.getVariantInfo = function () {
/**
* Helper function to discriminate between hidden and shown rules.
*
* @method
* @return {boolean} True if this node represents a conversion rule
* with no shown output
*/
@ -346,7 +339,6 @@ ve.dm.MWLanguageVariantNode.prototype.isHidden = function () {
* Helper function to discriminate between various types of language
* converter markup.
*
* @method
* @return {string}
*/
ve.dm.MWLanguageVariantNode.prototype.getRuleType = function () {
@ -358,7 +350,6 @@ ve.dm.MWLanguageVariantNode.prototype.getRuleType = function () {
* converter markup.
*
* @static
* @method
* @param {Object} variantInfo Language variant information object.
* @return {string}
*/

2
modules/ve-mw/dm/nodes/ve.dm.MWTransclusionNode.js
View file

@ -405,7 +405,6 @@ ve.dm.MWTransclusionNode.static.getWikitext = function ( content ) {
/**
* Handle attribute change events.
*
* @method
* @param {string} key Attribute key
* @param {string} from Old value
* @param {string} to New value
@ -484,7 +483,6 @@ ve.dm.MWTransclusionNode.prototype.getPartsList = function () {
/**
* Wrapper for static method
*
* @method
* @return {string} Wikitext like `{{foo|1=bar|baz=quux}}`
*/
ve.dm.MWTransclusionNode.prototype.getWikitext = function () {

11
modules/ve-mw/init/targets/ve.init.mw.DesktopArticleTarget.js
View file

@ -920,7 +920,6 @@ ve.init.mw.DesktopArticleTarget.prototype.onDocumentKeyDown = function ( e ) {
/**
* Handle clicks on the view tab.
*
* @method
* @param {jQuery.Event} e Mouse click event
*/
ve.init.mw.DesktopArticleTarget.prototype.onViewTabClick = function ( e ) {
@ -1046,7 +1045,6 @@ ve.init.mw.DesktopArticleTarget.prototype.serializeFail = function ( jqXHR, stat
/**
* Handle clicks on the MwMeta button in the toolbar.
*
* @method
* @param {jQuery.Event} e Mouse click event
*/
ve.init.mw.DesktopArticleTarget.prototype.onToolbarMetaButtonClick = function () {
@ -1058,8 +1056,6 @@ ve.init.mw.DesktopArticleTarget.prototype.onToolbarMetaButtonClick = function ()
*
* 'Read' and 'Edit source' (when not using single edit tab) bound here,
* 'Edit' and single edit tab are bound in mw.DesktopArticleTarget.init.
*
* @method
*/
ve.init.mw.DesktopArticleTarget.prototype.setupSkinTabs = function () {
var namespaceNumber, namespaceName, isTalkNamespace, namespaceKey, namespaceTabId;
@ -1370,7 +1366,6 @@ ve.init.mw.DesktopArticleTarget.prototype.onWindowPopState = function ( e ) {
/**
* Replace the page content with new HTML.
*
* @method
* @param {string} html Rendered HTML from server
* @param {string} categoriesHtml Rendered categories HTML from server
* @param {string} displayTitle HTML to show as the page title
@ -1421,8 +1416,6 @@ ve.init.mw.DesktopArticleTarget.prototype.replacePageContent = function (
/**
* Add onunload and onbeforeunload handlers.
*
* @method
*/
ve.init.mw.DesktopArticleTarget.prototype.setupUnloadHandlers = function () {
if ( window.onbeforeunload !== this.onBeforeUnload ) {
@ -1435,8 +1428,6 @@ ve.init.mw.DesktopArticleTarget.prototype.setupUnloadHandlers = function () {
};
/**
* Remove onunload and onbeforunload handlers.
*
* @method
*/
ve.init.mw.DesktopArticleTarget.prototype.teardownUnloadHandlers = function () {
// Restore whatever previous onbeforeunload hook existed
@ -1510,8 +1501,6 @@ ve.init.mw.DesktopArticleTarget.prototype.onBeforeUnload = function () {
/**
* Handle unload event.
*
* @method
*/
ve.init.mw.DesktopArticleTarget.prototype.onUnload = function () {
if ( !this.submitting ) {

4
modules/ve-mw/init/ve.init.MWEditModeTool.js
View file

@ -44,8 +44,6 @@ mw.libs.ve.MWEditModeTool.static.unavailableTooltip = null;
/**
* Switch editors
*
* @method
*/
mw.libs.ve.MWEditModeTool.prototype.switch = function () {
this.toolbar.emit( 'switchEditor', this.constructor.static.editMode );
@ -54,7 +52,6 @@ mw.libs.ve.MWEditModeTool.prototype.switch = function () {
/**
* Get current edit mode
*
* @method
* @return {string} Current edit mode
*/
mw.libs.ve.MWEditModeTool.prototype.getMode = function () {
@ -64,7 +61,6 @@ mw.libs.ve.MWEditModeTool.prototype.getMode = function () {
/**
* Check if edit mode is available
*
* @method
* @param {string} Edit mode
* @return {boolean} Edit mode is available
*/

2
modules/ve-mw/init/ve.init.mw.ApiResponseCache.js
View file

@ -46,7 +46,6 @@ OO.mixinClass( ve.init.mw.ApiResponseCache, OO.EventEmitter );
*
* @abstract
* @static
* @method
* @param {Object} page The page object
* @return {Object|undefined} Any relevant info that we want to cache and return.
*/
@ -136,7 +135,6 @@ ve.init.mw.ApiResponseCache.prototype.set = function ( entries ) {
* Get an API request promise to deal with a list of titles
*
* @abstract
* @method
* @param subqueue
* @return {jQuery.Promise}
*/

28
modules/ve-mw/init/ve.init.mw.ArticleTarget.js
View file

@ -349,7 +349,6 @@ ve.init.mw.ArticleTarget.prototype.updateTabs = function ( editing ) {
* This method is called within the context of a target instance. If successful the DOM from the
* server will be parsed, stored in {this.doc} and then {this.documentReady} will be called.
*
* @method
* @param {Object} response API response data
* @param {string} status Text status message
*/
@ -624,7 +623,6 @@ ve.init.mw.ArticleTarget.prototype.restoreAccessKeys = function () {
*
* This method is called within the context of a target instance.
*
* @method
* @param {string} code Error type text from mw.Api
* @param {Object|string} errorDetails Either an object containing xhr, textStatus and exception keys, or a string.
* @fires loadError
@ -639,7 +637,6 @@ ve.init.mw.ArticleTarget.prototype.loadFail = function () {
*
* This method is called within the context of a target instance.
*
* @method
* @param {HTMLDocument} doc HTML document we tried to save
* @param {Object} saveData Options that were used
* @param {Object} response Response data
@ -673,7 +670,6 @@ ve.init.mw.ArticleTarget.prototype.saveSuccess = function ( doc, saveData, respo
/**
* Handle successful DOM save event.
*
* @method
* @param {string} html Rendered page HTML from server
* @param {string} categoriesHtml Rendered categories HTML from server
* @param {number} newid New revision id, undefined if unchanged
@ -697,7 +693,6 @@ ve.init.mw.ArticleTarget.prototype.saveComplete = function () {
/**
* Handle an unsuccessful save request.
*
* @method
* @param {HTMLDocument} doc HTML document we tried to save
* @param {Object} saveData Options that were used
* @param {boolean} wasRetry Whether this was a retry after a 'badtoken' error
@ -769,7 +764,6 @@ ve.init.mw.ArticleTarget.prototype.saveFail = function ( doc, saveData, wasRetry
/**
* Show an save process error message
*
* @method
* @param {string|jQuery|Node[]} msg Message content (string of HTML, jQuery object or array of
* Node objects)
* @param {boolean} [allowReapply=true] Whether or not to allow the user to reapply.
@ -783,7 +777,6 @@ ve.init.mw.ArticleTarget.prototype.showSaveError = function ( msg, allowReapply,
/**
* Handle general save error
*
* @method
* @fires saveErrorEmpty
*/
ve.init.mw.ArticleTarget.prototype.saveErrorEmpty = function () {
@ -794,7 +787,6 @@ ve.init.mw.ArticleTarget.prototype.saveErrorEmpty = function () {
/**
* Handle hook abort save error
*
* @method
* @fires saveErrorHookAborted
*/
ve.init.mw.ArticleTarget.prototype.saveErrorHookAborted = function () {
@ -805,7 +797,6 @@ ve.init.mw.ArticleTarget.prototype.saveErrorHookAborted = function () {
/**
* Handle token fetch indicating another user is logged in, and token fetch errors.
*
* @method
* @param {string|null} username Name of newly logged-in user, or null if anonymous
* @param {boolean} [error=false] Whether there was an error trying to figure out who we're logged in as
* @fires saveErrorBadToken
@ -833,7 +824,6 @@ ve.init.mw.ArticleTarget.prototype.saveErrorBadToken = function ( username, erro
/**
* Handle unknown save error
*
* @method
* @param {Object} editApi
* @param {Object|null} data API response data
* @fires saveErrorUnknown
@ -857,7 +847,6 @@ ve.init.mw.ArticleTarget.prototype.saveErrorUnknown = function ( editApi, data )
/**
* Handle page deleted error
*
* @method
* @fires saveErrorPageDeleted
*/
ve.init.mw.ArticleTarget.prototype.saveErrorPageDeleted = function () {
@ -869,7 +858,6 @@ ve.init.mw.ArticleTarget.prototype.saveErrorPageDeleted = function () {
/**
* Handle read only error
*
* @method
* @fires saveErrorReadOnly
*/
ve.init.mw.ArticleTarget.prototype.saveErrorReadOnly = function () {
@ -880,7 +868,6 @@ ve.init.mw.ArticleTarget.prototype.saveErrorReadOnly = function () {
/**
* Handle an edit conflict
*
* @method
* @fires editConflict
*/
ve.init.mw.ArticleTarget.prototype.editConflict = function () {
@ -895,7 +882,6 @@ ve.init.mw.ArticleTarget.prototype.editConflict = function () {
* This method is called within the context of a target instance.
*
* @static
* @method
* @param {Object} response API response data
* @param {string} status Text status message
* @fires serializeComplete
@ -929,7 +915,6 @@ ve.init.mw.ArticleTarget.prototype.serializeSuccess = function ( response ) {
*
* This method is called within the context of a target instance.
*
* @method
* @param {jqXHR|null} jqXHR
* @param {string} status Text status message
* @param {Mixed|null} error HTTP status text
@ -943,7 +928,6 @@ ve.init.mw.ArticleTarget.prototype.serializeFail = function () {
/**
* Handle clicks on the review button in the save dialog.
*
* @method
* @fires saveReview
*/
ve.init.mw.ArticleTarget.prototype.onSaveDialogReview = function () {
@ -964,7 +948,6 @@ ve.init.mw.ArticleTarget.prototype.onSaveDialogReview = function () {
/**
* Handle clicks on the show preview button in the save dialog.
*
* @method
* @fires savePreview
*/
ve.init.mw.ArticleTarget.prototype.onSaveDialogPreview = function () {
@ -1024,7 +1007,6 @@ ve.init.mw.ArticleTarget.prototype.bindSaveDialogClearDiff = function () {
/**
* Handle completed serialize request for diff views for new page creations.
*
* @method
* @param {string} wikitext
*/
ve.init.mw.ArticleTarget.prototype.onSaveDialogReviewComplete = function ( wikitext ) {
@ -1096,8 +1078,6 @@ ve.init.mw.ArticleTarget.prototype.getVisualDiffGeneratorPromise = function () {
/**
* Handle clicks on the resolve conflict button in the conflict dialog.
*
* @method
*/
ve.init.mw.ArticleTarget.prototype.onSaveDialogResolveConflict = function () {
var fields = { wpSave: 1 };
@ -1600,7 +1580,6 @@ ve.init.mw.ArticleTarget.prototype.getSaveOptions = function () {
*
* target.save( dom, { summary: 'test', minor: true, watch: false } );
*
* @method
* @param {HTMLDocument} doc Document to save
* @param {Object} options Saving options. All keys are passed through, including unrecognized ones.
* - {string} summary Edit summary
@ -1666,7 +1645,6 @@ ve.init.mw.ArticleTarget.prototype.clearDiff = function () {
/**
* Post DOM data to the Parsoid API to retrieve wikitext diff.
*
* @method
* @param {HTMLDocument} doc Document to compare against (via wikitext)
* @return {jQuery.Promise} Promise which resolves with the wikitext diff, or rejects with an error
* @fires showChanges
@ -1712,7 +1690,6 @@ ve.init.mw.ArticleTarget.prototype.getWikitextDiffPromise = function ( doc ) {
*
* target.submit( wikitext, { wpSummary: 'test', wpMinorEdit: 1, wpSave: 1 } );
*
* @method
* @param {string} wikitext Wikitext to submit
* @param {Object} fields Other form fields to add (e.g. wpSummary, wpWatchthis, etc.). To actually
* save the wikitext, add { wpSave: 1 }. To go to the diff view, add { wpDiff: 1 }.
@ -1763,7 +1740,6 @@ ve.init.mw.ArticleTarget.prototype.submit = function ( wikitext, fields ) {
* }
* );
*
* @method
* @param {HTMLDocument} doc Document to serialize
* @param {Function} callback Function to call when complete, accepts error and wikitext arguments
* @return {boolean} Serializing has been started
@ -2058,8 +2034,6 @@ ve.init.mw.ArticleTarget.prototype.getSaveDialogOpeningData = function () {
/**
* Move the cursor in the editor to section specified by this.section.
* Do nothing if this.section is undefined.
*
* @method
*/
ve.init.mw.ArticleTarget.prototype.restoreEditSection = function () {
var dmDoc, headingModel, headingView, headingText,
@ -2123,7 +2097,6 @@ ve.init.mw.ArticleTarget.prototype.restoreEditSection = function () {
/**
* Move the cursor to a given heading and scroll to it.
*
* @method
* @param {ve.ce.HeadingNode} headingNode Heading node to scroll to
*/
ve.init.mw.ArticleTarget.prototype.goToHeading = function ( headingNode ) {
@ -2169,7 +2142,6 @@ ve.init.mw.ArticleTarget.prototype.goToHeading = function ( headingNode ) {
/**
* Scroll to a given heading in the document.
*
* @method
* @param {ve.ce.HeadingNode} headingNode Heading node to scroll to
*/
ve.init.mw.ArticleTarget.prototype.scrollToHeading = function ( headingNode ) {

1
modules/ve-mw/init/ve.init.mw.ArticleTargetEvents.js
View file

@ -130,7 +130,6 @@ ve.init.mw.ArticleTargetEvents.prototype.onSaveComplete = function ( content, ca
/**
* Track a save error by type
*
* @method
* @param {string} type Text for error type
*/
ve.init.mw.ArticleTargetEvents.prototype.trackSaveError = function ( type ) {

2
modules/ve-mw/init/ve.init.mw.Platform.js
View file

@ -91,7 +91,6 @@ ve.init.mw.Platform.prototype.getConfig = mw.config.get.bind( mw.config );
/**
* All values are JSON-parsed. To get raw values, use mw.user.options.get directly.
*
* @method
* @inheritdoc
*/
ve.init.mw.Platform.prototype.getUserConfig = function ( keys ) {
@ -118,7 +117,6 @@ ve.init.mw.Platform.prototype.getUserConfig = function ( keys ) {
*
* All values are JSON encoded. To set raw values, use mw.user.options.set directly.
*
* @method
* @inheritdoc
*/
ve.init.mw.Platform.prototype.setUserConfig = function ( keyOrValueMap, value ) {

2
modules/ve-mw/init/ve.init.mw.SaveErrorHandler.js
View file

@ -25,7 +25,6 @@ OO.initClass( ve.init.mw.SaveErrorHandler );
*
* @static
* @inheritable
* @method
* @param {Object} data API response from action=visualeditoredit
* @return {boolean}
*/
@ -36,7 +35,6 @@ ve.init.mw.SaveErrorHandler.static.matchFunction = null;
*
* @static
* @inheritable
* @method
* @param {Object} data API response from action=visualeditoredit
* @param {ve.init.mw.ArticleTarget} target Target
*/

2
modules/ve-mw/init/ve.init.mw.Target.js
View file

@ -231,7 +231,6 @@ ve.init.mw.Target.prototype.documentReady = function ( doc ) {
/**
* Once surface is ready, initialize the UI
*
* @method
* @fires surfaceReady
*/
ve.init.mw.Target.prototype.surfaceReady = function () {
@ -355,7 +354,6 @@ ve.init.mw.Target.prototype.getSurfaceConfig = function ( config ) {
/**
* Switch to editing mode.
*
* @method
* @param {HTMLDocument|string} doc HTML document or source text
*/
ve.init.mw.Target.prototype.setupSurface = function ( doc ) {

1
modules/ve-mw/tests/ve.test.utils.js
View file

@ -125,7 +125,6 @@
* Override getDomElementSummary to extract HTML from data-mw/body.html
* and make it comparable.
*
* @method
* @inheritdoc ve#getDomElementSummary
*/
ve.getDomElementSummary = function ( element, includeHtml ) {

4
modules/ve-mw/ui/actions/ve.ui.MWLinkAction.js
View file

@ -74,7 +74,6 @@ ve.ui.MWLinkAction.static.getLinkAnnotation = function ( linktext, doc ) {
* candidate text, so that URLs with embedded matched parentheses (like
* wiki articles with disambiguation text) autolink nicely.
*
* @method
* @inheritdoc
*/
ve.ui.MWLinkAction.prototype.getTrailingPunctuation = function ( candidate ) {
@ -94,7 +93,6 @@ ve.ui.MWLinkAction.prototype.getTrailingPunctuation = function ( candidate ) {
};
/**
* @method
* @inheritdoc
* @return {ve.dm.MWExternalLinkAnnotation|ve.dm.MWInternalLinkAnnotation} The annotation to use
*/
@ -107,7 +105,6 @@ ve.ui.MWLinkAction.prototype.getLinkAnnotation = function ( linktext ) {
* followed by whitespace.
*
* @see ve.ui.LinkAction#autolinkUrl
* @method
* @return {boolean}
* True if the selection is a valid RFC/PMID/ISBN and the autolink action
* was executed; otherwise false.
@ -141,7 +138,6 @@ ve.ui.MWLinkAction.prototype.autolinkMagicLink = function () {
/**
* Open either the 'link' or 'linkNode' window, depending on what is selected.
*
* @method
* @return {boolean} Action was executed
*/
ve.ui.MWLinkAction.prototype.open = function () {

3
modules/ve-mw/ui/actions/ve.ui.MWSaveDialogAction.js
View file

@ -42,7 +42,6 @@ ve.ui.MWSaveDialogAction.static.methods = [ 'save', 'review', 'preview' ];
/**
* Open the save dialog
*
* @method
* @param {string} checkbox Checkbox to toggle after opening
* @return {boolean} Action was executed
*/
@ -54,7 +53,6 @@ ve.ui.MWSaveDialogAction.prototype.save = function ( checkbox ) {
/**
* Open the save dialog, and set it to the review panel
*
* @method
* @return {boolean} Action was executed
*/
ve.ui.MWSaveDialogAction.prototype.review = function () {
@ -65,7 +63,6 @@ ve.ui.MWSaveDialogAction.prototype.review = function () {
/**
* Open the save dialog, and set it to the preview panel
*
* @method
* @return {boolean} Action was executed
*/
ve.ui.MWSaveDialogAction.prototype.preview = function () {

3
modules/ve-mw/ui/actions/ve.ui.MWWikitextAction.js
View file

@ -39,7 +39,6 @@ ve.ui.MWWikitextAction.static.methods = [ 'toggleWrapSelection', 'wrapSelection'
/**
* Wrap an selection inline
*
* @method
* @param {string} before Text to go before selection
* @param {string} after Text to go after selection
* @param {Function|string} placeholder Placeholder text to insert at an empty selection
@ -84,7 +83,6 @@ ve.ui.MWWikitextAction.prototype.toggleWrapSelection = function ( before, after,
/**
* Wrap an selection inline
*
* @method
* @param {string} before Text to go before selection
* @param {string} after Text to go after selection
* @param {Function|string} placeholder Placeholder text to insert at an empty selection
@ -102,7 +100,6 @@ ve.ui.MWWikitextAction.prototype.wrapSelection = function ( before, after, place
* If the selection is collapsed, it expands to take the whole line, otherwise it splits
* the paragraph to make sure it is one line
*
* @method
* @param {string} before Text to go before each line
* @param {string} after Text to go after each line
* @param {Function|string} placeholder Placeholder text to insert at an empty selection

2
modules/ve-mw/ui/dialogs/ve.ui.MWSaveDialog.js
View file

@ -517,8 +517,6 @@ ve.ui.MWSaveDialog.prototype.clearAllMessages = function () {
/**
* Reset the fields of the save dialog.
*
* @method
*/
ve.ui.MWSaveDialog.prototype.reset = function () {
// Reset summary input

12
modules/ve-mw/ui/inspectors/ve.ui.MWLanguageVariantInspector.js
View file

@ -101,7 +101,6 @@ ve.ui.MWLanguageVariantInspector.static.getImportRules = function () {
* object to use when the equivalent of wikitext `-{}-` is inserted
* in the document.
*
* @method
* @return {Object}
*/
ve.ui.MWLanguageVariantInspector.prototype.getDefaultVariantInfo = null;
@ -110,7 +109,6 @@ ve.ui.MWLanguageVariantInspector.prototype.getDefaultVariantInfo = null;
* Convert the current inspector state to new content which can be used
* to update the ve.dm.SurfaceFragment backing this inspector.
*
* @method
* @param {Object} An existing variantInfo object for this node, which will be
* mutated to update it with the latest content from this inspector.
* @return {string|Array} New content for the ve.dm.SurfaceFragment
@ -124,7 +122,6 @@ ve.ui.MWLanguageVariantInspector.prototype.getContentFromInspector = null;
* Helper function to create a subdocument editor for HTML embedded in the
* language variant node.
*
* @method
* @param {string} [placeholder] Placeholder text for this editor.
* @return {ve.ui.TargetWidget}
*/
@ -143,7 +140,6 @@ ve.ui.MWLanguageVariantInspector.prototype.createTextTarget = function ( placeho
* Helper function to initialize a ve.ui.TargetWidget with a given HTML
* string extracted from the language variant node.
*
* @method
* @param {ve.ui.TargetWidget} [textTarget] A subdocument editor widget
* created by ve.ui.MWLanguageVariantInspector#createTextTarget.
* @param {string} [htmlString] The HTML string extracted from this node.
@ -163,7 +159,6 @@ ve.ui.MWLanguageVariantInspector.prototype.setupTextTargetDoc = function ( textT
* and (TODO) determine if an inline node needs to be converted to a
* block node or vice-versa.
*
* @method
* @param {ve.dm.Document} doc The document backing an editor widget, as returned
* by ve.ui.MWLanguageVariantInspector#setupTextTargetDoc.
* @return {string} An HTML string appropriate for embedding into a
@ -192,8 +187,6 @@ ve.ui.MWLanguageVariantInspector.prototype.getHtmlForDoc = function ( doc ) {
/**
* Handle frame ready events.
*
* @method
*/
ve.ui.MWLanguageVariantInspector.prototype.initialize = function () {
// Parent method
@ -216,7 +209,6 @@ ve.ui.MWLanguageVariantInspector.prototype.getActionProcess = function ( action
/**
* Handle the inspector being setup.
*
* @method
* @param {Object} [data] Inspector opening data
* @return {OO.ui.Process}
*/
@ -600,7 +592,6 @@ ve.ui.MWLanguageVariantTwoWayInspector.prototype.getSetupProcess = function ( da
/**
* Create widgets corresponding to a given mapping given by this rule.
* @method
* @param {string} [lang] The language code for the content text.
* @param {string} [content] The HTML content text.
* @return {Object} An object containing the required widgets and backing
@ -671,7 +662,6 @@ ve.ui.MWLanguageVariantTwoWayInspector.prototype.getContentFromInspector = funct
/**
* Create a new mapping item in the inspector.
* @method
*/
ve.ui.MWLanguageVariantTwoWayInspector.prototype.onAddButtonClick = function () {
var idx = this.items.length;
@ -752,7 +742,6 @@ ve.ui.MWLanguageVariantOneWayInspector.prototype.getSetupProcess = function ( da
/**
* Create widgets corresponding to a given mapping given by this rule.
* @method
* @param {string} [from] The HTML source text.
* @param {string} [lang] The language code for the destination text.
* @param {string} [to] The HTML destination text.
@ -831,7 +820,6 @@ ve.ui.MWLanguageVariantOneWayInspector.prototype.getContentFromInspector = funct
/**
* Create a new mapping item in the inspector.
* @method
*/
ve.ui.MWLanguageVariantOneWayInspector.prototype.onAddButtonClick = function () {
var idx = this.items.length;

1
modules/ve-mw/ui/inspectors/ve.ui.MWLinkAnnotationInspector.js
View file

@ -431,7 +431,6 @@ ve.ui.MWLinkAnnotationInspector.prototype.onLinkTypeIndexSet = function () {
*
* The type of link is automatically detected based on some crude heuristics.
*
* @method
* @param {ve.dm.SurfaceFragment} fragment Current selection
* @return {ve.dm.MWInternalLinkAnnotation|ve.dm.MWExternalLinkAnnotation|null}
*/

2
modules/ve-mw/ui/pages/ve.ui.MWSettingsPage.js
View file

@ -185,8 +185,6 @@ ve.ui.MWSettingsPage.prototype.setOutlineItem = function () {
/**
* Handle Table Of Contents display change events.
*
* @method
*/
ve.ui.MWSettingsPage.prototype.onTableOfContentsFieldChange = function () {
this.tableOfContentsTouched = true;

1
modules/ve-mw/ui/widgets/ve.ui.MWCategoryInputWidget.js
View file

@ -237,7 +237,6 @@ ve.ui.MWCategoryInputWidget.prototype.onLookupMenuItemChoose = function ( item )
/**
* Take a category name and turn it into a menu item widget, following redirects.
*
* @method
* @param {string} name Category name
* @return {OO.ui.MenuOptionWidget} Menu item widget to be shown
*/

1
modules/ve-mw/ui/widgets/ve.ui.MWCategoryItemWidget.js
View file

@ -73,7 +73,6 @@ OO.mixinClass( ve.ui.MWCategoryItemWidget, OO.ui.mixin.DraggableElement );
/**
* Handle button widget click events.
*
* @method
* @fires togglePopupMenu on click.
*/
ve.ui.MWCategoryItemWidget.prototype.onButtonClick = function () {

9
modules/ve-mw/ui/widgets/ve.ui.MWCategoryPopupWidget.js
View file

@ -87,7 +87,6 @@ OO.inheritClass( ve.ui.MWCategoryPopupWidget, OO.ui.PopupWidget );
/**
* Handle category remove events.
*
* @method
* @fires removeCategory
*/
ve.ui.MWCategoryPopupWidget.prototype.onRemoveCategory = function () {
@ -99,7 +98,6 @@ ve.ui.MWCategoryPopupWidget.prototype.onRemoveCategory = function () {
/**
* Handle sort key form submit events.
*
* @method
* @param {jQuery.Event} e Form submit event
* @return {boolean}
* @fires updateSortkey
@ -112,7 +110,6 @@ ve.ui.MWCategoryPopupWidget.prototype.onSortKeySubmit = function () {
/**
* Open a category item popup.
*
* @method
* @param {ve.ui.MWCategoryItemWidget} item Category item
*/
ve.ui.MWCategoryPopupWidget.prototype.openPopup = function ( item ) {
@ -127,7 +124,6 @@ ve.ui.MWCategoryPopupWidget.prototype.openPopup = function ( item ) {
* Handle popup toggle events.
*
* @param {boolean} show Widget is being made visible
* @method
*/
ve.ui.MWCategoryPopupWidget.prototype.onToggle = function ( show ) {
var newSortkey;
@ -147,7 +143,6 @@ ve.ui.MWCategoryPopupWidget.prototype.onToggle = function ( show ) {
/**
* Load item information into the popup.
*
* @method
* @param {ve.ui.MWCategoryItemWidget} item Category item
*/
ve.ui.MWCategoryPopupWidget.prototype.loadCategoryIntoPopup = function ( item ) {
@ -164,8 +159,6 @@ ve.ui.MWCategoryPopupWidget.prototype.loadCategoryIntoPopup = function ( item )
/**
* Close the popup.
*
* @method
*/
ve.ui.MWCategoryPopupWidget.prototype.closePopup = function () {
this.toggle( false );
@ -178,7 +171,6 @@ ve.ui.MWCategoryPopupWidget.prototype.closePopup = function () {
/**
* Set the default sort key.
*
* @method
* @param {string} value Default sort key value
*/
ve.ui.MWCategoryPopupWidget.prototype.setDefaultSortKey = function ( value ) {
@ -188,7 +180,6 @@ ve.ui.MWCategoryPopupWidget.prototype.setDefaultSortKey = function ( value ) {
/**
* Display the popup next to an item.
*
* @method
* @param {ve.ui.MWCategoryItemWidget} item Category item
*/
ve.ui.MWCategoryPopupWidget.prototype.setPopup = function ( item ) {

6
modules/ve-mw/ui/widgets/ve.ui.MWCategoryWidget.js
View file

@ -178,7 +178,6 @@ ve.ui.MWCategoryWidget.prototype.reorder = function ( item, newIndex ) {
/**
* Removes category from model.
*
* @method
* @param {string} name Removed category name
*/
ve.ui.MWCategoryWidget.prototype.onRemoveCategory = function ( name ) {
@ -189,7 +188,6 @@ ve.ui.MWCategoryWidget.prototype.onRemoveCategory = function ( name ) {
/**
* Update sortkey value, emit updateSortkey event
*
* @method
* @param {string} name
* @param {string} value
*/
@ -256,7 +254,6 @@ ve.ui.MWCategoryWidget.prototype.setDisabled = function () {
/**
* Get list of category names.
*
* @method
* @return {string[]} List of category names
*/
ve.ui.MWCategoryWidget.prototype.getCategories = function () {
@ -344,7 +341,6 @@ ve.ui.MWCategoryWidget.prototype.queryCategoryStatus = function ( categoryNames
/**
* Adds category items.
*
* @method
* @param {Object[]} items Items to add
* @param {number} [index] Index to insert items after
* @return {jQuery.Promise}
@ -439,8 +435,6 @@ ve.ui.MWCategoryWidget.prototype.removeItems = function ( items ) {
/**
* Auto-fit the input.
*
* @method
*/
ve.ui.MWCategoryWidget.prototype.fitInput = function () {
var availableSpace, inputWidth, $lastItem,

5
modules/ve-mw/ui/widgets/ve.ui.MWParameterSearchWidget.js
View file

@ -57,7 +57,6 @@ OO.inheritClass( ve.ui.MWParameterSearchWidget, OO.ui.SearchWidget );
/**
* Handle select widget select events.
*
* @method
* @param {string} value New value
*/
ve.ui.MWParameterSearchWidget.prototype.onQueryChange = function () {
@ -71,7 +70,6 @@ ve.ui.MWParameterSearchWidget.prototype.onQueryChange = function () {
/**
* Handle SelectWidget choose events.
*
* @method
* @param {OO.ui.OptionWidget} item Selected item
* @fires choose
* @fires showAll
@ -89,7 +87,6 @@ ve.ui.MWParameterSearchWidget.prototype.onSearchResultsChoose = function ( item
/**
* Build a searchable index of parameters.
*
* @method
* @param {ve.dm.MWTemplateSpecModel} spec Template specification
*/
ve.ui.MWParameterSearchWidget.prototype.buildIndex = function () {
@ -127,8 +124,6 @@ ve.ui.MWParameterSearchWidget.prototype.buildIndex = function () {
/**
* Handle media query response events.
*
* @method
*/
ve.ui.MWParameterSearchWidget.prototype.addResults = function () {
var i, len, item, textMatch, nameMatch, remainder,