wikimedia/mediawiki-extensions-Cite
1
0
Fork 0
mirror of https://gerrit.wikimedia.org/r/mediawiki/extensions/Cite synced 2024-11-23 22:45:20 +00:00
Code Issues Packages Projects Releases Wiki Activity

Remove obsolete @method annotations

Browse source 
These tags are 10 years old. Current documentation generators don't
need them.

Tagging something explicitely as being a @method can be useful in
an interface where the elements are initialized with e.g. `= null;`
instead of having an implementation. But we have implementations
here. Sure these are methods. No need to say that in the
documentation.

Also removing a comment that's obviously a copy-paste mistake from
what was the ve.ui.MWMediaSearchWidget back then. See Ib244ff6 and
before.

Change-Id: I7df6c789d10fd89e7fe97d56c942fd22c56d8458
This commit is contained in:
thiemowmde 2024-02-22 20:07:33 +01:00
parent 90dc52620c
commit 5d8e256fbc
3 changed files with 0 additions and 19 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
modules/ve-cite/ve.ce.MWReferencesListNode.js
View file

@ -87,8 +87,6 @@ ve.ce.MWReferencesListNode.prototype.getExtraHighlightClasses = function () {
/** /**
* Handle setup events. * Handle setup events.
*
* @method
*/ */
ve.ce.MWReferencesListNode.prototype.onSetup = function () { ve.ce.MWReferencesListNode.prototype.onSetup = function () {
this.internalList = this.getModel().getDocument().getInternalList(); this.internalList = this.getModel().getDocument().getInternalList();
@ -103,8 +101,6 @@ ve.ce.MWReferencesListNode.prototype.onSetup = function () {
/** /**
* Handle teardown events. * Handle teardown events.
*
* @method
*/ */
ve.ce.MWReferencesListNode.prototype.onTeardown = function () { ve.ce.MWReferencesListNode.prototype.onTeardown = function () {
// Parent method // Parent method
@ -126,7 +122,6 @@ ve.ce.MWReferencesListNode.prototype.onTeardown = function () {
* *
* This will occur after a document transaction. * This will occur after a document transaction.
* *
* @method
* @param {string[]} groupsChanged A list of groups which have changed in this transaction * @param {string[]} groupsChanged A list of groups which have changed in this transaction
*/ */
ve.ce.MWReferencesListNode.prototype.onInternalListUpdate = function ( groupsChanged ) { ve.ce.MWReferencesListNode.prototype.onInternalListUpdate = function ( groupsChanged ) {
@ -160,8 +155,6 @@ ve.ce.MWReferencesListNode.prototype.onAttributeChange = function ( key ) {
* Handle the updating of the InternalListNode. * Handle the updating of the InternalListNode.
* *
* This will occur after changes to any InternalItemNode. * This will occur after changes to any InternalItemNode.
*
* @method
*/ */
ve.ce.MWReferencesListNode.prototype.onListNodeUpdate = function () { ve.ce.MWReferencesListNode.prototype.onListNodeUpdate = function () {
// When the list node updates we're not sure which list group the item // When the list node updates we're not sure which list group the item

1
modules/ve-cite/ve.ui.MWCitationAction.js
View file

@ -38,7 +38,6 @@ ve.ui.MWCitationAction.static.methods = [ 'open' ];
* When opening a citation, send the dialog a property of the surface * When opening a citation, send the dialog a property of the surface
* dialog name. * dialog name.
* *
* @method
* @param {Object} windowData Data to send to the dialog * @param {Object} windowData Data to send to the dialog
* @return {boolean} Action was executed * @return {boolean} Action was executed
*/ */

11
modules/ve-cite/ve.ui.MWReferenceSearchWidget.js
View file

@ -43,7 +43,6 @@ OO.inheritClass( ve.ui.MWReferenceSearchWidget, OO.ui.SearchWidget );
/** /**
* Handle query change events. * Handle query change events.
* *
* @method
* @param {string} value New value * @param {string} value New value
*/ */
ve.ui.MWReferenceSearchWidget.prototype.onQueryChange = function () { ve.ui.MWReferenceSearchWidget.prototype.onQueryChange = function () {
@ -83,7 +82,6 @@ ve.ui.MWReferenceSearchWidget.prototype.setInternalList = function ( internalLis
* *
* This will occur after a document transaction. * This will occur after a document transaction.
* *
* @method
* @param {string[]} groupsChanged A list of groups which have changed in this transaction * @param {string[]} groupsChanged A list of groups which have changed in this transaction
*/ */
ve.ui.MWReferenceSearchWidget.prototype.onInternalListUpdate = function ( groupsChanged ) { ve.ui.MWReferenceSearchWidget.prototype.onInternalListUpdate = function ( groupsChanged ) {
@ -98,8 +96,6 @@ ve.ui.MWReferenceSearchWidget.prototype.onInternalListUpdate = function ( groups
* Handle the updating of the InternalListNode. * Handle the updating of the InternalListNode.
* *
* This will occur after changes to any InternalItemNode. * This will occur after changes to any InternalItemNode.
*
* @method
*/ */
ve.ui.MWReferenceSearchWidget.prototype.onListNodeUpdate = function () { ve.ui.MWReferenceSearchWidget.prototype.onListNodeUpdate = function () {
this.built = false; this.built = false;
@ -107,8 +103,6 @@ ve.ui.MWReferenceSearchWidget.prototype.onListNodeUpdate = function () {
/** /**
* Build a searchable index of references. * Build a searchable index of references.
*
* @method
*/ */
ve.ui.MWReferenceSearchWidget.prototype.buildIndex = function () { ve.ui.MWReferenceSearchWidget.prototype.buildIndex = function () {
const groups = this.internalList.getNodeGroups(); const groups = this.internalList.getNodeGroups();
@ -194,11 +188,6 @@ ve.ui.MWReferenceSearchWidget.prototype.isIndexEmpty = function () {
return this.indexEmpty; return this.indexEmpty;
}; };
/**
* Handle media query response events.
*
* @method
*/
ve.ui.MWReferenceSearchWidget.prototype.addResults = function () { ve.ui.MWReferenceSearchWidget.prototype.addResults = function () {
const query = this.query.getValue().trim().toLowerCase(); const query = this.query.getValue().trim().toLowerCase();
const items = []; const items = [];