summaryrefslogtreecommitdiffstats
path: root/src/xml
diff options
context:
space:
mode:
authorMartin Smith <msmith@trolltech.com>2010-01-21 14:03:43 +0100
committerMartin Smith <msmith@trolltech.com>2010-01-21 14:03:43 +0100
commitb9ef8332db374ef22ebd1045560c4cca1301e2c3 (patch)
treef740f7ce3f85e6553be543e192b0254565f83040 /src/xml
parenta6165c5ec3b16d3f778a2da38d90a8afe8d58cd8 (diff)
doc: Documented the return value for QDomNode::appendChild().
Task-number: QTBUG-7498
Diffstat (limited to 'src/xml')
-rw-r--r--src/xml/dom/qdom.cpp12
1 files changed, 8 insertions, 4 deletions
diff --git a/src/xml/dom/qdom.cpp b/src/xml/dom/qdom.cpp
index 657c79add0..cae959bbd4 100644
--- a/src/xml/dom/qdom.cpp
+++ b/src/xml/dom/qdom.cpp
@@ -2596,11 +2596,15 @@ QDomNode QDomNode::removeChild(const QDomNode& oldChild)
already has an element node as a child, \a newChild is not added as
a child and a null node is returned.
- Calling this function on a null node(created, for example, with the
- default constructor) does nothing.
+ Returns a new reference to \a newChild on success or a \link
+ isNull() null node\endlink on failure.
- The DOM specification disallow inserting attribute nodes, but due
- to historical reasons QDom accept them nevertheless.
+ Calling this function on a null node(created, for example, with
+ the default constructor) does nothing and returns a \link isNull()
+ null node\endlink.
+
+ The DOM specification disallow inserting attribute nodes, but for
+ historical reasons, QDom accepts them anyway.
\sa insertBefore() insertAfter() replaceChild() removeChild()
*/