[Tikiwiki-cvs/svn] SF.net SVN: tikiwiki:[44416] users/kstingel/PHPdocProj/db

[<kst...@us...>]

Revision: 44416
          http://sourceforge.net/p/tikiwiki/code/44416
Author:   kstingel
Date:     2013-01-02 21:48:41 +0000 (Wed, 02 Jan 2013)
Log Message:
-----------
[REF] converted initial comment block (Id line left as comment) to PageLevel DocBlock ready for API Doc generation, added missing DocBlocks for functions

Modified Paths:
--------------
    users/kstingel/PHPdocProj/db/tiki-db-adodb.php
    users/kstingel/PHPdocProj/db/tiki-db-pdo.php
    users/kstingel/PHPdocProj/db/tiki-db.php

Modified: users/kstingel/PHPdocProj/db/tiki-db-adodb.php
===================================================================
--- users/kstingel/PHPdocProj/db/tiki-db-adodb.php	2013-01-02 20:55:55 UTC (rev 44415)
+++ users/kstingel/PHPdocProj/db/tiki-db-adodb.php	2013-01-02 21:48:41 UTC (rev 44416)
@@ -61,6 +61,9 @@
 }
 
 if ( ! function_exists('close_connection') ) {
+	/** 
+	 * close the DB connection 
+	 */
 	function close_connection()
 	{
 		global $dbTiki;

Modified: users/kstingel/PHPdocProj/db/tiki-db-pdo.php
===================================================================
--- users/kstingel/PHPdocProj/db/tiki-db-pdo.php	2013-01-02 20:55:55 UTC (rev 44415)
+++ users/kstingel/PHPdocProj/db/tiki-db-pdo.php	2013-01-02 21:48:41 UTC (rev 44416)
@@ -84,6 +84,9 @@
 }
 
 if ( ! function_exists('close_connection') ) {
+	/** 
+	 * close the DB connection 
+	 */
 	function close_connection()
 	{
 		global $dbTiki;

Modified: users/kstingel/PHPdocProj/db/tiki-db.php
===================================================================
--- users/kstingel/PHPdocProj/db/tiki-db.php	2013-01-02 20:55:55 UTC (rev 44415)
+++ users/kstingel/PHPdocProj/db/tiki-db.php	2013-01-02 21:48:41 UTC (rev 44416)
@@ -145,11 +145,13 @@
 }
 
 /**
- *
+ * handles DB errors in Tiki
  */
 class TikiDb_LegacyErrorHandler implements TikiDb_ErrorHandler
 {
     /**
+     * function to handle the errors
+     * 
      * @param TikiDb $db
      * @param $query
      * @param $values
@@ -176,6 +178,8 @@
 
 		if (function_exists('xdebug_get_function_stack')) {
             /**
+             * outputs the stack trace so we can locate the error
+             * 
              * @param $stack
              * @return string
              */
@@ -211,6 +215,8 @@
 		die;
 	} // }}}
     /**
+     * adds $msg to the log records
+     * 
      * @param $msg
      */
     function log($msg)
@@ -250,6 +256,7 @@
 unset($host_map, $db_tiki, $host_tiki, $user_tiki, $pass_tiki, $dbs_tiki, $shadow_user, $shadow_pass, $shadow_host, $shadow_dbs);
 
 /**
+ * initializes the connection to Tiki's Database
  * @param $db
  */
 function init_connection( $db )

This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.