highwire / opensource-php-BetterDOMDocument

src/DOMDoc.php

Doc Comments +10 added lines, -9 removed lines

@@ -22,14 +22,14 @@ 
    *  $xml can either be an XML string, a DOMDocument, or a DOMElement. 
    *  You can also pass FALSE or NULL (or omit it) and load XML later using loadXML or loadHTML
    * 
-   * @param mixed $auto_register_namespaces 
+   * @param boolean $auto_register_namespaces 
    *  Auto-register namespaces. All namespaces in the root element will be registered for use in xpath queries.
    *  Namespaces that are not declared in the root element will not be auto-registered
    *  Defaults to TRUE (Meaning it will auto register all auxiliary namespaces but not the default namespace).
    *  Pass a prefix string to automatically register the default namespace.
    *  Pass FALSE to disable auto-namespace registeration
    * 
-   * @param bool $error_checking
+   * @param string|boolean $error_checking
    *  Can be 'strict', 'warning', or 'none. Defaults to 'strict'.
    *  'none' supresses all errors
    *  'warning' is the default behavior in DOMDocument
@@ -489,10 +489,10 @@ 
   /**
    * Given a pair of nodes, replace the first with the second
    * 
-   * @param mixed $node
+   * @param \DOMElement $node
    *  Node to be replaced. Can either be an xpath string or a DOMDocument (or even a DOMNode).
    * 
-   * @param mixed $replace
+   * @param \DOMElement $replace
    *  Replace $node with $replace. Replace can be an XML string, or a DOMNode
    * 
    * @return replaced node
@@ -552,7 +552,7 @@ 
    *   $context can either be an xpath string, or a DOMElement. Ommiting it
    *   results in transforming the entire document
    * 
-   * @return a new DOMDoc
+   * @return DOMDoc new DOMDoc
    */
   function tranform($xsl, $context = NULL) {
     if (!$context) {
@@ -578,8 +578,6 @@ 
    * @param mixed $node
    *  Node to be changed. Can either be an xpath string or a DOMElement.
    * 
-   * @param mixed $replace
-   *  Replace $node with $replace. Replace can be an XML string, or a DOMNode
    * 
    * @return the changed node
    *   The node with the new namespace. The node will also be changed in-situ in the document as well.
@@ -635,7 +633,7 @@ 
    *     it will transform all elements with xlink:type = simple into a <a href> element. 
    *     Alternatively you may specify your own xpath for selecting which elements get transformed
    *     into <a href> tags. 
-   * @return HTML string
+   * @return string string
    */  
   function asHTML($context = NULL, $options = array()) {
     $xslSimple = '
@@ -717,7 +715,7 @@ 
    *   $context can either be an xpath string, or a DOMElement. Ommiting it
    *   results in outputting the entire document
    * 
-   * @return XML string
+   * @return string string
    */  
   function out($context = NULL) {
     $this->createContext($context, 'xpath');
@@ -752,6 +750,9 @@ 
     return $this->out();
   }
 
+  /**
+   * @param string|boolean $error_checking
+   */
   public function setErrorChecking($error_checking) {
     // Check up error-checking
     if ($error_checking == FALSE) {

src/DOMList.php

Doc Comments +3 added lines

@@ -53,6 +53,9 @@
     return isset($this->array[$this->position]);
   }
   
+  /**
+   * @param integer $index
+   */
   function item($index) {
     if (isset($this->array[$index])) {
       return $this->array[$index];