[Solar-svn] Revision 2848

[pmjones at solarphp.com]

updated comments


Modified: trunk/Solar/Form.php
===================================================================
--- trunk/Solar/Form.php	2007-10-07 22:14:20 UTC (rev 2847)
+++ trunk/Solar/Form.php	2007-10-07 22:23:26 UTC (rev 2848)
@@ -388,6 +388,8 @@
      * Solar_Filter method name (string), or an array where the first element
      * is a method name and remaining elements are parameters to that method.
      * 
+     * @param string $array Rename the element as a key in this array.
+     * 
      * @return void
      * 
      */
@@ -411,11 +413,9 @@
      * 
      * @param string $name The element name.
      * 
-     * @param array|string $spec The filter specification; either a
-     * Solar_Filter method name (string), or an array where the first element
-     * is a method name and remaining elements are parameters to that method.
+     * @param array|string $list The list of filters for this element.
      * 
-     * @param string $array Rename each element as a key in this array.
+     * @param string $array Rename the element as a key in this array.
      * 
      * @return void
      * 

Modified: trunk/Solar/Getopt.php
===================================================================
--- trunk/Solar/Getopt.php	2007-10-07 22:14:20 UTC (rev 2847)
+++ trunk/Solar/Getopt.php	2007-10-07 22:23:26 UTC (rev 2848)
@@ -76,6 +76,8 @@
      * instead, use [[Solar_Getopt::setOption()]] and/or
      * [[Solar_Getopt::setOptions()]].
      * 
+     * @var array
+     * 
      */
     public $options = array();
     

Modified: trunk/Solar/Sql/Adapter.php
===================================================================
--- trunk/Solar/Sql/Adapter.php	2007-10-07 22:14:20 UTC (rev 2847)
+++ trunk/Solar/Sql/Adapter.php	2007-10-07 22:23:26 UTC (rev 2848)
@@ -22,8 +22,8 @@
  * When writing an adapter, you need to override these abstract methods:
  * 
  * {{code: php
- *     abstract public function fetchTableList();
- *     abstract public function fetchTableCols($table);
+ *     abstract protected function _fetchTableList();
+ *     abstract protected function _fetchTableCols($table);
  *     abstract protected function _createSequence($name, $start = 1);
  *     abstract protected function _dropSequence($name);
  *     abstract protected function _nextSequence($name);
@@ -84,8 +84,22 @@
         'cache'     => array('adapter' => 'Solar_Cache_Adapter_Var'),
     );
     
+    /**
+     * 
+     * A cache object for keeping query results.
+     * 
+     * @var Solar_Cache_Adapter
+     * 
+     */
     protected $_cache;
     
+    /**
+     * 
+     * Prefix all cache keys with this string.
+     * 
+     * @var string
+     * 
+     */
     protected $_cache_key_prefix;
     
     /**
@@ -383,7 +397,7 @@
      * 
      * Gets a full cache key.
      * 
-     * @var string $key The partial cache key.
+     * @param string $key The partial cache key.
      * 
      * @return string The full cache key.
      * 
@@ -1297,7 +1311,8 @@
     
     /**
      * 
-     * Returns a list of database tables.
+     * Returns a list of database tables from the cache; if the cache entry
+     * is not available, queries the database for the list of tables.
      * 
      * @return array A sequential array of table names in the database.
      * 
@@ -1313,11 +1328,20 @@
         return $result;
     }
     
+    /**
+     * 
+     * Returns a list of database tables.
+     * 
+     * @return array A sequential array of table names in the database.
+     * 
+     */
     abstract protected function _fetchTableList();
     
     /**
      * 
-     * Returns an array describing the columns in a table.
+     * Returns an array describing table columns from the cache; if the cache
+     * entry is not available, queries the database for the column
+     * descriptions.
      * 
      * @param string $table The table name to fetch columns for.
      * 
@@ -1335,6 +1359,15 @@
         return $result;
     }
     
+    /**
+     * 
+     * Returns an array describing the columns in a table.
+     * 
+     * @param string $table The table name to fetch columns for.
+     * 
+     * @return array An array of table columns.
+     * 
+     */
     abstract protected function _fetchTableCols($table);
     
     /**