From 2fc4b766f4422f6a58c0a535fadf99096e7a9ddd Mon Sep 17 00:00:00 2001
From: Silvio <silvio@devlet.com.br>
Date: Tue, 30 Mar 2010 15:41:42 -0300
Subject: Adding doxygen

---
 interface.php | 33 ++++++++++++++++++++++++++-------
 1 file changed, 26 insertions(+), 7 deletions(-)

(limited to 'interface.php')

diff --git a/interface.php b/interface.php
index 5ba5a55..f5802d7 100644
--- a/interface.php
+++ b/interface.php
@@ -1,21 +1,40 @@
 <?php
-/**
- * Database procedures.
- */
 
 /**
  * Generic interface for reading Isis databases.
  */
 interface IsisDb {
-  // Constructor.
+  /**
+   * Constructor.
+   *
+   * @param $schema
+   *   High level database schema description.
+   *
+   * @see default_schema()
+   */
   public function __construct($schema);
 
-  // Read an entry.
+  /**
+   * Read an entry.
+   *
+   * @param $id
+   *   Database row id.
+   */
   public function read($id);
 
-  // Return number of rows in the database.
+  /**
+   * Return number of rows in the database.
+   *
+   * @return
+   *   Number of rows in the database.
+   */
   public function rows();
 
-  // Return a default example schema.
+  /**
+   * Return a default example schema.
+   *
+   * @return
+   *   Array with a sample database schema.
+   */
   public function default_schema();
 }
-- 
cgit v1.2.3