jenkins-bot has submitted this change and it was merged.
Change subject: doc: Add missing @static to static ve.Element methods
......................................................................
doc: Add missing @static to static ve.Element methods
They were incorrectly showing up in generated documentation
as instance methods.
Change-Id: I3668311d9e6bc25d63a1f49cc7a1abe4f6f350aa
---
M modules/ve/ve.Element.js
1 file changed, 5 insertions(+), 7 deletions(-)
Approvals:
Catrope: Looks good to me, approved
jenkins-bot: Verified
diff --git a/modules/ve/ve.Element.js b/modules/ve/ve.Element.js
index e8dd29d..314242d 100644
--- a/modules/ve/ve.Element.js
+++ b/modules/ve/ve.Element.js
@@ -48,7 +48,7 @@
/**
* Gets a jQuery function within a specific document.
*
- * @method
+ * @static
* @param {jQuery|HTMLElement|HTMLDocument|Window} context Context to bind the
function to
* @param {ve.ui.Frame} [frame] Frame of the document context
* @returns {Function} Bound jQuery function
@@ -70,7 +70,7 @@
/**
* Get the document of an element.
*
- * @method
+ * @static
* @param {jQuery|HTMLElement|HTMLDocument|Window} context Context to bind the
function to
* @returns {HTMLDocument} Document object
* @throws {Error} If context is invalid
@@ -98,7 +98,7 @@
/**
* Get the window of an element or document.
*
- * @method
+ * @static
* @param {jQuery|HTMLElement|HTMLDocument|Window} context Context to bind the
function to
* @returns {Window} Window object
*/
@@ -113,7 +113,7 @@
*
* TODO: Make this function not use recursion.
*
- * @method
+ * @static
* @param {Window} from Window of the child frame
* @param {Window} [to=window] Window of the parent frame
* @param {Object} [offset] Offset to start with, used internally
@@ -156,6 +156,7 @@
/**
* Get the offset between two elements.
*
+ * @static
* @param {jQuery} $from
* @param {jQuery} $to
* @returns {Object} Translated position coordinates, containing top and left
properties
@@ -173,7 +174,6 @@
*
* Override this method to base the result on instance information.
*
- * @method
* @returns {string} HTML tag name
*/
ve.Element.prototype.getTagName = function () {
@@ -183,7 +183,6 @@
/**
* Get the DOM document.
*
- * @method
* @returns {HTMLDocument} Document object
*/
ve.Element.prototype.getElementDocument = function () {
@@ -193,7 +192,6 @@
/**
* Get the DOM window.
*
- * @method
* @returns {Window} Window object
*/
ve.Element.prototype.getElementWindow = function () {
--
To view, visit https://gerrit.wikimedia.org/r/77273
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: merged
Gerrit-Change-Id: I3668311d9e6bc25d63a1f49cc7a1abe4f6f350aa
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/extensions/VisualEditor
Gerrit-Branch: master
Gerrit-Owner: Krinkle <[email protected]>
Gerrit-Reviewer: Catrope <[email protected]>
Gerrit-Reviewer: jenkins-bot
_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
