jenkins-bot has submitted this change and it was merged.
Change subject: ve.ce.Selection: Fix docs and variable names
......................................................................
ve.ce.Selection: Fix docs and variable names
Change-Id: I88a3ab498777f3671c73b698328033184a0dd7aa
---
M src/ce/ve.ce.Selection.js
1 file changed, 20 insertions(+), 3 deletions(-)
Approvals:
Jforrester: Looks good to me, approved
jenkins-bot: Verified
diff --git a/src/ce/ve.ce.Selection.js b/src/ce/ve.ce.Selection.js
index 9ef9a8f..722f972 100644
--- a/src/ce/ve.ce.Selection.js
+++ b/src/ce/ve.ce.Selection.js
@@ -9,7 +9,7 @@
* @abstract
* @constructor
* @param {ve.dm.Selection} model Selection model
- * @param {ve.ce.Document} surface Surface
+ * @param {ve.ce.Surface} surface Surface view
*/
ve.ce.Selection = function VeCeSelection( model, surface ) {
this.model = model;
@@ -26,16 +26,33 @@
/* Static methods */
-ve.ce.Selection.static.newFromModel = function ( model, doc ) {
- return ve.ce.selectionFactory.create( model.getName(), model, doc );
+/**
+ * Create a new selection view from a selection model
+ *
+ * @param {ve.dm.Selection} model Selection model
+ * @param {ve.ce.Surface} surface Surface view
+ * @return {ve.ce.Selection} Selection view
+ */
+ve.ce.Selection.static.newFromModel = function ( model, surface ) {
+ return ve.ce.selectionFactory.create( model.getName(), model, surface );
};
/* Method */
+/**
+ * Get the surface view this selection exists on
+ *
+ * @return {ve.ce.Surface} Surface view
+ */
ve.ce.Selection.prototype.getSurface = function () {
return this.surface;
};
+/**
+ * Get the selection model
+ *
+ * @return {ve.dm.Selection} Selection model
+ */
ve.ce.Selection.prototype.getModel = function () {
return this.model;
};
--
To view, visit https://gerrit.wikimedia.org/r/258751
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: merged
Gerrit-Change-Id: I88a3ab498777f3671c73b698328033184a0dd7aa
Gerrit-PatchSet: 1
Gerrit-Project: VisualEditor/VisualEditor
Gerrit-Branch: master
Gerrit-Owner: Esanders <[email protected]>
Gerrit-Reviewer: Jforrester <[email protected]>
Gerrit-Reviewer: jenkins-bot <>
_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
