[Solar-svn] Revision 2886

[pmjones at solarphp.com]

updated comments



Modified: trunk/Solar/Controller/Command.php
===================================================================
--- trunk/Solar/Controller/Command.php	2007-10-17 13:47:09 UTC (rev 2885)
+++ trunk/Solar/Controller/Command.php	2007-10-18 13:07:06 UTC (rev 2886)
@@ -112,8 +112,22 @@
      */
     protected $_console;
     
+    /**
+     * 
+     * File handle pointing to STDOUT for normal output.
+     * 
+     * @var resource
+     * 
+     */
     protected $_stdout;
     
+    /**
+     * 
+     * File handle pointing to STDERR for error output.
+     * 
+     * @var resource
+     * 
+     */
     protected $_stderr;
     
     /**
@@ -140,6 +154,13 @@
         $this->_setup();
     }
     
+    /**
+     * 
+     * Destructor; closes STDOUT and STDERR file handles.
+     * 
+     * @return void
+     * 
+     */
     public function __destruct()
     {
         fclose($this->_stdout);

Modified: trunk/Solar/Dir.php
===================================================================
--- trunk/Solar/Dir.php	2007-10-17 13:47:09 UTC (rev 2885)
+++ trunk/Solar/Dir.php	2007-10-18 13:07:06 UTC (rev 2886)
@@ -1,4 +1,29 @@
 <?php
+/**
+ * 
+ * Utility class for static directory methods.
+ * 
+ * @category Solar
+ * 
+ * @package Solar_Dir
+ * 
+ * @author Paul M. Jones <pmjones at solarphp.com>
+ * 
+ * @license http://opensource.org/licenses/bsd-license.php BSD
+ * 
+ * @version $Id$
+ * 
+ */
+
+/**
+ * 
+ * Utility class for static directory methods.
+ * 
+ * @category Solar
+ * 
+ * @package Solar_Dir
+ * 
+ */
 class Solar_Dir {
     
     /**
@@ -107,6 +132,9 @@
      * 
      * Returns the OS-specific directory for temporary files.
      * 
+     * @param string $sub Add this subdirectory to the returned temporary
+     * directory name.
+     * 
      * @return string The temporary directory path.
      * 
      */

Modified: trunk/Solar/File.php
===================================================================
--- trunk/Solar/File.php	2007-10-17 13:47:09 UTC (rev 2885)
+++ trunk/Solar/File.php	2007-10-18 13:07:06 UTC (rev 2886)
@@ -1,6 +1,40 @@
 <?php
+/**
+ * 
+ * Utility class for static file methods.
+ * 
+ * @category Solar
+ * 
+ * @package Solar_File
+ * 
+ * @author Paul M. Jones <pmjones at solarphp.com>
+ * 
+ * @license http://opensource.org/licenses/bsd-license.php BSD
+ * 
+ * @version $Id$
+ * 
+ */
+
+/**
+ * 
+ * Utility class for static file methods.
+ * 
+ * @category Solar
+ * 
+ * @package Solar_File
+ * 
+ */
 class Solar_File {
     
+    /**
+     * 
+     * The path of the file currently being used by Solar_File::load().
+     * 
+     * @var string
+     * 
+     * @see load()
+     * 
+     */
     protected static $_file;
     
     /**
@@ -54,13 +88,13 @@
     
     /**
      * 
-     * Returns the OS-specific directory for temporary files, optionally with
-     * a path added to it.
+     * Returns the OS-specific directory for temporary files, with a file
+     * name appended.
      * 
-     * @param string $add Add this to the end of the temporary directory
+     * @param string $file The file name to append to the temporary directory
      * path.
      * 
-     * @return string The temp directory path, with optional suffix added.
+     * @return string The temp directory and file name.
      * 
      */
     public static function tmp($file)

Modified: trunk/Solar/Registry.php
===================================================================
--- trunk/Solar/Registry.php	2007-10-17 13:47:09 UTC (rev 2885)
+++ trunk/Solar/Registry.php	2007-10-18 13:07:06 UTC (rev 2886)
@@ -1,4 +1,29 @@
 <?php
+/**
+ * 
+ * Registry for storing objects, with built-in lazy loading.
+ * 
+ * @category Solar
+ * 
+ * @package Solar_Registry
+ * 
+ * @author Paul M. Jones <pmjones at solarphp.com>
+ * 
+ * @license http://opensource.org/licenses/bsd-license.php BSD
+ * 
+ * @version $Id$
+ * 
+ */
+
+/**
+ * 
+ * Registry for storing objects, with built-in lazy loading.
+ * 
+ * @category Solar
+ * 
+ * @package Solar_Registry
+ * 
+ */
 class Solar_Registry {
     
     /**
@@ -6,7 +31,7 @@
      * Map of registry names to object instances (or their specs for on-demand 
      * creation).
      * 
-     * @param array
+     * @var array
      * 
      */
     protected static $_obj = array();