- Added @package to classes.

- Added 'provides' to package.xml.
- Setted svn:ignore to api directories.
- Updated HIT documentation.

diff --git a/album/BIFE/Album/Pager.php b/album/BIFE/Album/Pager.php
index 7a37116f07579eb7e30cde3038bcce81eb19f7a0..70e4daac2580d299c94ffa762d38d2c1eb56b754 100644 (file)
--- a/album/BIFE/Album/Pager.php
+++ b/album/BIFE/Album/Pager.php
@@ -34,6 +34,7 @@ require_once 'BIFE/Widget.php';
 /**
  * Album pager to an easier navigation when viewing photos.
  *
+ * @package BIFE_Album
  * @access public
  */
 class BIFE_Album_Pager extends BIFE_Widget {

diff --git a/album/BIFE/Album/Photo.php b/album/BIFE/Album/Photo.php
index c99ef29e5c243bda9a9a3c570779e3453f169fac..d5e9bd8f424399278e89d5d16d69828c4ce048e9 100644 (file)
--- a/album/BIFE/Album/Photo.php
+++ b/album/BIFE/Album/Photo.php
@@ -34,6 +34,7 @@ require_once 'BIFE/Widget.php';
 /**
  * Photo widget.
  *
+ * @package BIFE_Album
  * @access public
  */
 class BIFE_Album_Photo extends BIFE_Widget {

diff --git a/album/BIFE/Album/Thumbs.php b/album/BIFE/Album/Thumbs.php
index 50adcd7f81342560a0364de69514b6deadd74724..293b0922d07cb30275263786950851a31f528495 100644 (file)
--- a/album/BIFE/Album/Thumbs.php
+++ b/album/BIFE/Album/Thumbs.php
@@ -37,6 +37,7 @@ require_once 'Image/Transform.php';
 /**
  * Photo album widget. [TODO: Make a better explanation]
  *
+ * @package BIFE_Album
  * @access public
  */
 class BIFE_Album_Thumbs extends BIFE_Widget {
@@ -268,4 +269,4 @@ Returns an array of associative arrays with this keys:
 
 } // -X2C Class :Thumbs
 
-?>
+?>
\ No newline at end of file

diff --git a/album/package.xml b/album/package.xml
index 533efd3f2ec39826aacbc5a9f09fd51b9ed0e63a..393e030448d7c0e1b5ca9ce37b0a9a0d11ae9989 100644 (file)
--- a/album/package.xml
+++ b/album/package.xml
@@ -20,6 +20,9 @@
         <date>2003-06-29</date>
         <state>alpha</state>
         <notes>Check http://www.llucax.hn.org/desarrollo/bife/ for details.</notes>
+        <provides type="class" name="BIFE_Album_Thumbs"/>
+        <provides type="class" name="BIFE_Album_Photo"/>
+        <provides type="class" name="BIFE_Album_Pager"/>
         <filelist>
             <!-- PHP -->
             <file role="php">BIFE/Album/Thumbs.php</file>

diff --git a/bife/BIFE/Container.php b/bife/BIFE/Container.php
index 2ddc24d12975076e671987ea72da8291affcce8d..85850619449298510d94c5ee17c7a7b2a7310814 100644 (file)
--- a/bife/BIFE/Container.php
+++ b/bife/BIFE/Container.php
@@ -34,6 +34,7 @@ require_once 'BIFE/Widget.php';
 /**
  * Base container widget class.
  *
+ * @package BIFE
  * @access public
  * @abstract
  */

diff --git a/bife/BIFE/Fallback.php b/bife/BIFE/Fallback.php
index 04a11b1c5553f2c8966e1c921011ae1ad57af3e3..f4e98b8060692fd4c9b14960117df60df7e64243 100644 (file)
--- a/bife/BIFE/Fallback.php
+++ b/bife/BIFE/Fallback.php
@@ -34,6 +34,7 @@ require_once 'BIFE/Container.php';
 /**
  * Fallback widget to use when no specific widget is implemented.
  *
+ * @package BIFE
  * @access public
  * @abstract
  */

diff --git a/bife/BIFE/Link.php b/bife/BIFE/Link.php
index c8900d68b36fa018384469ea68998a9c3d44fc6b..8204db0d27d0a6bba0c41748f5002c17ad75a734 100644 (file)
--- a/bife/BIFE/Link.php
+++ b/bife/BIFE/Link.php
@@ -34,6 +34,7 @@ require_once 'BIFE/Container.php';
 /**
  * Link to another page.
  *
+ * @package BIFE
  * @access public
  */
 class BIFE_Link extends BIFE_Container {

diff --git a/bife/BIFE/Parser.php b/bife/BIFE/Parser.php
index 76a58459a04e3b57b36a34b826eac71fbad8158e..ee35bfca192f5459954b56171d663f4b5271aa48 100644 (file)
--- a/bife/BIFE/Parser.php
+++ b/bife/BIFE/Parser.php
@@ -30,6 +30,7 @@
 /**
  * This is the XML Parser.
  *
+ * @package BIFE
  * @access public
  */
 class BIFE_Parser {

diff --git a/bife/BIFE/Translate.php b/bife/BIFE/Translate.php
index 83cd5351200be3f5283dfb9e2666558d9fe17cf8..4c1fe0549f15cfb6ceec0c89df954bfbf4a73cb7 100644 (file)
--- a/bife/BIFE/Translate.php
+++ b/bife/BIFE/Translate.php
@@ -34,6 +34,7 @@ require_once 'BIFE/Fallback.php';
 /**
  * This is a generic and simple (but very usefull) BIFE_Fallback implementation. Translate widgets using a template with it's name, prepended with 'bife_'. If not template is found, it copy the XML to the output.
  *
+ * @package BIFE
  * @access public
  */
 class BIFE_Translate extends BIFE_Fallback {
@@ -73,4 +74,4 @@ class BIFE_Translate extends BIFE_Fallback {
 
 } // -X2C Class :Translate
 
-?>
+?>
\ No newline at end of file

diff --git a/bife/BIFE/Widget.php b/bife/BIFE/Widget.php
index 5e0ab11b9a00189841263bd475d8c4b220a6b193..57860cd4a734123e9af51dc8f5bf8b91e985b83f 100644 (file)
--- a/bife/BIFE/Widget.php
+++ b/bife/BIFE/Widget.php
@@ -30,6 +30,7 @@
 /**
  * Base widget class.
  *
+ * @package BIFE
  * @access public
  * @abstract
  */

diff --git a/bife/package.xml b/bife/package.xml
index ecaf73878ca22a12d60bd3d3373910481fab7746..1f9f3e5562fd8b58e36d6dc1845c1a136099e9fa 100644 (file)
--- a/bife/package.xml
+++ b/bife/package.xml
@@ -23,6 +23,12 @@ in mind. One of the main goals of BIFE is to be fast.
         <date>2003-06-29</date>
         <state>alpha</state>
         <notes>Check http://www.llucax.hn.org/desarrollo/bife/ for details.</notes>
+        <provides type="class" name="BIFE_Parser"/>
+        <provides type="class" name="BIFE_Widget"/>
+        <provides type="class" name="BIFE_Container"/>
+        <provides type="class" name="BIFE_Fallback"/>
+        <provides type="class" name="BIFE_Link"/>
+        <provides type="class" name="BIFE_Translate"/>
         <filelist>
             <!-- PHP -->
             <file role="php">BIFE/Parser.php</file>

diff --git a/hit/HTML/Template/HIT.php b/hit/HTML/Template/HIT.php
index 59fbf0bed27632b5be489da126406e901101dede..9c03dc5793b9f5ef7e3aedda9168c36b9124c4e3 100644 (file)
--- a/hit/HTML/Template/HIT.php
+++ b/hit/HTML/Template/HIT.php
@@ -28,8 +28,10 @@
 
 // +X2C Class 130 :HIT
 /**
- * Hooks vs. IT (HIT) is a simple template implementation, based on hooks and IT template systems.
+ * Hooks vs IT Template Engine.
+Hooks vs IT (HIT) is a simple template implementation, based on hooks and IT template systems.
  *
+ * @package HTML_Template
  * @access public
  */
 class HTML_Template_HIT {
@@ -66,6 +68,8 @@ class HTML_Template_HIT {
     var $cache = array();
 
     /**
+     * Parsed templates buffer.
+     *
      * @var    array $buffer
      * @access protected
      */
@@ -151,7 +155,7 @@ If $vars is an array, the {[keys]} are replaced with [values] ($val is ignored).
 
     // +X2C Operation 144
     /**
-     * Parse a template buffering the results.
+     * Parse a template adding the results to the buffer.
 Parse a template appending the results to an internal buffer. If $vars is an array, the {[keys]} are replaced with [values] ($val is ignored). If is a string, {$vars} is replaced with $val.
      *
      * @param  string $name Name of template to parse.
@@ -229,7 +233,8 @@ Parse a template appending the results to an internal buffer. If $vars is an arr
 
     // +X2C Operation 159
     /**
-     * True if the template $name exists in $group (or the current group).
+     * Tells if a template exists.
+True if the template $name exists in $group (or the current group).
      *
      * @param  string $name Name of the template.
      * @param  mixed $group Template's group. If it's null it uses the current group.

diff --git a/hit/hit.xmi b/hit/hit.xmi
index 4e84cc7c5351b4c8f7b241248c63fc7205332811..fce10546f9102432d52f1f41c1b283b5fc0eac20 100644 (file)
--- a/hit/hit.xmi
+++ b/hit/hit.xmi
@@ -5,13 +5,15 @@
    <XMI.exporter>umbrello uml modeller http://uml.sf.net</XMI.exporter>
    <XMI.exporterVersion>1.1</XMI.exporterVersion>
   </XMI.documentation>
-  <XMI.model xmi.name="hit" href="/home/luca/bife/hit/hit.xmi" />
+  <XMI.model xmi.name="hit" href="/home/luca/website/www/test/bife/hit/hit.xmi" />
   <XMI.metamodel xmi.name="UML" href="UML.xml" xmi.version="1.3" />
  </XMI.header>
  <XMI.content>
   <docsettings viewid="132" documentation="Parse XML data getting widgets." uniqueid="159" />
   <umlobjects>
-   <UML:Class stereotype="" package="HTML/Template" xmi.id="130" abstract="0" documentation="Hooks vs. IT (HIT) is a simple template implementation, based on hooks and IT template systems." name="HIT" static="0" scope="200" >
+   <UML:Class stereotype="" package="HTML/Template" xmi.id="130" abstract="0" documentation="Hooks vs IT Template Engine.
+
+Hooks vs IT (HIT) is a simple template implementation, based on hooks and IT template systems." name="HIT" static="0" scope="200" >
     <UML:Operation stereotype="" package="" xmi.id="136" type="void" abstract="0" documentation="Constructor." name="HTML_Template_HIT" static="0" scope="200" >
      <UML:Parameter stereotype="" package="" xmi.id="1" value="'.'" type="string" abstract="0" documentation="Root directory where template files are." name="root" static="0" scope="200" />
      <UML:Parameter stereotype="" package="" xmi.id="3" value="false" type="bool" abstract="0" documentation="If it's true, it looks for template files in PHP's include_path." name="useIncludePath" static="0" scope="200" />
@@ -30,7 +32,7 @@ If $vars is an array, the {[keys]} are replaced with [values] ($val is ignored).
      <UML:Parameter stereotype="" package="" xmi.id="3" value="''" type="string" abstract="0" documentation="If $vars is a string, the value to replace for $vars." name="val" static="0" scope="200" />
      <UML:Parameter stereotype="" package="" xmi.id="4" value="null" type="mixed" abstract="0" documentation="Group to use to parse this template. Null to use the current group." name="group" static="0" scope="200" />
     </UML:Operation>
-    <UML:Operation stereotype="" package="" xmi.id="144" type="void" abstract="0" documentation="Parse a template buffering the results.
+    <UML:Operation stereotype="" package="" xmi.id="144" type="void" abstract="0" documentation="Parse a template adding the results to the buffer.
 
 Parse a template appending the results to an internal buffer. If $vars is an array, the {[keys]} are replaced with [values] ($val is ignored). If is a string, {$vars} is replaced with $val." name="parseBuffered" static="0" scope="200" >
      <UML:Parameter stereotype="" package="" xmi.id="1" value="" type="string" abstract="0" documentation="Name of template to parse." name="name" static="0" scope="200" />
@@ -47,7 +49,9 @@ Parse a template appending the results to an internal buffer. If $vars is an arr
      <UML:Parameter stereotype="" package="" xmi.id="1" value="''" type="string" abstract="0" documentation="Group to use." name="group" static="0" scope="200" />
     </UML:Operation>
     <UML:Operation stereotype="" package="" xmi.id="140" type="string" abstract="0" documentation="Removes the group from the groups stack and returns to the previous used group." name="popGroup" static="0" scope="200" />
-    <UML:Operation stereotype="" package="" xmi.id="159" type="bool" abstract="0" documentation="True if the template $name exists in $group (or the current group)." name="exists" static="0" scope="200" >
+    <UML:Operation stereotype="" package="" xmi.id="159" type="bool" abstract="0" documentation="Tells if a template exists.
+
+True if the template $name exists in $group (or the current group)." name="exists" static="0" scope="200" >
      <UML:Parameter stereotype="" package="" xmi.id="1" value="" type="string" abstract="0" documentation="Name of the template." name="name" static="0" scope="200" />
      <UML:Parameter stereotype="" package="" xmi.id="2" value="null" type="mixed" abstract="0" documentation="Template's group. If it's null it uses the current group." name="group" static="0" scope="200" />
     </UML:Operation>
@@ -55,7 +59,7 @@ Parse a template appending the results to an internal buffer. If $vars is an arr
     <UML:Attribute stereotype="" package="" xmi.id="158" value="false" type="bool" abstract="0" documentation="If it's true, it looks for template files in PHP's include_path." name="useIncludePath" static="0" scope="200" />
     <UML:Attribute stereotype="" package="" xmi.id="134" value="''" type="string" abstract="0" documentation="Group of templates to use (a subdirectory in root)." name="group" static="0" scope="202" />
     <UML:Attribute stereotype="" package="" xmi.id="135" value="array()" type="array" abstract="0" documentation="Templates cache." name="cache" static="0" scope="202" />
-    <UML:Attribute stereotype="" package="" xmi.id="147" value="array()" type="array" abstract="0" documentation="" name="buffer" static="0" scope="202" />
+    <UML:Attribute stereotype="" package="" xmi.id="147" value="array()" type="array" abstract="0" documentation="Parsed templates buffer." name="buffer" static="0" scope="202" />
    </UML:Class>
   </umlobjects>
   <diagrams>

diff --git a/hit/package.xml b/hit/package.xml
index bcf9483dcd11d4f783ae0730511b8a79b5108443..d7f18ed8a19c724e6dbb2900a1691d5683e151ab 100644 (file)
--- a/hit/package.xml
+++ b/hit/package.xml
@@ -22,6 +22,7 @@ like IT so every chunk must be in a separated file if you want to iterate it.
         <date>2003-06-30</date>
         <state>beta</state>
         <notes>Check http://www.llucax.hn.org/desarrollo/bife/ for details.</notes>
+        <provides type="class" name="HTML_Template_HIT"/>
         <filelist>
             <!-- PHP -->
             <file role="php">HTML/Template/HIT.php</file>

diff --git a/menu/BIFE/Menu/Menu.php b/menu/BIFE/Menu/Menu.php
index 09afd9b86c9fa58d599ab4b92d17becc5196e606..c549b423f52bd604857c1520784c705796714d78 100644 (file)
--- a/menu/BIFE/Menu/Menu.php
+++ b/menu/BIFE/Menu/Menu.php
@@ -34,6 +34,7 @@ require_once 'BIFE/Widget.php';
 /**
  * Dynamic Menu.
  *
+ * @package BIFE_Menu
  * @access public
  */
 class BIFE_Menu_Menu extends BIFE_Widget {

diff --git a/menu/package.xml b/menu/package.xml
index c9951ed9ccb36408375615778d27fde8a52ec5b6..42a7dd6032d98ee3d16fa598a8e394c25073ce99 100644 (file)
--- a/menu/package.xml
+++ b/menu/package.xml
@@ -20,6 +20,7 @@
         <date>2003-06-29</date>
         <state>alpha</state>
         <notes>Check http://www.llucax.hn.org/desarrollo/bife/ for details.</notes>
+        <provides type="class" name="BIFE_Menu_Menu"/>
         <filelist>
             <!-- PHP -->
             <file role="php">BIFE/Menu/Menu.php</file>