From bece6cec9869c8a3c79d7fd38a419816d2de92cb Mon Sep 17 00:00:00 2001
From: steinm <steinm@577cc39b-cfd1-4aa2-8bc3-eda205cea05a>
Date: Fri, 28 Jan 2011 07:31:25 +0000
Subject: [PATCH] - added better documentation

---
 LetoDMS_Core/inc.DBAccess.php | 25 +++++++++++++++++++------
 1 file changed, 19 insertions(+), 6 deletions(-)

diff --git a/LetoDMS_Core/inc.DBAccess.php b/LetoDMS_Core/inc.DBAccess.php
index d113de652..af7600579 100644
--- a/LetoDMS_Core/inc.DBAccess.php
+++ b/LetoDMS_Core/inc.DBAccess.php
@@ -42,17 +42,30 @@ class LetoDMS_Core_DatabaseAccess {
 	/*
 	Backup functions
 	*/
-	
-	function TableList()
-	{
+
+	/**
+	 * Return list of all database tables
+	 *
+	 * This function is used to retrieve a list of database tables for backup
+	 *
+	 * @return array list of table names
+	 */
+	function TableList() {
 		return $this->_conn->MetaTables("TABLES");
 	}	
 
 	/**
-	 * Konstruktor
+	 * Constructor of LetoDMS_Core_DatabaseAccess
+	 *
+	 * Sets all database parameters but does not connect.
+	 *
+	 * @param string $driver the database type e.g. mysql, sqlite
+	 * @param string $hostname host of database server
+	 * @param string $user name of user having access to database
+	 * @param string $passw password of user
+	 * @param string $database name of database
 	 */
-	function LetoDMS_Core_DatabaseAccess($driver, $hostname, $user, $passw, $database = false)
-	{
+	function LetoDMS_Core_DatabaseAccess($driver, $hostname, $user, $passw, $database = false) {
 		$this->_driver = $driver;
 		$this->_hostname = $hostname;
 		$this->_database = $database;