reference/dom/domnode/insertbefore.xml
e574835356ec82ec696eed831145eebc3ea5184d
...
...
@@ -1,6 +1,6 @@
1
1
<?xml version="1.0" encoding="utf-8"?>
2
2
<!-- $Revision$ -->
3
-
<refentry xml:id='domnode.insertbefore' xmlns="http://docbook.org/ns/docbook">
3
+
<refentry xml:id="domnode.insertbefore" xmlns="http://docbook.org/ns/docbook">
4
4
<refnamediv>
5
5
<refname>DOMNode::insertBefore</refname>
6
6
<refpurpose>
...
...
@@ -9,23 +9,26 @@
9
9
</refnamediv>
10
10
<refsect1 role="description">
11
11
&reftitle.description;
12
-
<methodsynopsis>
13
-
<modifier>public</modifier> <type>DOMNode</type><methodname>DOMNode::insertBefore</methodname>
14
-
<methodparam><type>DOMNode</type><parameter>newnode</parameter></methodparam>
15
-
<methodparam choice="opt"><type>DOMNode</type><parameter>refnode</parameter></methodparam>
12
+
<methodsynopsis role="DOMNode">
13
+
<modifier>public</modifier> <type class="union"><type>DOMNode</type><type>false</type></type><methodname>DOMNode::insertBefore</methodname>
14
+
<methodparam><type>DOMNode</type><parameter>node</parameter></methodparam>
15
+
<methodparam choice="opt"><type class="union"><type>DOMNode</type><type>null</type></type><parameter>child</parameter><initializer>&null;</initializer></methodparam>
16
16
</methodsynopsis>
17
17
<para>
18
18
This function inserts a new node right before the reference node.
19
19
If you plan to do further modifications on the appended child you must use
20
20
the returned node.
21
21
</para>
22
+
<para>
23
+
When using an existing node it will be moved.
24
+
</para>
22
25
</refsect1>
23
26
<refsect1 role="parameters">
24
27
&reftitle.parameters;
25
28
<para>
26
29
<variablelist>
27
30
<varlistentry>
28
-
<term><parameter>newnode</parameter></term>
31
+
<term><parameter>node</parameter></term>
29
32
<listitem>
30
33
<para>
31
34
The new node.
...
...
@@ -33,10 +36,10 @@
33
36
</listitem>
34
37
</varlistentry>
35
38
<varlistentry>
36
-
<term><parameter>refnode</parameter></term>
39
+
<term><parameter>child</parameter></term>
37
40
<listitem>
38
41
<para>
39
-
The reference node. If not supplied, <parameter>newnode</parameter> is
42
+
The reference node. If not supplied, <parameter>node</parameter> is
40
43
appended to the children.
41
44
</para>
42
45
</listitem>
...
...
@@ -47,7 +50,7 @@
47
50
<refsect1 role="returnvalues">
48
51
&reftitle.returnvalues;
49
52
<para>
50
-
The inserted node.
53
+
The inserted node or &false; on error.
51
54
</para>
52
55
</refsect1>
53
56
<refsect1 role="errors">
...
...
@@ -68,7 +71,7 @@
68
71
<listitem>
69
72
<para>
70
73
Raised if this node is of a type that does not allow children of the
71
-
type of the <parameter>newnode</parameter> node, or if the node to
74
+
type of the <parameter>node</parameter> node, or if the node to
72
75
append is one of this node's ancestors or this node itself.
73
76
</para>
74
77
</listitem>
...
...
@@ -77,7 +80,7 @@
77
80
<term><constant>DOM_WRONG_DOCUMENT_ERR</constant></term>
78
81
<listitem>
79
82
<para>
80
-
Raised if <parameter>newnode</parameter> was created from a different
83
+
Raised if <parameter>node</parameter> was created from a different
81
84
document than the one that created this node.
82
85
</para>
83
86
</listitem>
...
...
@@ -86,7 +89,7 @@
86
89
<term><constant>DOM_NOT_FOUND</constant></term>
87
90
<listitem>
88
91
<para>
89
-
Raised if <parameter>refnode</parameter> is not a child of this node.
92
+
Raised if <parameter>child</parameter> is not a child of this node.
90
93
</para>
91
94
</listitem>
92
95
</varlistentry>
...
...
@@ -104,7 +107,6 @@
104
107
</refsect1>
105
108

106
109
</refentry>
107
-

108
110
<!-- Keep this comment at the end of the file
109
111
Local variables:
110
112
mode: sgml
111
113



Tools (Spanish Manual)