code documentation

mvc specification
finished referer API implementation

4 files changed, 31 insertions, 3 deletions

diff --git a/modules/DataTable/Renderer/Console.php b/modules/DataTable/Renderer/Console.php
index 3375bb52fe..e6a4b82980 100644
--- a/modules/DataTable/Renderer/Console.php
+++ b/modules/DataTable/Renderer/Console.php
@@ -1,5 +1,10 @@
 <?php
-
+/**
+ * Simple output
+ * 
+ * @package Piwik_DataTable
+ * @subpackage Piwik_DataTable_Renderer
+ */
 class Piwik_DataTable_Renderer_Console extends Piwik_DataTable_Renderer
 {
 	protected $prefixRows;
@@ -65,4 +70,4 @@ class Piwik_DataTable_Renderer_Console extends Piwik_DataTable_Renderer
 	}	
 }
 
-?>
+
diff --git a/modules/DataTable/Renderer/HTML.php b/modules/DataTable/Renderer/HTML.php
index 0e27fc25bd..d948766710 100644
--- a/modules/DataTable/Renderer/HTML.php
+++ b/modules/DataTable/Renderer/HTML.php
@@ -1,5 +1,11 @@
 <?php
 
+/**
+ * Simple HTML output
+ * 
+ * @package Piwik_DataTable
+ * @subpackage Piwik_DataTable_Renderer
+ */
 class Piwik_DataTable_Renderer_HTML extends Piwik_DataTable_Renderer
 {
 	protected $prefixRows;
@@ -34,6 +40,7 @@ class Piwik_DataTable_Renderer_HTML extends Piwik_DataTable_Renderer
 		$allColumns = array();
 		foreach($table->getRows() as $row)
 		{
+			//TODO put that in a Simple_PHP filter that will make it easy as well to export in CSV
 			foreach($row->getColumns() as $column => $value)
 			{
 				$allColumns[$column] = true;
@@ -123,4 +130,5 @@ class Piwik_DataTable_Renderer_HTML extends Piwik_DataTable_Renderer
 	}	
 }
 
-?>
+
+
diff --git a/modules/DataTable/Renderer/PHP.php b/modules/DataTable/Renderer/PHP.php
index 228275fea0..3708431fe2 100644
--- a/modules/DataTable/Renderer/PHP.php
+++ b/modules/DataTable/Renderer/PHP.php
@@ -1,4 +1,12 @@
 <?php
+
+/**
+ * Returns the equivalent PHP array of the DataTable.
+ * You can specify in the constructor if you want the serialized version.
+ * 
+ * @package Piwik_DataTable
+ * @subpackage Piwik_DataTable_Renderer
+ */
 class Piwik_DataTable_Renderer_PHP extends Piwik_DataTable_Renderer
 {
 	protected $serialize;
diff --git a/modules/DataTable/Renderer/XML.php b/modules/DataTable/Renderer/XML.php
index 0d6ebef305..90f03f46af 100644
--- a/modules/DataTable/Renderer/XML.php
+++ b/modules/DataTable/Renderer/XML.php
@@ -1,5 +1,12 @@
 <?php
 
+/**
+ * XML export. Using the excellent Pear::XML_Serializer.
+ * We had to fix the PEAR library so that it works under PHP5 STRICT mode.
+ * 
+ * @package Piwik_DataTable
+ * @subpackage Piwik_DataTable_Renderer
+ */
 require_once "DataTable/Renderer/PHP.php";
 class Piwik_DataTable_Renderer_XML extends Piwik_DataTable_Renderer
 {