anewt-developers team mailing list archive

[noreply@xxxxxxxxxxxxx]

------------------------------------------------------------
revno: 1809
committer: Wouter Bolsterlee <uws@xxxxxxxxx>
branch nick: anewt
timestamp: Fri 2010-11-05 14:41:47 +0100
message:
  [autorecord] Minor doc updates
modified:
  autorecord/autorecord.lib.php


--
lp:anewt
https://code.launchpad.net/~uws/anewt/anewt.uws

Your team Anewt developers is subscribed to branch lp:anewt.
To unsubscribe from this branch go to https://code.launchpad.net/~uws/anewt/anewt.uws/+edit-subscription

=== modified file 'autorecord/autorecord.lib.php'
--- autorecord/autorecord.lib.php	2010-10-02 13:12:10 +0000
+++ autorecord/autorecord.lib.php	2010-11-05 13:41:47 +0000
@@ -79,6 +79,8 @@
 	 * \param $class
 	 *   The name of the class to register as an active record class (without
 	 *   the trailing underscore)
+	 *
+	 * \return
 	 */
 	final public static function register($class)
 	{
@@ -290,6 +292,9 @@
 	 *
 	 * This is like db_columns_skip_on_insert() and db_columns_skip_on_update(),
 	 * but is taken into account for both \c INSERT and \c UPDATE queries.
+	 *
+	 * \return
+	 *   Array of column names
 	 */
 	public static function db_columns_skip_on_save()
 	{
@@ -301,6 +306,9 @@
 	 * when no values are given.
 	 *
 	 * The database is expected to fill a default value for these columns.
+	 *
+	 * \return
+	 *   Array of column names
 	 */
 	public static function db_columns_skip_on_insert()
 	{
@@ -312,6 +320,9 @@
 	 *
 	 * These are usually read-only values which don't need to get updated every
 	 * time.
+	 *
+	 * \return
+	 *   Array of column names
 	 */
 	public static function db_columns_skip_on_update()
 	{
@@ -340,6 +351,10 @@
 	 *
 	 * \see db_find_all_by_sql
 	 * \see db_find_one_by_sql
+	 *
+	 * \return
+	 *   Associative array with column names as keys, and \c ASC or \c DESC as
+	 *   values
 	 */
 	public static function db_columns_order_by()
 	{