servo-php / fluidxml

source/FluidXml.php

Doc Comments +24 added lines, -5 removed lines

@@ -68,7 +68,7 @@ 
  *
  * @param array $arguments Options that influence the construction of the XML document.
  *
- * @return FluidXml A new FluidXml instance.
+ * @return FluidContext A new FluidXml instance.
  */
 function fluidify(...$arguments)
 {
@@ -85,6 +85,9 @@ 
         return new FluidNamespace(...$arguments);
 }
 
+/**
+ * @param string $string
+ */
 function is_an_xml_string($string)
 {
         // Removes any empty new line at the beginning,
@@ -143,12 +146,16 @@ 
          * $xml->query("/doc")->query("book[@id='123']");
          * ```
          *
-         * @param string $xpath The XPath to execute.
+         * @param string[] $xpath The XPath to execute.
          *
          * @return FluidContext The context associated to the DOMNodeList.
          */
         public function query(...$xpath);
         public function times($times, callable $fn = null);
+
+        /**
+         * @return FluidContext
+         */
         public function each(callable $fn);
 
         /**
@@ -165,9 +172,6 @@ 
          * ```
          *
          * @param string|array $child The child/children to add.
-         * @param string $value The child text content.
-         * @param bool $switchContext Whether to return the current context
-         *                            or the context of the created node.
          *
          * @return FluidContext The context associated to the DOMNodeList.
          */
@@ -182,6 +186,10 @@ 
         public function remove(...$xpath);
         public function xml($strip = false);
         // Aliases:
+
+        /**
+         * @return FluidContext
+         */
         public function add($child, ...$optionals);
         public function prepend($sibling, ...$optionals);
         public function insertSiblingBefore($sibling, ...$optionals);
@@ -478,6 +486,10 @@ 
                 return new FluidContext($context, $this->namespaces);
         }
 
+        /**
+         * @param FluidContext $helpContext
+         * @param FluidContext $newContext
+         */
         protected function chooseContext($helpContext, $newContext)
         {
                 // If the two contextes are diffent, the user has requested
@@ -876,6 +888,10 @@ 
                 return new FluidContext($context, $this->namespaces);
         }
 
+        /**
+         * @param string $name
+         * @param string $value
+         */
         protected function createElement($name, $value = null)
         {
                 // The DOMElement instance must be different for every node,
@@ -1211,6 +1227,9 @@ 
         protected $context;
         protected $times;
 
+        /**
+         * @param FluidContext $context
+         */
         public function __construct($context, $times)
         {
                 $this->context = $context;