Esanders has uploaded a new change for review. (
https://gerrit.wikimedia.org/r/345664 )
Change subject: ve.Node: Fix getRoot/getParent/getDocument documentation
......................................................................
ve.Node: Fix getRoot/getParent/getDocument documentation
These can all return null if the node is detached.
Change-Id: I181093a58e687f9ff06bfc19c49ee7975521447c
---
M src/ve.Node.js
1 file changed, 3 insertions(+), 3 deletions(-)
git pull ssh://gerrit.wikimedia.org:29418/VisualEditor/VisualEditor
refs/changes/64/345664/1
diff --git a/src/ve.Node.js b/src/ve.Node.js
index 4d16c47..7102873 100644
--- a/src/ve.Node.js
+++ b/src/ve.Node.js
@@ -282,7 +282,7 @@
* Get a reference to the node's parent.
*
* @method
- * @return {ve.Node} Reference to the node's parent
+ * @return {ve.Node|null} Reference to the node's parent, null if detached
*/
ve.Node.prototype.getParent = function () {
return this.parent;
@@ -292,7 +292,7 @@
* Get the root node of the tree the node is currently attached to.
*
* @method
- * @return {ve.Node} Root node
+ * @return {ve.Node|null} Root node, null if detached
*/
ve.Node.prototype.getRoot = function () {
return this.root;
@@ -323,7 +323,7 @@
* Get the document the node is a part of.
*
* @method
- * @return {ve.Document} Document the node is a part of
+ * @return {ve.Document|null} Document the node is a part of, null if detached
*/
ve.Node.prototype.getDocument = function () {
return this.doc;
--
To view, visit https://gerrit.wikimedia.org/r/345664
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: newchange
Gerrit-Change-Id: I181093a58e687f9ff06bfc19c49ee7975521447c
Gerrit-PatchSet: 1
Gerrit-Project: VisualEditor/VisualEditor
Gerrit-Branch: master
Gerrit-Owner: Esanders <[email protected]>
_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
