diff options
Diffstat (limited to 'src/HTML5/Serializer')
| -rw-r--r-- | src/HTML5/Serializer/OutputRules.php | 23 | ||||
| -rw-r--r-- | src/HTML5/Serializer/RulesInterface.php | 8 | ||||
| -rw-r--r-- | src/HTML5/Serializer/Traverser.php | 12 |
3 files changed, 21 insertions, 22 deletions
diff --git a/src/HTML5/Serializer/OutputRules.php b/src/HTML5/Serializer/OutputRules.php index 2711d1b..41616d5 100644 --- a/src/HTML5/Serializer/OutputRules.php +++ b/src/HTML5/Serializer/OutputRules.php @@ -251,7 +251,7 @@ class OutputRules implements RulesInterface /** * Write a text node. * - * @param \DOMText $ele The text node to write + * @param \DOMText $ele The text node to write. */ public function text($ele) { @@ -290,8 +290,7 @@ class OutputRules implements RulesInterface /** * Write the namespace attributes. * - * - * @param \DOMNode $ele The element being written + * @param \DOMNode $ele The element being written. */ protected function namespaceAttrs($ele) { @@ -312,7 +311,7 @@ class OutputRules implements RulesInterface * Tags for HTML, MathML, and SVG are in the local name. Otherwise, use the * qualified name (8.3). * - * @param \DOMNode $ele The element being written + * @param \DOMNode $ele The element being written. */ protected function openTag($ele) { @@ -426,7 +425,7 @@ class OutputRules implements RulesInterface * Tags for HTML, MathML, and SVG are in the local name. Otherwise, use the * qualified name (8.3). * - * @param \DOMNode $ele The element being written + * @param \DOMNode $ele The element being written. */ protected function closeTag($ele) { @@ -440,7 +439,7 @@ class OutputRules implements RulesInterface * * @param string $text The string to put into the output * - * @return Traverser $this so it can be used in chaining + * @return $this */ protected function wr($text) { @@ -452,7 +451,7 @@ class OutputRules implements RulesInterface /** * Write a new line character. * - * @return Traverser $this so it can be used in chaining + * @return $this */ protected function nl() { @@ -483,10 +482,10 @@ class OutputRules implements RulesInterface * * @todo Use the Entities class in php 5.3 to have html5 entities. * - * @param string $text text to encode - * @param bool $attribute True if we are encoding an attrubute, false otherwise + * @param string $text Text to encode. + * @param bool $attribute True if we are encoding an attrubute, false otherwise. * - * @return string the encoded text + * @return string The encoded text. */ protected function enc($text, $attribute = false) { @@ -521,8 +520,8 @@ class OutputRules implements RulesInterface * * @see http://www.w3.org/TR/2013/CR-html5-20130806/syntax.html#escapingString * - * @param string $text text to escape - * @param bool $attribute True if we are escaping an attrubute, false otherwise + * @param string $text Text to escape. + * @param bool $attribute True if we are escaping an attrubute, false otherwise. */ protected function escape($text, $attribute = false) { diff --git a/src/HTML5/Serializer/RulesInterface.php b/src/HTML5/Serializer/RulesInterface.php index 6d3f60e..69a6ecd 100644 --- a/src/HTML5/Serializer/RulesInterface.php +++ b/src/HTML5/Serializer/RulesInterface.php @@ -19,8 +19,8 @@ interface RulesInterface * * Note, before the rules can be used a traverser must be registered. * - * @param mixed $output The output stream to write output to - * @param array $options An array of options + * @param mixed $output The output stream to write output to. + * @param array $options An array of options. */ public function __construct($output, $options = array()); @@ -29,9 +29,9 @@ interface RulesInterface * * Note, only one traverser can be used by the rules. * - * @param Traverser $traverser The traverser used in the rules + * @param Traverser $traverser The traverser used in the rules. * - * @return RulesInterface $this for the current object + * @return RulesInterface $this for the current object. */ public function setTraverser(Traverser $traverser); diff --git a/src/HTML5/Serializer/Traverser.php b/src/HTML5/Serializer/Traverser.php index a33943f..1e8d792 100644 --- a/src/HTML5/Serializer/Traverser.php +++ b/src/HTML5/Serializer/Traverser.php @@ -35,7 +35,7 @@ class Traverser /** * Create a traverser. * - * @param \DOMNode|\DOMNodeList $dom The document or node to traverse + * @param \DOMNode|\DOMNodeList $dom The document or node to traverse. * @param resource $out A stream that allows writing. The traverser will output into this * stream. * @param array $options An array of options for the traverser as key/value pairs. These include: @@ -56,7 +56,7 @@ class Traverser /** * Tell the traverser to walk the DOM. * - * @return resource $out Returns the output stream + * @return resource $out Returns the output stream. */ public function walk() { @@ -83,7 +83,7 @@ class Traverser /** * Process a node in the DOM. * - * @param mixed $node A node implementing \DOMNode + * @param mixed $node A node implementing \DOMNode. */ public function node($node) { @@ -114,7 +114,7 @@ class Traverser /** * Walk through all the nodes on a node list. * - * @param \DOMNodeList $nl A list of child elements to walk through + * @param \DOMNodeList $nl A list of child elements to walk through. */ public function children($nl) { @@ -126,9 +126,9 @@ class Traverser /** * Is an element local? * - * @param mixed $ele An element that implement \DOMNode + * @param mixed $ele An element that implement \DOMNode. * - * @return bool true if local and false otherwise + * @return bool true if local and false otherwise. */ public function isLocalElement($ele) { |