Anonymous avatar Anonymous committed 84c5dbc

Modified Files:
example/libxml.xml
o added some infos about implicit document-fragments and unbindNode()

Comments (0)

Files changed (1)

example/libxml.xml

 <class name="XML::LibXML::Node">
 <short>"virtual" Base Class DOM-Nodes</short>
 <description>
-	LibXML::Node defines functions that are common to all Node
-	Types.  A LibXML::Node should never be created standalone, but
-	as an instance of a high level class such as LibXML::Element
-	or LibXML::Text.  The class itself should provide only common
-	functionality.
+	LibXML::Node defines functions that are common to all Node Types.
+	A LibXML::Node should never be created standalone, but as an
+	instance of a high level class such as LibXML::Element or
+	LibXML::Text.  The class itself should provide only common
+	functionality. In XML::LibXML each node is part either of a
+	document or a document-fragment.  Because of this there is no node
+	without a parent. This may causes confusion with "unbound" nodes.
+
 
 <method name="getName" 
-	synopsis="$name = $node->getName();">
-	Returns the node's name. This Function is aware about namesaces
-	and returns the full name of the current node
-	(<i>prefix:localname</i>)
+	synopsis="$name = $node->getName();"> Returns the node's
+	name. This Function is aware about namesaces and returns the full
+	name of the current node (<i>prefix:localname</i>)
 </method>
 
 <method name="nodeName"
     Alias for <b>getType</b>.
 </method>
 
-<method name="unbindNode" 
-	synopsis="$node->unbindNode()">
-	Unbinds the Node from its siblings and Parent, but not from the
-	Document it belongs to. If the node is not inserted into the 
-	DOM afterwards it will be lost after the programm terminated.
+<method name="unbindNode" synopsis="$node->unbindNode()"> 
+Unbinds the Node from its siblings and Parent, but not from the
+Document it belongs to. If the node is not inserted into the DOM
+afterwards it will be lost after the programm terminated. From a low
+level view, the unbound node is stripped from the context it is and
+inserted into a (hidden) document-fragment.
 </method>
 
 <method name="removeChild" 
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.