Improve code documentation for Template

rougin · Dec 10, 2023 · ef7e6c1 · ef7e6c1
1 parent c3eec72
commit ef7e6c1
Show file tree

Hide file tree

Showing 6 changed files with 16 additions and 13 deletions.
diff --git a/src/Middleware/Doublepass.php b/src/Middleware/Doublepass.php
@@ -12,6 +12,7 @@
  *
  * @package Slytherin
  * @author  Rougin Gutib <rougingutib@gmail.com>
+ * @codeCoverageIgnore
  */
 class Doublepass implements HandlerInterface
 {

diff --git a/src/Template/Twig.php b/src/Template/Twig.php
@@ -3,13 +3,13 @@
 namespace Rougin\Slytherin\Template;
 
 /**
- * Renderer
+ * Twig Renderer
  *
- * NOTE: To be removed in v1.0.0. Use "TwigRenderer" instead.
+ * NOTE: To be removed in v1.0.0. Use "Twig\Renderer" instead.
  *
  * @package Slytherin
  * @author  Rougin Gutib <rougingutib@gmail.com>
  */
-class Twig extends TwigRenderer
+class Twig extends Twig\Renderer
 {
 }
diff --git a/src/Template/Twig/Renderer.php b/src/Template/Twig/Renderer.php
@@ -5,9 +5,9 @@
 use Rougin\Slytherin\Template\TwigRenderer;
 
 /**
- * Renderer
+ * Twig Renderer
  *
- * NOTE: To be removed in v1.0.0. Use "Template\TwigRenderer" instead.
+ * NOTE: To be removed in v1.0.0. Use "TwigRenderer" instead.
  *
  * @package Slytherin
  * @author  Rougin Gutib <rougingutib@gmail.com>

diff --git a/src/Template/TwigLoader.php b/src/Template/TwigLoader.php
@@ -5,14 +5,16 @@
 /**
  * Twig Loader
  *
- * Backward compatibility for the Twig package.
+ * A backward compatibility class for the Twig package.
  *
  * @package Slytherin
  * @author  Rougin Gutib <rougingutib@gmail.com>
  */
 class TwigLoader
 {
     /**
+     * Check if any version of Twig is installed.
+     *
      * @return boolean
      */
     public function exists()
@@ -21,6 +23,8 @@ public function exists()
     }
 
     /**
+     * Loads the Twig instance.
+     *
      * @param  string|string[] $path
      * @return \Twig\Environment
      */

diff --git a/src/Template/Vanilla/Renderer.php b/src/Template/Vanilla/Renderer.php
@@ -2,17 +2,16 @@
 
 namespace Rougin\Slytherin\Template\Vanilla;
 
-use Rougin\Slytherin\Template\VanillaRenderer;
+use Rougin\Slytherin\Template\Renderer as Slytherin;
 
 /**
  * Renderer
  *
- * A simple implementation of a template renderer.
- * NOTE: To be removed in v1.0.0. Use "Template\Renderer" instead.
+ * NOTE: To be removed in v1.0.0. Use "Renderer" instead.
  *
  * @package Slytherin
  * @author  Rougin Gutib <rougingutib@gmail.com>
  */
-class Renderer extends VanillaRenderer
+class Renderer extends Slytherin
 {
 }
diff --git a/src/Template/VanillaRenderer.php b/src/Template/VanillaRenderer.php
@@ -5,12 +5,11 @@
 /**
  * Renderer
  *
- * A simple implementation of a template renderer.
- * NOTE: To be removed in v1.0.0. Use "Template\Renderer" instead.
+ * NOTE: To be removed in v1.0.0. Use "Vanilla\Renderer" instead.
  *
  * @package Slytherin
  * @author  Rougin Gutib <rougingutib@gmail.com>
  */
-class VanillaRenderer extends Renderer
+class VanillaRenderer extends Vanilla\Renderer
 {
 }