From b9c8bdc69608864b258630dd0a58312f70917d30 Mon Sep 17 00:00:00 2001
From: Silvio <silvio@devlet.com.br>
Date: Tue, 30 Mar 2010 16:47:56 -0300
Subject: Enhancing docs

---
 classes/MaleteDb.php  |  5 +++++
 classes/PhpIsisDb.php |  3 +++
 interface.php         | 11 ++++++++++-
 3 files changed, 18 insertions(+), 1 deletion(-)

diff --git a/classes/MaleteDb.php b/classes/MaleteDb.php
index d420af6..628fbe8 100644
--- a/classes/MaleteDb.php
+++ b/classes/MaleteDb.php
@@ -86,6 +86,11 @@ class MaleteDb implements IsisDb {
   /**
    * Tag results of a db query.
    *
+   * This function converts the keys of query result from field numbers
+   * to names and and also puts repetition fields into place as Malete
+   * deals with field repetition by using a 'tag' property in the resulting
+   * query object. 
+   *
    * @param $results
    *   Database query results.
    *
diff --git a/classes/PhpIsisDb.php b/classes/PhpIsisDb.php
index 78c9cf0..8dd57d0 100644
--- a/classes/PhpIsisDb.php
+++ b/classes/PhpIsisDb.php
@@ -70,6 +70,9 @@ class PhpIsisDb implements IsisDb {
   /**
    * Tag results of a db query.
    *
+   * This function converts the keys of query result from field
+   * numbers to names.
+   *   
    * @param $results
    *   Database query results.
    *
diff --git a/interface.php b/interface.php
index f5802d7..c2e1e9b 100644
--- a/interface.php
+++ b/interface.php
@@ -7,15 +7,21 @@ interface IsisDb {
   /**
    * Constructor.
    *
+   * The implementation constructor should accept a database
+   * schema definition and setup the appropriate db resource.
+   *
    * @param $schema
    *   High level database schema description.
    *
+   * @return
+   *   Database resource or FALSE in case of error.
+   *
    * @see default_schema()
    */
   public function __construct($schema);
 
   /**
-   * Read an entry.
+   * Read an entry from the database.
    *
    * @param $id
    *   Database row id.
@@ -33,6 +39,9 @@ interface IsisDb {
   /**
    * Return a default example schema.
    *
+   * The example schema should have all information the implementation
+   * needs to be able to open and read a database.
+   *
    * @return
    *   Array with a sample database schema.
    */
-- 
cgit v1.2.3