X-Git-Url: https://git.llucax.com/mecon/meconlib.git/blobdiff_plain/8b14b7f9fc748bbb758fff4f6cd906f5c215eaaa..b2e01d9194fbe8a52513c20bb7dcebb63e0d708d:/lib/MLIB/Tpl/FileDir.php

diff --git a/lib/MLIB/Tpl/FileDir.php b/lib/MLIB/Tpl/FileDir.php
index d2cb5c3..f5c12ab 100644
--- a/lib/MLIB/Tpl/FileDir.php
+++ b/lib/MLIB/Tpl/FileDir.php
@@ -31,6 +31,7 @@ require_once 'MLIB/Tpl.php';
  * Hooks vs IT (HIT) is a simple template implementation, based on hooks and IT 
  * template systems.
  *
+ *
  * @note This class was originally created as a part of BIFE.
  * @author Leandro Lucarella <luca@llucax.hn.org>
  * @todo Add a global example and an explanation of the directory structure to
@@ -112,7 +113,11 @@ class MLIB_Tpl_FileDir extends /* implements */ MLIB_Tpl
     }
 
     /**
-     * @copydoc MLIB_Tpl::pushGroup()
+     * Push a new item into the group array.
+     *
+     * @param group Item to be added on the group array.
+     *
+     * @todo Add an example.
      */
     function pushGroup($group = '')
     {
@@ -120,7 +125,10 @@ class MLIB_Tpl_FileDir extends /* implements */ MLIB_Tpl
     }
 
     /**
-     * @copydoc MLIB_Tpl::popGroup()
+     * Pops the actual group from the group array.
+     *
+     * @return mixed.
+     * @todo Add an example.
      */
     function popGroup()
     {
@@ -128,7 +136,10 @@ class MLIB_Tpl_FileDir extends /* implements */ MLIB_Tpl
     }
 
     /**
-     * @copydoc MLIB_Tpl::getGroup()
+     * Returns the last element of the group array.
+     *
+     * @return mixed.
+     * @todo Add an example.
      */
     function getGroup()
     {
@@ -136,7 +147,14 @@ class MLIB_Tpl_FileDir extends /* implements */ MLIB_Tpl
     }
 
     /**
-     * @copydoc MLIB_Tpl::exists()
+     * Checks if a certain template file exists.
+     *
+     * @param name Template file name.
+     * @param group If it is true, search in the group directory, otherwise
+     *              checks only in the root path.
+     *
+     * @return bool.
+     * @todo Add an example.
      */
     function exists($name, $group = null)
     {
@@ -194,4 +212,12 @@ class MLIB_Tpl_FileDir extends /* implements */ MLIB_Tpl
 
 }
 
+/**
+ * @example Tpl/FileDir/test.php
+ *
+ * This example will create an HTML page with a header, body and a footer.
+ * In order to do this, I will use three template groups (header, body, footer).
+ * All this templates are located in TPLS directory.
+ */
+
 ?>