Add extended documentation for Node’s containsNode method

This will be deprecated and replaced with isInclusiveAncestor in a later release.
2017-01-05 02:44:05 +01:00
parent 12fc972602
commit 8602ad5a7b
1 changed files with 2 additions and 1 deletions
@@ -340,7 +340,8 @@ typedef NS_OPTIONS(unsigned short, HTMLDocumentPosition)
 - (BOOL)isDescendantOfNode:(HTMLNode *)node;

 /**
- Checks whether this node contains the given node.
+ Checks whether this node contains the given node. This performs an `invlusive ancestor` check, i.e. it returns `YES`
+ if the given node is the same object as this node.

 @param node The node to check.
 @return `YES` if this node contains the given node, `NO` otherwsie.