Added documentation to the traverser

2 files changed, 19 insertions, 2 deletions

diff --git a/src/HTML5/Serializer/Traverser.php b/src/HTML5/Serializer/Traverser.php
index 6d5e805..a066517 100644
--- a/src/HTML5/Serializer/Traverser.php
+++ b/src/HTML5/Serializer/Traverser.php
@@ -280,6 +280,15 @@ class Traverser {
     return (bool)preg_match('/^(' . self::$block_elements . ')$/i', $name);
   }
 
+  /**
+   * Is the element literal?
+   *
+   * @param mixed $element
+   *   An element implementing DOMNode.
+   * 
+   * @return boolean
+   *   True if literal and false otherise.
+   */
   protected function isLiteral($element) {
     if (!$element->parentNode) {
       return FALSE;
@@ -288,13 +297,20 @@ class Traverser {
 
   }
 
+  /**
+   * Is an element local?
+   *
+   * @param mixed $ele
+   *   An element that implement \DOMNode.
+   *
+   * @return bool
+   *   True if local and false otherwise.
+   */
   protected function isLocalElement($ele) {
     $uri = $ele->namespaceURI;
     if (empty($uri)) {
       return FALSE;
     }
     return isset(self::$local_ns[$uri]);
-
   }
-
 }
diff --git a/test/HTML5/Serializer/TraverserTest.php b/test/HTML5/Serializer/TraverserTest.php
index 0717a75..059b314 100644
--- a/test/HTML5/Serializer/TraverserTest.php
+++ b/test/HTML5/Serializer/TraverserTest.php
@@ -2,6 +2,7 @@
 namespace HTML5\Tests;
 
 use \HTML5\Serializer\Traverser;
+use \HTML5\Parser;
 
 require_once __DIR__ . '/../TestCase.php';