summaryrefslogtreecommitdiff
path: root/src/HTML5/Serializer/RulesInterface.php
diff options
context:
space:
mode:
Diffstat (limited to 'src/HTML5/Serializer/RulesInterface.php')
-rw-r--r--src/HTML5/Serializer/RulesInterface.php26
1 files changed, 11 insertions, 15 deletions
diff --git a/src/HTML5/Serializer/RulesInterface.php b/src/HTML5/Serializer/RulesInterface.php
index 6ef5e5e..6d3f60e 100644
--- a/src/HTML5/Serializer/RulesInterface.php
+++ b/src/HTML5/Serializer/RulesInterface.php
@@ -3,28 +3,24 @@
* @file
* The interface definition for Rules to generate output.
*/
+
namespace Masterminds\HTML5\Serializer;
/**
- * To create a new rule set for writing output the RulesInterface needs to be
- * implemented.
- * The resulting class can be specified in the options with the
- * key of rules.
+ * To create a new rule set for writing output the RulesInterface needs to be implemented.
+ * The resulting class can be specified in the options with the key of rules.
*
- * For an example implementation see \Masterminds\HTML5\Serializer\OutputRules.
+ * For an example implementation see Serializer\OutputRules.
*/
interface RulesInterface
{
-
/**
* The class constructor.
*
* 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());
@@ -33,11 +29,11 @@ interface RulesInterface
*
* Note, only one traverser can be used by the rules.
*
- * @param \Masterminds\HTML5\Serializer\Traverser $traverser
- * The traverser used in the rules.
- * @return \Masterminds\HTML5\Serializer\RulesInterface $this for the current object.
+ * @param Traverser $traverser The traverser used in the rules
+ *
+ * @return RulesInterface $this for the current object
*/
- public function setTraverser(\Masterminds\HTML5\Serializer\Traverser $traverser);
+ public function setTraverser(Traverser $traverser);
/**
* Write a document element (\DOMDocument).
@@ -92,7 +88,7 @@ interface RulesInterface
/**
* Write a processor instruction.
*
- * To learn about processor instructions see \Masterminds\HTML5\InstructionProcessor
+ * To learn about processor instructions see InstructionProcessor
*
* Instead of returning the result write it to the output stream ($output)
* that was passed into the constructor.