[pLog-svn] r1516 - plog/trunk/class/object

[oscar at devel.plogworld.net]

Author: oscar
Date: 2005-03-15 20:25:26 +0000 (Tue, 15 Mar 2005)
New Revision: 1516

Modified:
   plog/trunk/class/object/exception.class.php
   plog/trunk/class/object/object.class.php
   plog/trunk/class/object/observable.class.php
   plog/trunk/class/object/observer.class.php
   plog/trunk/class/object/reflection.class.php
Log:
even more documentation

Modified: plog/trunk/class/object/exception.class.php
===================================================================
--- plog/trunk/class/object/exception.class.php	2005-03-15 20:20:54 UTC (rev 1515)
+++ plog/trunk/class/object/exception.class.php	2005-03-15 20:25:26 UTC (rev 1516)
@@ -1,12 +1,10 @@
 <?php
 
-    /**
-     * @package object
-     */
-
 	include_once( PLOG_CLASS_PATH."class/object/object.class.php" );
 
 	/**
+	 * \ingroup Core
+	 *
 	 * PHP Java-style definition of an Exception object-
 	 */
 	class Exception extends Object 

Modified: plog/trunk/class/object/object.class.php
===================================================================
--- plog/trunk/class/object/object.class.php	2005-03-15 20:20:54 UTC (rev 1515)
+++ plog/trunk/class/object/object.class.php	2005-03-15 20:25:26 UTC (rev 1516)
@@ -1,9 +1,5 @@
 <?php
 
-    /**
-     * @package object
-     */
-	 
 /**
 
 \mainpage
@@ -31,9 +27,20 @@
     include_once( PLOG_CLASS_PATH."class/logger/loggermanager.class.php" );
     include_once( PLOG_CLASS_PATH."class/logger/LogUtil.php" );
     include_once( PLOG_CLASS_PATH."debug.php" );
+	
+	/**
+	 * \defgroup Core
+	 *
+	 * These classes are at the lowest level of the pLog object model. Included here is the Object class,
+	 * which is the base class from which all other classes in pLog inherit. The Core package also includes
+	 * classes for dealing with <b>simulated</b> exceptions in PHP4 (they are disabled in PHP5 and the
+	 * framework will use native exceptions), and a bit of reflection too using PHP4's reflection
+	 * features.
+	 */
 
-    //include_once( PLOG_CLASS_PATH."class/logger/Log.php" );
 	/**
+	 * \ingroup Core
+	 * 
 	 * This is the highest class on the top of our hierarchy. Provides some common methods
      * useful to deal with objects, an also some commodity methods for debugging such as
      * toString, which will dump the names and the values of the attributes of the object.

Modified: plog/trunk/class/object/observable.class.php
===================================================================
--- plog/trunk/class/object/observable.class.php	2005-03-15 20:20:54 UTC (rev 1515)
+++ plog/trunk/class/object/observable.class.php	2005-03-15 20:25:26 UTC (rev 1516)
@@ -1,13 +1,10 @@
 <?php
 
-    /**
-     * @package object
-     */
-
-
 	include_once( PLOG_CLASS_PATH."class/object/object.class.php" );
 
 	/**
+	 * \ingroup Core
+	 *
      * Implementation of the Observer pattern. Copied/Inspired ;) from
      * http://www.phppatterns.com/index.php/article/articleview/27/1/1/.
      */

Modified: plog/trunk/class/object/observer.class.php
===================================================================
--- plog/trunk/class/object/observer.class.php	2005-03-15 20:20:54 UTC (rev 1515)
+++ plog/trunk/class/object/observer.class.php	2005-03-15 20:25:26 UTC (rev 1516)
@@ -1,13 +1,10 @@
 <?php
 
-    /**
-     * @package object
-     */
-
-
 	include_once( PLOG_CLASS_PATH."class/object/object.class.php" );
 
     /**
+	 * \ingroup Core
+	 * 
      * Implementation of the Observer pattern. Copied/Inspired ;) from
      * http://www.phppatterns.com/index.php/article/articleview/27/1/1/.
      * Base Observer class     

Modified: plog/trunk/class/object/reflection.class.php
===================================================================
--- plog/trunk/class/object/reflection.class.php	2005-03-15 20:20:54 UTC (rev 1515)
+++ plog/trunk/class/object/reflection.class.php	2005-03-15 20:25:26 UTC (rev 1516)
@@ -1,17 +1,15 @@
 <?php
 
-    /**
-     * @package object
-     */
-
-
     include_once( PLOG_CLASS_PATH."class/object/object.class.php" );
 
     /**
+	 * \ingroup Core
+	 *
      * <b>Very</b> modest attempt to recreate some kind of Reflection API
      * "a la" Java.
      */
-    class Reflection extends Object {
+    class Reflection extends Object 
+	{
 
         /**
          * Constructor. Does nothing.