summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMichael Drake <michael.drake@codethink.co.uk>2021-07-05 12:04:44 +0100
committerMichael Drake <michael.drake@codethink.co.uk>2021-07-05 12:04:44 +0100
commit78cd9ec509366e8a1fd61f077aba3a6537255ad1 (patch)
tree064c694eb395b4a16f6badb028ed40dfaabc2b50
parent99e5503a28fbb754422086d140cdf030a66497c7 (diff)
downloadlibdom-78cd9ec509366e8a1fd61f077aba3a6537255ad1.tar.gz
libdom-78cd9ec509366e8a1fd61f077aba3a6537255ad1.tar.bz2
Element: API docs: Reword based on review.
-rw-r--r--src/core/element.c15
1 files changed, 12 insertions, 3 deletions
diff --git a/src/core/element.c b/src/core/element.c
index a3d9ee7..66d0390 100644
--- a/src/core/element.c
+++ b/src/core/element.c
@@ -1232,9 +1232,12 @@ dom_exception _dom_element_has_class(struct dom_element *element,
/**
* Get a named ancestor node
*
+ * If the caller wants to keep the returned node around, it must take its
+ * own ref. This call returns a borrow.
+ *
* \param element Element to consider
* \param name Node name to look for
- * \param ancestor Pointer to location to receive unreffed node pointer
+ * \param parent Pointer to location to receive borrowed node pointer
* \return DOM_NO_ERR.
*/
dom_exception dom_element_named_ancestor_node(dom_element *element,
@@ -1262,9 +1265,12 @@ dom_exception dom_element_named_ancestor_node(dom_element *element,
/**
* Get a named parent node
*
+ * If the caller wants to keep the returned node around, it must take its
+ * own ref. This call returns a borrow.
+ *
* \param element Element to consider
* \param name Node name to look for
- * \param parent Pointer to location to receive unreffed node pointer
+ * \param parent Pointer to location to receive borrowed node pointer
* \return DOM_NO_ERR.
*/
dom_exception dom_element_named_parent_node(dom_element *element,
@@ -1292,9 +1298,12 @@ dom_exception dom_element_named_parent_node(dom_element *element,
/**
* Get a named parent node
*
+ * If the caller wants to keep the returned node around, it must take its
+ * own ref. This call returns a borrow.
+ *
* \param element Element to consider
* \param name Node name to look for
- * \param parent Pointer to location to receive unreffed node pointer
+ * \param parent Pointer to location to receive borrowed node pointer
* \return DOM_NO_ERR.
*/
dom_exception dom_element_parent_node(dom_element *element,