Browse Source

Added various phpdoc packaging information. No code changes.

Frederic G. Marand 17 years ago
parent
commit
4c7dab94ed
6 changed files with 49 additions and 9 deletions
  1. 3 1
      Background_Application.php
  2. 9 2
      Finite_State_Machine.php
  3. 4 1
      Ftp_Client.php
  4. 17 2
      boxed_scalars.php
  5. 5 1
      misc.php
  6. 11 2
      u_date_code.php

+ 3 - 1
Background_Application.php

@@ -8,7 +8,7 @@
  *
  * @copyright  (c) 2007 OSI
  * @license    Licensed under the CeCILL 2.0
- * @version    CVS: $Id: Background_Application.php,v 1.3 2007-06-10 16:30:30 marand Exp $
+ * @version    CVS: $Id: Background_Application.php,v 1.4 2007-06-10 19:39:54 marand Exp $
  * @link       http://wiki.audean.com/fsm/fsm
  * @since      Not applicable yet
  * @package    fsm
@@ -22,6 +22,8 @@ error_reporting(E_ALL|E_STRICT);
  * based on an OSInet FSM (finite state machine).
  * Concrete implementations should include a constructor defining the
  * backgroundGoals array along the FSM graph.
+ * @package    fsm
+ * @subpackage fsm.ui
  */
 abstract class Background_Application
   {

+ 9 - 2
Finite_State_Machine.php

@@ -5,7 +5,7 @@
  * @copyright  (c) 2007 OSI
  * @author     Frédéric G. MARAND
  * @license    Licensed under the CeCILL 2.0
- * @version    CVS: $Id: Finite_State_Machine.php,v 1.8 2007-06-10 16:30:30 marand Exp $
+ * @version    CVS: $Id: Finite_State_Machine.php,v 1.9 2007-06-10 19:39:54 marand Exp $
  * @link       http://wiki.audean.com/fsm/fsm
  * @since      Not applicable yet
  * @package    fsm
@@ -13,12 +13,17 @@
  * @todo       replace setAttribute('id',...) by setIdAttribute when PHP5.2 becomes mandatory
  */
 
+/**
+ * needed notably for autoload and func_name()
+ */
 require_once('misc.php'); // for func_name()
+
 $erFiniteStateMachine = error_reporting(E_ALL|E_STRICT);
 
 /**
  * This class defines a possible outcome for a given FSM transition
- *
+ * @package    fsm
+ * @subpackage fsm.core
  */
 class Fsm_Result
   {
@@ -73,6 +78,8 @@ class Fsm_Result
  *   - send an idle event by using $this->idle()
  *   - submit any event (including idle) by using $this->apply_event($event_name)
  *
+ * @package    fsm
+ * @subpackage fsm.core
  */
 abstract class Finite_State_Machine
   {

+ 4 - 1
Ftp_Client.php

@@ -5,7 +5,7 @@
  * @copyright  (c) 2007 OSI
  * @author     Frédéric G. MARAND
  * @license    Licensed under the CeCILL 2.0
- * @version    CVS: $Id: Ftp_Client.php,v 1.2 2007-06-10 16:30:30 marand Exp $
+ * @version    CVS: $Id: Ftp_Client.php,v 1.3 2007-06-10 19:39:54 marand Exp $
  * @link
  * @since      Not applicable yet
  * @package    osinetoffice
@@ -29,6 +29,9 @@ $_ftpEr = error_reporting(E_ALL | E_STRICT);
  * - live: client connected and logged in
  * - active: a data transfer operation is under way
  * - unsafe: something failed, disconnect can happen out of our control
+ *
+ * @package    osinetoffice
+ * @subpackage bo_up_ingram
  */
 class Ftp_Client extends Finite_State_Machine
   {

+ 17 - 2
boxed_scalars.php

@@ -1,9 +1,24 @@
 <?php
 /**
- * This class enables use of scalar values with classes implementing Comparable_Interface
- * $Id: boxed_scalars.php,v 1.2 2007-06-03 21:23:38 marand Exp $
+ *
+ * Boxed scalar values, usable with classes implementing Comparable_Interface
+ * based on an OSInet Finite_State_Machine (fsm).
+ *
+ * This version relies on OSInet FSM >= 1.6
+ *
+ * @copyright  (c) 2007 OSI
+ * @license    Licensed under the CeCILL 2.0
+ * @version    CVS: $Id: boxed_scalars.php,v 1.3 2007-06-10 19:39:54 marand Exp $
+ * @link       http://wiki.audean.com/fsm/fsm
+ * @since      Not applicable yet
+ * @package    default
  */
 
+
+/**
+ * This class enables use of scalar values with classes implementing Comparable_Interface
+ * @package default
+ */
 class boxed_int implements Comparable_Interface
   {
   protected $value;

+ 5 - 1
misc.php

@@ -5,12 +5,16 @@
  * @copyright  (c) 2007 OSI
  * @author     Frédéric G. MARAND
  * @license    Licensed under the CeCILL 2.0
- * @version    CVS: $Id: misc.php,v 1.3 2007-06-10 16:30:30 marand Exp $
+ * @version    CVS: $Id: misc.php,v 1.4 2007-06-10 19:39:54 marand Exp $
  * @link       http://drupal.org/project/offload
  * @since      Not applicable yet
  * @package    default
  */
 
+/**
+ * Interface used by function providing non-standard comparisons
+ * @package default
+ */
 interface Comparable_Interface
   {
   /**

+ 11 - 2
u_date_code.php

@@ -7,14 +7,23 @@
  * @copyright  (c) 2007 OSI
  * @author     Frédéric G. MARAND
  * @license    Licensed under the CeCILL 2.0
- * @version    CVS: $Id: u_date_code.php,v 1.4 2007-06-03 21:25:47 marand Exp $
+ * @version    CVS: $Id: u_date_code.php,v 1.5 2007-06-10 19:39:54 marand Exp $
  * @link
  * @since      Not applicable yet
  * @package    default
  */
 
-require_once('boxed_scalars.php'); // needed to sign-compare ints
+/**
+ * needed to sign-compare ints
+ */
+require_once('boxed_scalars.php');
 
+/**
+ * OSInet-format date codes like 07F09 to 2007-06-09
+ *
+ * @package default
+ *
+ */
 class osinet_date_code implements Comparable_Interface
   {
   private $f_value;