From 78048f12db5bae39fa8a5f2588376c044441ce16 Mon Sep 17 00:00:00 2001 From: Mehdi Achour Date: Sun, 2 Jan 2005 15:36:00 +0000 Subject: [PATCH] Document the exceptions using the new format git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@176299 c90b9560-bf6c-de11-be94-00142212c4b1 --- .../dom-domcharacterdata-deletedata.xml | 17 ++++++-- .../dom-domcharacterdata-insertdata.xml | 15 +++++-- .../dom-domcharacterdata-replacedata.xml | 17 ++++++-- .../dom-domcharacterdata-substringdata.xml | 17 ++++++-- .../dom-domdocument-createattribute.xml | 14 ++++-- .../dom-domdocument-createattributens.xml | 24 +++++++++-- .../dom-domdocument-createelement.xml | 14 ++++-- .../dom-domdocument-createelementns.xml | 23 ++++++++-- .../dom-domdocument-createentityreference.xml | 14 ++++-- ...omdocument-createprocessinginstruction.xml | 17 ++++++-- .../dom/functions/dom-domdocument-savexml.xml | 14 ++++-- .../dom-domelement-removeattribute.xml | 13 +++++- .../dom-domelement-removeattributenode.xml | 22 ++++++++-- .../dom-domelement-removeattributens.xml | 13 +++++- .../functions/dom-domelement-setattribute.xml | 13 +++++- .../dom-domelement-setattributenode.xml | 15 +++++-- .../dom-domelement-setattributenodens.xml | 13 +++++- .../dom-domelement-setattributens.xml | 23 +++++++++- .../dom-domimplementation-createdocument.xml | 26 ++++++++--- ...m-domimplementation-createdocumenttype.xml | 15 +++++-- .../dom/functions/dom-domnode-appendchild.xml | 35 +++++++++++++-- .../functions/dom-domnode-insertbefore.xml | 41 +++++++++++++++++- .../dom/functions/dom-domnode-removechild.xml | 23 ++++++++-- .../functions/dom-domnode-replacechild.xml | 43 +++++++++++++++++-- 24 files changed, 409 insertions(+), 72 deletions(-) diff --git a/reference/dom/functions/dom-domcharacterdata-deletedata.xml b/reference/dom/functions/dom-domcharacterdata-deletedata.xml index 6994ebcfa7..ea9576b941 100644 --- a/reference/dom/functions/dom-domcharacterdata-deletedata.xml +++ b/reference/dom/functions/dom-domcharacterdata-deletedata.xml @@ -1,5 +1,5 @@ - + DOMCharacterData->deleteData() @@ -57,9 +57,18 @@ &reftitle.exceptions; - Throws DOMException if offset - is negative or greater than the number of characters in data, or if - count is negative. + + + DOM_INDEX_SIZE_ERR + + + Raised if offset is negative or greater than the + number of 16-bit units in data, or if count is + negative. + + + + diff --git a/reference/dom/functions/dom-domcharacterdata-insertdata.xml b/reference/dom/functions/dom-domcharacterdata-insertdata.xml index a848a72a2f..54037f81ff 100644 --- a/reference/dom/functions/dom-domcharacterdata-insertdata.xml +++ b/reference/dom/functions/dom-domcharacterdata-insertdata.xml @@ -1,5 +1,5 @@ - + DOMCharacterData->insertData() @@ -54,8 +54,17 @@ &reftitle.exceptions; - Throws DOMException if offset - is negative or greater than the number of 16-bit units in data. + + + DOM_INDEX_SIZE_ERR + + + Raised if offset is negative or greater than the + number of 16-bit units in data. + + + + diff --git a/reference/dom/functions/dom-domcharacterdata-replacedata.xml b/reference/dom/functions/dom-domcharacterdata-replacedata.xml index 6b6cc0cd7b..3cde1c9c24 100644 --- a/reference/dom/functions/dom-domcharacterdata-replacedata.xml +++ b/reference/dom/functions/dom-domcharacterdata-replacedata.xml @@ -1,5 +1,5 @@ - + DOMCharacterData->replaceData() @@ -66,9 +66,18 @@ &reftitle.exceptions; - Throws DOMException if offset - is negative or greater than the number of characters in data, or if - count is negative. + + + DOM_INDEX_SIZE_ERR + + + Raised if offset is negative or greater than the + number of 16-bit units in data, or if count is + negative. + + + + diff --git a/reference/dom/functions/dom-domcharacterdata-substringdata.xml b/reference/dom/functions/dom-domcharacterdata-substringdata.xml index cfd99b27c0..2fee2b78c1 100644 --- a/reference/dom/functions/dom-domcharacterdata-substringdata.xml +++ b/reference/dom/functions/dom-domcharacterdata-substringdata.xml @@ -1,5 +1,5 @@ - + DOMCharacterData->substringData() @@ -56,9 +56,18 @@ &reftitle.exceptions; - Throws DOMException if offset - is negative or greater than the number of 16-bit units in data, or if - count is negative. + + + DOM_INDEX_SIZE_ERR + + + Raised if offset is negative or greater than the + number of 16-bit units in data, or if count is + negative. + + + + diff --git a/reference/dom/functions/dom-domdocument-createattribute.xml b/reference/dom/functions/dom-domdocument-createattribute.xml index 68f348955e..ecc6d63c25 100644 --- a/reference/dom/functions/dom-domdocument-createattribute.xml +++ b/reference/dom/functions/dom-domdocument-createattribute.xml @@ -1,5 +1,5 @@ - + DOMDocument->createAttribute() @@ -44,8 +44,16 @@ &reftitle.exceptions; - Throws DOMException if name - contains an invalid character. + + + DOM_INVALID_CHARACTER_ERR + + + Raised if name contains an invalid character. + + + + diff --git a/reference/dom/functions/dom-domdocument-createattributens.xml b/reference/dom/functions/dom-domdocument-createattributens.xml index c6067831b0..e7bb0b794d 100644 --- a/reference/dom/functions/dom-domdocument-createattributens.xml +++ b/reference/dom/functions/dom-domdocument-createattributens.xml @@ -1,5 +1,5 @@ - + DOMDocument->createAttributeNS() @@ -55,8 +55,26 @@ &reftitle.exceptions; - Throws DOMException if qualifiedName - contains an invalid character. + + + DOM_INVALID_CHARACTER_ERR + + + Raised if qualifiedName contains an invalid character. + + + + + DOM_NAMESPACE_ERR + + + Raised if qualifiedName is a malformed qualified + name, or if qualifiedName has a prefix and + namespaceURI is &null;. + + + + diff --git a/reference/dom/functions/dom-domdocument-createelement.xml b/reference/dom/functions/dom-domdocument-createelement.xml index 5231aa1f39..9db8d39e87 100644 --- a/reference/dom/functions/dom-domdocument-createelement.xml +++ b/reference/dom/functions/dom-domdocument-createelement.xml @@ -1,5 +1,5 @@ - + DOMDocument->createElement() @@ -55,8 +55,16 @@ &reftitle.exceptions; - Throws DOMException if name - contains an invalid character. + + + DOM_INVALID_CHARACTER_ERR + + + Raised if name contains an invalid character. + + + + diff --git a/reference/dom/functions/dom-domdocument-createelementns.xml b/reference/dom/functions/dom-domdocument-createelementns.xml index f6ad258167..b161e27030 100644 --- a/reference/dom/functions/dom-domdocument-createelementns.xml +++ b/reference/dom/functions/dom-domdocument-createelementns.xml @@ -1,5 +1,5 @@ - + DOMDocument->createElementNS() @@ -65,8 +65,25 @@ &reftitle.exceptions; - Throws DOMException if qualifiedName - contains an invalid character. + + + DOM_INVALID_CHARACTER_ERR + + + Raised if qualifiedName contains an invalid character. + + + + + DOM_NAMESPACE_ERR + + + Raised if qualifiedName is a maformed qualified + name. + + + + diff --git a/reference/dom/functions/dom-domdocument-createentityreference.xml b/reference/dom/functions/dom-domdocument-createentityreference.xml index 127078e323..6b440554c8 100644 --- a/reference/dom/functions/dom-domdocument-createentityreference.xml +++ b/reference/dom/functions/dom-domdocument-createentityreference.xml @@ -1,5 +1,5 @@ - + DOMDocument->createEntityReference() @@ -44,8 +44,16 @@ &reftitle.exceptions; - Throws DOMException if name - contains an invalid character. + + + DOM_INVALID_CHARACTER_ERR + + + Raised if name contains an invalid character. + + + + diff --git a/reference/dom/functions/dom-domdocument-createprocessinginstruction.xml b/reference/dom/functions/dom-domdocument-createprocessinginstruction.xml index fb85e11d75..c56df1dffe 100644 --- a/reference/dom/functions/dom-domdocument-createprocessinginstruction.xml +++ b/reference/dom/functions/dom-domdocument-createprocessinginstruction.xml @@ -1,5 +1,5 @@ - + DOMDocument->createProcessingInstruction() @@ -53,9 +53,18 @@ &reftitle.exceptions; - Throws DOMException if target - contains an invalid character. - + + + DOM_INVALID_CHARACTER_ERR + + + Raised if target contains an invalid character. + + + + + + &reftitle.seealso; diff --git a/reference/dom/functions/dom-domdocument-savexml.xml b/reference/dom/functions/dom-domdocument-savexml.xml index 2c72d8b7a9..37b9ffad0e 100644 --- a/reference/dom/functions/dom-domdocument-savexml.xml +++ b/reference/dom/functions/dom-domdocument-savexml.xml @@ -1,5 +1,5 @@ - + DOMDocument->saveXML() @@ -47,8 +47,16 @@ &reftitle.exceptions; - Throws DOMException if node - is from another document. + + + DOM_WRONG_DOCUMENT_ERR + + + Raised if node is from another document. + + + + diff --git a/reference/dom/functions/dom-domelement-removeattribute.xml b/reference/dom/functions/dom-domelement-removeattribute.xml index 354c556f36..7128d18af4 100644 --- a/reference/dom/functions/dom-domelement-removeattribute.xml +++ b/reference/dom/functions/dom-domelement-removeattribute.xml @@ -1,5 +1,5 @@ - + DOMElement->removeAttribute() @@ -43,7 +43,16 @@ &reftitle.exceptions; - Throws DOMException if node cannot be modified. + + + DOM_NO_MODIFICATION_ALLOWED_ERR + + + Raised if the node is readonly. + + + + diff --git a/reference/dom/functions/dom-domelement-removeattributenode.xml b/reference/dom/functions/dom-domelement-removeattributenode.xml index 3651a31f5b..1b5b4674d6 100644 --- a/reference/dom/functions/dom-domelement-removeattributenode.xml +++ b/reference/dom/functions/dom-domelement-removeattributenode.xml @@ -1,5 +1,5 @@ - + DOMElement->removeAttributeNode() @@ -43,8 +43,24 @@ &reftitle.exceptions; - Throws DOMException if node cannot be modified or - attribute is not a member of the element node. + + + DOM_NO_MODIFICATION_ALLOWED_ERR + + + Raised if the node is readonly. + + + + + DOM_NOT_FOUND_ERROR + + + Raised if oldnode is not an attribute of the element. + + + + diff --git a/reference/dom/functions/dom-domelement-removeattributens.xml b/reference/dom/functions/dom-domelement-removeattributens.xml index af737c22de..990333227d 100644 --- a/reference/dom/functions/dom-domelement-removeattributens.xml +++ b/reference/dom/functions/dom-domelement-removeattributens.xml @@ -1,5 +1,5 @@ - + DOMElement->removeAttributeNS() @@ -53,7 +53,16 @@ &reftitle.exceptions; - Throws DOMException if node cannot be modified. + + + DOM_NO_MODIFICATION_ALLOWED_ERR + + + Raised if the node is readonly. + + + + diff --git a/reference/dom/functions/dom-domelement-setattribute.xml b/reference/dom/functions/dom-domelement-setattribute.xml index cbc643b410..41bf2692a5 100644 --- a/reference/dom/functions/dom-domelement-setattribute.xml +++ b/reference/dom/functions/dom-domelement-setattribute.xml @@ -1,5 +1,5 @@ - + DOMElement->setAttribute() @@ -53,7 +53,16 @@ &reftitle.exceptions; - Throws DOMException if node cannot be modified. + + + DOM_NO_MODIFICATION_ALLOWED_ERR + + + Raised if the node is readonly. + + + + diff --git a/reference/dom/functions/dom-domelement-setattributenode.xml b/reference/dom/functions/dom-domelement-setattributenode.xml index c7b490d4ba..70f8f240a3 100644 --- a/reference/dom/functions/dom-domelement-setattributenode.xml +++ b/reference/dom/functions/dom-domelement-setattributenode.xml @@ -1,5 +1,5 @@ - + DOMElement->setAttributeNode() @@ -37,13 +37,22 @@ &reftitle.returnvalues; - Returns old node if the attribute has been replaced. + Returns old node if the attribute has been replaced or &null;. &reftitle.exceptions; - Throws DOMException if node cannot be modified. + + + DOM_NO_MODIFICATION_ALLOWED_ERR + + + Raised if the node is readonly. + + + + diff --git a/reference/dom/functions/dom-domelement-setattributenodens.xml b/reference/dom/functions/dom-domelement-setattributenodens.xml index 3b7f1787f5..b9a78b0212 100644 --- a/reference/dom/functions/dom-domelement-setattributenodens.xml +++ b/reference/dom/functions/dom-domelement-setattributenodens.xml @@ -1,5 +1,5 @@ - + DOMElement->setAttributeNodeNS() @@ -43,7 +43,16 @@ &reftitle.exceptions; - Throws DOMException if node cannot be modified. + + + DOM_NO_MODIFICATION_ALLOWED_ERR + + + Raised if the node is readonly. + + + + diff --git a/reference/dom/functions/dom-domelement-setattributens.xml b/reference/dom/functions/dom-domelement-setattributens.xml index 85ee77748d..8d75ff4f46 100644 --- a/reference/dom/functions/dom-domelement-setattributens.xml +++ b/reference/dom/functions/dom-domelement-setattributens.xml @@ -1,5 +1,5 @@ - + DOMElement->setAttributeNS() @@ -63,7 +63,26 @@ &reftitle.exceptions; - Throws DOMException if node cannot be modified. + + + DOM_NO_MODIFICATION_ALLOWED_ERR + + + Raised if the node is readonly. + + + + + DOM_NAMESPACE_ERR + + + Raised if qualifiedName is a malformed qualified + name, or if qualifiedName has a prefix and + namespaceURI is &null;. + + + + diff --git a/reference/dom/functions/dom-domimplementation-createdocument.xml b/reference/dom/functions/dom-domimplementation-createdocument.xml index 8f05894881..658f8e1eee 100644 --- a/reference/dom/functions/dom-domimplementation-createdocument.xml +++ b/reference/dom/functions/dom-domimplementation-createdocument.xml @@ -1,5 +1,5 @@ - + DOMImplementation->createDocument() @@ -67,10 +67,26 @@ &reftitle.exceptions; - Throws DOMException if there is an error with the - namespace, as determined by namespaceURI and - qualifiedName, or if doctype - is not valid. + + + DOM_WRONG_DOCUMENT_ERR + + + Raised if doctype has already been used with a + different document or was created from a different implementation. + + + + + DOM_NAMESPACE_ERR + + + Raised if there is an error with the namespace, as determined by + namespaceURI and qualifiedName. + + + + diff --git a/reference/dom/functions/dom-domimplementation-createdocumenttype.xml b/reference/dom/functions/dom-domimplementation-createdocumenttype.xml index 18f9b1b4e7..6b89ec8d92 100644 --- a/reference/dom/functions/dom-domimplementation-createdocumenttype.xml +++ b/reference/dom/functions/dom-domimplementation-createdocumenttype.xml @@ -1,5 +1,5 @@ - + DOMImplementation->createDocumentType() @@ -66,8 +66,17 @@ &reftitle.exceptions; - Throws DOMException if there is an error with the - namespace, as determined by qualifiedName. + + + DOM_NAMESPACE_ERR + + + Raised if there is an error with the namespace, as determined by + qualifiedName. + + + + diff --git a/reference/dom/functions/dom-domnode-appendchild.xml b/reference/dom/functions/dom-domnode-appendchild.xml index c623027e30..b857c390be 100644 --- a/reference/dom/functions/dom-domnode-appendchild.xml +++ b/reference/dom/functions/dom-domnode-appendchild.xml @@ -1,5 +1,5 @@ - + DOMNode->appendChild() @@ -48,8 +48,37 @@ &reftitle.exceptions; - - Throws DOMException if the node cannot be appended. + + + + DOM_NO_MODIFICATION_ALLOWED_ERR + + + Raised if this node is readonly or if the previous parent of the node + being inserted is readonly. + + + + + DOM_HIERARCHY_REQUEST_ERR + + + Raised if this node is of a type that does not allow children of the + type of the newnode node, or if the node to + append is one of this node's ancestors or this node itself. + + + + + DOM_WRONG_DOCUMENT_ERR + + + Raised if newnode was created from a different + document than the one that created this node. + + + + diff --git a/reference/dom/functions/dom-domnode-insertbefore.xml b/reference/dom/functions/dom-domnode-insertbefore.xml index ddf01992f8..0b25d35f91 100644 --- a/reference/dom/functions/dom-domnode-insertbefore.xml +++ b/reference/dom/functions/dom-domnode-insertbefore.xml @@ -1,5 +1,5 @@ - + DOMNode->insertBefore() @@ -57,7 +57,44 @@ &reftitle.exceptions; - Throws DOMException if node cannot be inserted. + + + DOM_NO_MODIFICATION_ALLOWED_ERR + + + Raised if this node is readonly or if the previous parent of the node + being inserted is readonly. + + + + + DOM_HIERARCHY_REQUEST_ERR + + + Raised if this node is of a type that does not allow children of the + type of the newnode node, or if the node to + append is one of this node's ancestors or this node itself. + + + + + DOM_WRONG_DOCUMENT_ERR + + + Raised if newnode was created from a different + document than the one that created this node. + + + + + DOM_NOT_FOUND + + + Raised if refnode is not a child of this node. + + + + diff --git a/reference/dom/functions/dom-domnode-removechild.xml b/reference/dom/functions/dom-domnode-removechild.xml index ee91f63571..ab4cc2d6b9 100644 --- a/reference/dom/functions/dom-domnode-removechild.xml +++ b/reference/dom/functions/dom-domnode-removechild.xml @@ -1,5 +1,5 @@ - + DOMNode->removeChild() @@ -44,8 +44,25 @@ &reftitle.exceptions; - - Throws DOMException if the node cannot be removed. + + + + DOM_NO_MODIFICATION_ALLOWED_ERR + + + Raised if this node is readonly. + + + + + DOM_NOT_FOUND + + + Raised if oldnode is not a child of this node. + + + + diff --git a/reference/dom/functions/dom-domnode-replacechild.xml b/reference/dom/functions/dom-domnode-replacechild.xml index 076e1cabcd..5120503d65 100644 --- a/reference/dom/functions/dom-domnode-replacechild.xml +++ b/reference/dom/functions/dom-domnode-replacechild.xml @@ -1,5 +1,5 @@ - + DOMNode->replaceChild() @@ -57,8 +57,45 @@ &reftitle.exceptions; - - Throws DOMException if node cannot be replaced. + + + + DOM_NO_MODIFICATION_ALLOWED_ERR + + + Raised if this node is readonly or if the previous parent of the node + being inserted is readonly. + + + + + DOM_HIERARCHY_REQUEST_ERR + + + Raised if this node is of a type that does not allow children of the + type of the newnode node, or if the node to + put in is one of this node's ancestors or this node itself. + + + + + DOM_WRONG_DOCUMENT_ERR + + + Raised if newnode was created from a different + document than the one that created this node. + + + + + DOM_NOT_FOUND + + + Raised if oldnode is not a child of this node. + + + +