Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/matomo-org/matomo.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authormatt <matt@59fd770c-687e-43c8-a1e3-f5a4ff64c105>2008-01-14 08:26:43 +0300
committermatt <matt@59fd770c-687e-43c8-a1e3-f5a4ff64c105>2008-01-14 08:26:43 +0300
commita0726311e5ef66ef4b686f344e2fa1d56ced82d0 (patch)
treecfe15fe197686f21b70b841786f337152e1bac05
parent1bbcfd98ba9b84173d79f35bc1c035c8c79dff63 (diff)
Added phpdoc package
-rwxr-xr-xmodules/API/APIable.php2
-rw-r--r--modules/API/Request.php3
-rwxr-xr-xmodules/Access.php3
-rw-r--r--modules/Archive.php2
-rw-r--r--modules/ArchiveProcessing.php2
-rw-r--r--modules/ArchiveProcessing/Day.php2
-rw-r--r--modules/ArchiveProcessing/Period.php2
-rw-r--r--modules/ArchiveProcessing/Record.php2
-rw-r--r--modules/Auth.php2
-rw-r--r--modules/Common.php6
-rwxr-xr-xmodules/Config.php14
-rw-r--r--modules/Controller.php2
-rw-r--r--modules/Cookie.php6
-rw-r--r--modules/DataFiles/Countries.php3
-rw-r--r--modules/DataFiles/SearchEngines.php3
-rw-r--r--modules/DataTable.php2
-rw-r--r--modules/DataTable/Filter.php2
-rw-r--r--modules/DataTable/Filter/AddConstantDetail.php2
-rw-r--r--modules/DataTable/Filter/ColumnCallbackAddDetail.php2
-rw-r--r--modules/DataTable/Filter/ColumnCallbackReplace.php2
-rw-r--r--modules/DataTable/Filter/DetailCallbackAddDetail.php2
-rw-r--r--modules/DataTable/Filter/Empty.php2
-rw-r--r--modules/DataTable/Filter/ExcludeLowPopulation.php2
-rw-r--r--modules/DataTable/Filter/Limit.php2
-rw-r--r--modules/DataTable/Filter/Pattern.php2
-rw-r--r--modules/DataTable/Filter/PatternRecursive.php2
-rw-r--r--modules/DataTable/Filter/ReplaceColumnNames.php2
-rw-r--r--modules/DataTable/Filter/Sort.php2
-rw-r--r--modules/DataTable/Manager.php2
-rw-r--r--modules/DataTable/Renderer.php7
-rw-r--r--modules/DataTable/Renderer/Console.php2
-rw-r--r--modules/DataTable/Renderer/Csv.php29
-rw-r--r--modules/DataTable/Renderer/Html.php2
-rw-r--r--modules/DataTable/Renderer/Json.php4
-rw-r--r--modules/DataTable/Renderer/Php.php2
-rw-r--r--modules/DataTable/Renderer/Xml.php4
-rw-r--r--modules/DataTable/Row.php7
-rw-r--r--modules/DataTable/Row/DataTableSummary.php2
-rw-r--r--modules/DataTable/Simple.php2
-rw-r--r--modules/Date.php7
-rwxr-xr-xmodules/ErrorHandler.php7
-rw-r--r--modules/ExceptionHandler.php7
-rw-r--r--modules/Form.php8
-rw-r--r--modules/FrontController.php9
-rwxr-xr-xmodules/Log.php2
-rw-r--r--modules/Log/APICall.php4
-rw-r--r--modules/Log/Error.php4
-rw-r--r--modules/Log/Exception.php4
-rw-r--r--modules/Log/Message.php4
-rw-r--r--modules/LogStats.php2
-rw-r--r--modules/LogStats/Action.php2
-rw-r--r--modules/LogStats/Config.php2
-rw-r--r--modules/LogStats/Db.php2
-rw-r--r--modules/LogStats/Generator.php2
-rw-r--r--modules/LogStats/Visit.php2
-rw-r--r--modules/Period.php7
-rwxr-xr-xmodules/Piwik.php14
-rw-r--r--modules/Plugin.php2
-rw-r--r--modules/PluginsManager.php52
-rw-r--r--modules/Site.php2
-rw-r--r--modules/SmartyPlugins/function.url.php8
-rw-r--r--modules/SmartyPlugins/modifier.sumtime.php8
-rw-r--r--modules/TablePartitioning.php2
-rw-r--r--modules/Timer.php6
-rw-r--r--modules/Translate.php2
-rw-r--r--modules/Url.php6
-rw-r--r--modules/View.php10
-rw-r--r--modules/ViewDataTable.php7
-rw-r--r--modules/ViewDataTable/Cloud.php10
-rw-r--r--modules/ViewDataTable/GenerateGraphData.php9
-rw-r--r--modules/ViewDataTable/Graph.php9
-rw-r--r--modules/ViewDataTable/Html.php9
-rw-r--r--modules/Visualization/Chart.php7
-rw-r--r--modules/Visualization/ChartPie.php9
-rw-r--r--modules/Visualization/ChartVerticalBar.php9
-rw-r--r--modules/Visualization/Cloud.php10
-rw-r--r--modules/Visualization/OpenFlashChart.php11
-rw-r--r--modules/iView.php6
-rw-r--r--plugins/Actions.php2
-rw-r--r--plugins/Actions/API.php2
-rw-r--r--plugins/ExamplePlugin.php2
-rw-r--r--plugins/ExamplePlugin/API.php2
-rw-r--r--plugins/ExamplePlugin/Controller.php2
-rw-r--r--plugins/Installation.php2
-rw-r--r--plugins/Installation/Controller.php2
-rw-r--r--plugins/Installation/FormDatabaseSetup.php2
-rw-r--r--plugins/Installation/FormFirstWebsiteSetup.php2
-rw-r--r--plugins/Installation/FormGeneralSetup.php2
-rw-r--r--plugins/Installation/View.php2
-rw-r--r--plugins/Login.php2
-rw-r--r--plugins/Login/Controller.php2
-rw-r--r--plugins/Login/Form.php2
-rw-r--r--plugins/Logout/Controller.php2
-rw-r--r--plugins/Openads.php2
-rw-r--r--plugins/Openads/Controller.php2
-rw-r--r--plugins/Provider.php2
-rw-r--r--plugins/Provider/API.php2
-rw-r--r--plugins/Referers.php2
-rw-r--r--plugins/Referers/API.php2
-rw-r--r--plugins/SitesManager.php2
-rwxr-xr-xplugins/SitesManager/API.php2
-rw-r--r--plugins/SitesManager/Controller.php2
-rw-r--r--plugins/UserCountry.php2
-rw-r--r--plugins/UserCountry/API.php2
-rw-r--r--plugins/UserSettings.php2
-rw-r--r--plugins/UserSettings/API.php1
-rw-r--r--plugins/UsersManager.php2
-rwxr-xr-xplugins/UsersManager/API.php2
-rw-r--r--plugins/UsersManager/Controller.php2
-rw-r--r--plugins/VisitFrequency.php2
-rw-r--r--plugins/VisitFrequency/API.php2
-rw-r--r--plugins/VisitTime.php3
-rw-r--r--plugins/VisitTime/API.php2
-rw-r--r--plugins/VisitorInterest.php2
-rw-r--r--plugins/VisitorInterest/API.php2
-rw-r--r--plugins/VisitsSummary.php2
-rw-r--r--plugins/VisitsSummary/API.php2
117 files changed, 405 insertions, 99 deletions
diff --git a/modules/API/APIable.php b/modules/API/APIable.php
index 84ecf37ef5..8f1d2f9ac5 100755
--- a/modules/API/APIable.php
+++ b/modules/API/APIable.php
@@ -5,6 +5,8 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_API
*/
diff --git a/modules/API/Request.php b/modules/API/Request.php
index 0aee9243ea..9299f40484 100644
--- a/modules/API/Request.php
+++ b/modules/API/Request.php
@@ -5,6 +5,9 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ *
+ * @package Piwik_API
*/
diff --git a/modules/Access.php b/modules/Access.php
index eeef448a24..ad98e6488c 100755
--- a/modules/Access.php
+++ b/modules/Access.php
@@ -5,6 +5,9 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik
+ *
*/
/**
diff --git a/modules/Archive.php b/modules/Archive.php
index 5064529717..8e11f08d31 100644
--- a/modules/Archive.php
+++ b/modules/Archive.php
@@ -5,6 +5,8 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik
*/
/**
diff --git a/modules/ArchiveProcessing.php b/modules/ArchiveProcessing.php
index b3dd29fc46..f6ead37292 100644
--- a/modules/ArchiveProcessing.php
+++ b/modules/ArchiveProcessing.php
@@ -5,6 +5,8 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_ArchiveProcessing
*/
/**
diff --git a/modules/ArchiveProcessing/Day.php b/modules/ArchiveProcessing/Day.php
index 1b65e92e18..c8bad37d64 100644
--- a/modules/ArchiveProcessing/Day.php
+++ b/modules/ArchiveProcessing/Day.php
@@ -5,6 +5,8 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_ArchiveProcessing
*/
diff --git a/modules/ArchiveProcessing/Period.php b/modules/ArchiveProcessing/Period.php
index 2c12506983..6ca529023b 100644
--- a/modules/ArchiveProcessing/Period.php
+++ b/modules/ArchiveProcessing/Period.php
@@ -5,6 +5,8 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_ArchiveProcessing
*/
/**
diff --git a/modules/ArchiveProcessing/Record.php b/modules/ArchiveProcessing/Record.php
index 4d1bb7db74..695d1e3f44 100644
--- a/modules/ArchiveProcessing/Record.php
+++ b/modules/ArchiveProcessing/Record.php
@@ -5,6 +5,8 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_ArchiveProcessing
*/
/**
diff --git a/modules/Auth.php b/modules/Auth.php
index d575ddfc61..713421b258 100644
--- a/modules/Auth.php
+++ b/modules/Auth.php
@@ -5,6 +5,8 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik
*/
/**
diff --git a/modules/Common.php b/modules/Common.php
index f28b2b3741..0b1b1327ec 100644
--- a/modules/Common.php
+++ b/modules/Common.php
@@ -5,6 +5,8 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_Helper
*/
/**
@@ -14,8 +16,8 @@
* This is the only external class loaded by the Piwik.php file.
* This class should contain only the functions that are used in
* both the CORE and the piwik.php statistics logging engine.
- *
- * @package Piwik
+ *
+ * @package Piwik_Helper
*/
class Piwik_Common
{
diff --git a/modules/Config.php b/modules/Config.php
index 31c76e69aa..84ffaa1442 100755
--- a/modules/Config.php
+++ b/modules/Config.php
@@ -5,15 +5,17 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_Helper
*/
-
-/**
- *
- * @package Piwik
- */
+
require_once "Zend/Config/Ini.php";
require_once "Zend/Registry.php";
-
+
+/**
+ *
+ * @package Piwik_Helper
+ */
class Piwik_Config
{
protected $urlToPiwikHelpMissingValueInConfigurationFile =
diff --git a/modules/Controller.php b/modules/Controller.php
index 834ee83de8..49d94804b8 100644
--- a/modules/Controller.php
+++ b/modules/Controller.php
@@ -5,6 +5,8 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik
*/
abstract class Piwik_Controller
diff --git a/modules/Cookie.php b/modules/Cookie.php
index 1b6ea351e1..b5cdcbed4e 100644
--- a/modules/Cookie.php
+++ b/modules/Cookie.php
@@ -5,6 +5,8 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_Helper
*/
@@ -17,8 +19,8 @@
* - create a new cookie, set values, expiration date, etc. and save it
*
* The cookie content is saved in an optimized way.
- *
- * @package Piwik_LogStats
+ *
+ * @package Piwik_Helper
*/
class Piwik_Cookie
{
diff --git a/modules/DataFiles/Countries.php b/modules/DataFiles/Countries.php
index f2fe9ea3a8..8573c21b7f 100644
--- a/modules/DataFiles/Countries.php
+++ b/modules/DataFiles/Countries.php
@@ -5,12 +5,13 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_UserCountry
*/
/**
* Country code and continent database
*
- * @package Piwik_DataFiles
*/
if(!isset($GLOBALS['Piwik_CountryList']))
{
diff --git a/modules/DataFiles/SearchEngines.php b/modules/DataFiles/SearchEngines.php
index 72ce063eb3..5ed15b8062 100644
--- a/modules/DataFiles/SearchEngines.php
+++ b/modules/DataFiles/SearchEngines.php
@@ -5,6 +5,8 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_Referers
*/
/**
@@ -21,7 +23,6 @@
*
* Post your new search engines and logos in the forum, thank you for your help!
*
- * @package Piwik_DataFiles
*/
if(!isset($GLOBALS['Piwik_SearchEngines'] ))
{
diff --git a/modules/DataTable.php b/modules/DataTable.php
index 5e2632f776..438365f292 100644
--- a/modules/DataTable.php
+++ b/modules/DataTable.php
@@ -5,6 +5,8 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_DataTable
*/
/**
diff --git a/modules/DataTable/Filter.php b/modules/DataTable/Filter.php
index 1355141258..7b29212dcd 100644
--- a/modules/DataTable/Filter.php
+++ b/modules/DataTable/Filter.php
@@ -5,6 +5,8 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_DataTable
*/
/**
diff --git a/modules/DataTable/Filter/AddConstantDetail.php b/modules/DataTable/Filter/AddConstantDetail.php
index 6c36ae662c..59798544b1 100644
--- a/modules/DataTable/Filter/AddConstantDetail.php
+++ b/modules/DataTable/Filter/AddConstantDetail.php
@@ -5,6 +5,8 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_DataTable
*/
/**
diff --git a/modules/DataTable/Filter/ColumnCallbackAddDetail.php b/modules/DataTable/Filter/ColumnCallbackAddDetail.php
index 70db6c7039..f2d13cd12f 100644
--- a/modules/DataTable/Filter/ColumnCallbackAddDetail.php
+++ b/modules/DataTable/Filter/ColumnCallbackAddDetail.php
@@ -5,6 +5,8 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_DataTable
*/
diff --git a/modules/DataTable/Filter/ColumnCallbackReplace.php b/modules/DataTable/Filter/ColumnCallbackReplace.php
index 7bdea900f9..d15dc72b1c 100644
--- a/modules/DataTable/Filter/ColumnCallbackReplace.php
+++ b/modules/DataTable/Filter/ColumnCallbackReplace.php
@@ -5,6 +5,8 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_DataTable
*/
/**
diff --git a/modules/DataTable/Filter/DetailCallbackAddDetail.php b/modules/DataTable/Filter/DetailCallbackAddDetail.php
index 81666d4a76..1d6e469b45 100644
--- a/modules/DataTable/Filter/DetailCallbackAddDetail.php
+++ b/modules/DataTable/Filter/DetailCallbackAddDetail.php
@@ -5,6 +5,8 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_DataTable
*/
/**
diff --git a/modules/DataTable/Filter/Empty.php b/modules/DataTable/Filter/Empty.php
index c79f9719ae..fef4022775 100644
--- a/modules/DataTable/Filter/Empty.php
+++ b/modules/DataTable/Filter/Empty.php
@@ -5,6 +5,8 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_DataTable
*/
/**
diff --git a/modules/DataTable/Filter/ExcludeLowPopulation.php b/modules/DataTable/Filter/ExcludeLowPopulation.php
index a73b550443..fd7dd97dce 100644
--- a/modules/DataTable/Filter/ExcludeLowPopulation.php
+++ b/modules/DataTable/Filter/ExcludeLowPopulation.php
@@ -5,6 +5,8 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_DataTable
*/
/**
diff --git a/modules/DataTable/Filter/Limit.php b/modules/DataTable/Filter/Limit.php
index dd6261df6a..c5231f5644 100644
--- a/modules/DataTable/Filter/Limit.php
+++ b/modules/DataTable/Filter/Limit.php
@@ -5,6 +5,8 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_DataTable
*/
/**
diff --git a/modules/DataTable/Filter/Pattern.php b/modules/DataTable/Filter/Pattern.php
index ea61e47b10..eebf03665d 100644
--- a/modules/DataTable/Filter/Pattern.php
+++ b/modules/DataTable/Filter/Pattern.php
@@ -5,6 +5,8 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_DataTable
*/
/**
diff --git a/modules/DataTable/Filter/PatternRecursive.php b/modules/DataTable/Filter/PatternRecursive.php
index 15fd7a245d..fcd39aab9f 100644
--- a/modules/DataTable/Filter/PatternRecursive.php
+++ b/modules/DataTable/Filter/PatternRecursive.php
@@ -5,6 +5,8 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_DataTable
*/
/**
diff --git a/modules/DataTable/Filter/ReplaceColumnNames.php b/modules/DataTable/Filter/ReplaceColumnNames.php
index 236268f987..ae16a197fd 100644
--- a/modules/DataTable/Filter/ReplaceColumnNames.php
+++ b/modules/DataTable/Filter/ReplaceColumnNames.php
@@ -5,6 +5,8 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_DataTable
*/
/**
diff --git a/modules/DataTable/Filter/Sort.php b/modules/DataTable/Filter/Sort.php
index 63c4eb61e2..67c4df7b4c 100644
--- a/modules/DataTable/Filter/Sort.php
+++ b/modules/DataTable/Filter/Sort.php
@@ -5,6 +5,8 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_DataTable
*/
/**
diff --git a/modules/DataTable/Manager.php b/modules/DataTable/Manager.php
index db86979daa..c89ad9609e 100644
--- a/modules/DataTable/Manager.php
+++ b/modules/DataTable/Manager.php
@@ -5,6 +5,8 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_DataTable
*/
/**
diff --git a/modules/DataTable/Renderer.php b/modules/DataTable/Renderer.php
index a1ef210284..28752c76d4 100644
--- a/modules/DataTable/Renderer.php
+++ b/modules/DataTable/Renderer.php
@@ -5,13 +5,16 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_DataTable
*/
/**
* A DataTable Renderer can produce an output given a DataTable object.
* All new Renderers must be copied in DataTable/Renderer and added to the factory() method.
- *
- * @package Piwik_DataTable
+ *
+ * @package Piwik_DataTable
+ * @subpackage Piwik_DataTable_Renderer
*/
abstract class Piwik_DataTable_Renderer
{
diff --git a/modules/DataTable/Renderer/Console.php b/modules/DataTable/Renderer/Console.php
index 8a3c8d1a3c..cd30000a1b 100644
--- a/modules/DataTable/Renderer/Console.php
+++ b/modules/DataTable/Renderer/Console.php
@@ -5,6 +5,8 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_DataTable
*/
/**
diff --git a/modules/DataTable/Renderer/Csv.php b/modules/DataTable/Renderer/Csv.php
index fda6cb3384..066c091133 100644
--- a/modules/DataTable/Renderer/Csv.php
+++ b/modules/DataTable/Renderer/Csv.php
@@ -5,26 +5,27 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_DataTable
*/
+require_once "DataTable/Renderer/Php.php";
/**
* CSV export
+ *
+ * When rendered using the default settings, a CSV report has the following characteristics:
+ * The first record contains headers for all the columns in the report.
+ * All rows have the same number of columns.
+ * The default field delimiter string is a comma (,).
+ * The record delimiter string is the carriage return and line feed (<cr><lf>).
+ * The text qualifier string is a quotation mark (").
+ * If the text contains an embedded delimiter string or qualifier string, the text qualifier is placed around the text, and the embedded qualifier strings are doubled.
+ * Formatting and layout are ignored.
*
* @package Piwik_DataTable
- * @subpackage Piwik_DataTable_Renderer
- */
-
- /**
- * When rendered using the default settings, a CSV report has the following characteristics:
- * The first record contains headers for all the columns in the report.
- * All rows have the same number of columns.
- * The default field delimiter string is a comma (,).
- * The record delimiter string is the carriage return and line feed (<cr><lf>).
- * The text qualifier string is a quotation mark (").
- * If the text contains an embedded delimiter string or qualifier string, the text qualifier is placed around the text, and the embedded qualifier strings are doubled.
- * Formatting and layout are ignored.
- */
-require_once "DataTable/Renderer/Php.php";
+ * @subpackage Piwik_DataTable_Renderer
+ *
+ */
class Piwik_DataTable_Renderer_Csv extends Piwik_DataTable_Renderer
{
diff --git a/modules/DataTable/Renderer/Html.php b/modules/DataTable/Renderer/Html.php
index 27e7f6e409..5e0c076161 100644
--- a/modules/DataTable/Renderer/Html.php
+++ b/modules/DataTable/Renderer/Html.php
@@ -5,6 +5,8 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_DataTable
*/
/**
diff --git a/modules/DataTable/Renderer/Json.php b/modules/DataTable/Renderer/Json.php
index df89b8166e..f2eca8f001 100644
--- a/modules/DataTable/Renderer/Json.php
+++ b/modules/DataTable/Renderer/Json.php
@@ -5,15 +5,17 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_DataTable
*/
+require_once "DataTable/Renderer/Php.php";
/**
* JSON export. Using the php 5.2 feature json_encode
*
* @package Piwik_DataTable
* @subpackage Piwik_DataTable_Renderer
*/
-require_once "DataTable/Renderer/Php.php";
class Piwik_DataTable_Renderer_Json extends Piwik_DataTable_Renderer
{
function __construct($table = null)
diff --git a/modules/DataTable/Renderer/Php.php b/modules/DataTable/Renderer/Php.php
index 1f49770ba5..6b32eea379 100644
--- a/modules/DataTable/Renderer/Php.php
+++ b/modules/DataTable/Renderer/Php.php
@@ -5,6 +5,8 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_DataTable
*/
/**
diff --git a/modules/DataTable/Renderer/Xml.php b/modules/DataTable/Renderer/Xml.php
index aa88c9688f..36100897fd 100644
--- a/modules/DataTable/Renderer/Xml.php
+++ b/modules/DataTable/Renderer/Xml.php
@@ -5,8 +5,11 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_DataTable
*/
+require_once "DataTable/Renderer/Php.php";
/**
* XML export. Using the excellent Pear::XML_Serializer.
* We had to fix the PEAR library so that it works under PHP5 STRICT mode.
@@ -14,7 +17,6 @@
* @package Piwik_DataTable
* @subpackage Piwik_DataTable_Renderer
*/
-require_once "DataTable/Renderer/Php.php";
class Piwik_DataTable_Renderer_Xml extends Piwik_DataTable_Renderer
{
function __construct($table = null)
diff --git a/modules/DataTable/Row.php b/modules/DataTable/Row.php
index 370faf43f3..06415b95e8 100644
--- a/modules/DataTable/Row.php
+++ b/modules/DataTable/Row.php
@@ -5,6 +5,8 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_DataTable
*/
/**
@@ -18,8 +20,9 @@
* IMPORTANT: Make sure that the column named 'label' contains at least one non-numeric character.
* Otherwise the method addDataTable() or sumRow() would fail because they would consider
* the 'label' as being a numeric column to sum.
- *
- * @package Piwik_DataTable
+ *
+ * @package Piwik_DataTable
+ * @subpackage Piwik_DataTable_Row
*
*/
class Piwik_DataTable_Row
diff --git a/modules/DataTable/Row/DataTableSummary.php b/modules/DataTable/Row/DataTableSummary.php
index 36a7f7092f..7d60bed0fd 100644
--- a/modules/DataTable/Row/DataTableSummary.php
+++ b/modules/DataTable/Row/DataTableSummary.php
@@ -5,6 +5,8 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_DataTable
*/
/**
diff --git a/modules/DataTable/Simple.php b/modules/DataTable/Simple.php
index 8f570d592c..cdb1c14032 100644
--- a/modules/DataTable/Simple.php
+++ b/modules/DataTable/Simple.php
@@ -5,6 +5,8 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_DataTable
*/
/**
diff --git a/modules/Date.php b/modules/Date.php
index bb3590a4a1..f06559429a 100644
--- a/modules/Date.php
+++ b/modules/Date.php
@@ -5,11 +5,14 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_Helper
*/
/**
- *
- * @package Piwik
+ *
+ *
+ * @package Piwik_Helper
*/
class Piwik_Date
{
diff --git a/modules/ErrorHandler.php b/modules/ErrorHandler.php
index e6839eca21..d8b52f060d 100755
--- a/modules/ErrorHandler.php
+++ b/modules/ErrorHandler.php
@@ -5,11 +5,14 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_Helper
*/
/**
- *
- * @package Piwik
+ *
+ *
+ * @package Piwik_Helper
*/
require_once "Zend/Registry.php";
function Piwik_ErrorHandler($errno, $errstr, $errfile, $errline)
diff --git a/modules/ExceptionHandler.php b/modules/ExceptionHandler.php
index 46709713f5..593a16dbef 100644
--- a/modules/ExceptionHandler.php
+++ b/modules/ExceptionHandler.php
@@ -5,11 +5,14 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_Helper
*/
/**
- *
- * @package Piwik
+ *
+ *
+ * @package Piwik_Helper
*/
function Piwik_ExceptionHandler(Exception $exception)
{
diff --git a/modules/Form.php b/modules/Form.php
index 111aab7dc6..4d5e3ae371 100644
--- a/modules/Form.php
+++ b/modules/Form.php
@@ -5,12 +5,18 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_Helper
*/
require_once "HTML/QuickForm.php";
require_once "HTML/QuickForm/Renderer/ArraySmarty.php";
-
+
+/**
+ *
+ * @package Piwik_Helper
+ */
abstract class Piwik_Form extends HTML_QuickForm
{
private $a_formElements = array();
diff --git a/modules/FrontController.php b/modules/FrontController.php
index 211d7bc20f..ec59a4dc1c 100644
--- a/modules/FrontController.php
+++ b/modules/FrontController.php
@@ -5,6 +5,8 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik
*/
@@ -32,7 +34,12 @@ require_once "Site.php";
require_once "Translate.php";
require_once "Url.php";
require_once "Controller.php";
-
+
+/**
+ *
+ *
+ * @package Piwik
+ */
class Piwik_FrontController
{
static public $enableDispatch = true;
diff --git a/modules/Log.php b/modules/Log.php
index f7f3afef2e..c3327c8e15 100755
--- a/modules/Log.php
+++ b/modules/Log.php
@@ -5,6 +5,8 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_Log
*/
/**
diff --git a/modules/Log/APICall.php b/modules/Log/APICall.php
index e87355ae35..8ca7e5115a 100644
--- a/modules/Log/APICall.php
+++ b/modules/Log/APICall.php
@@ -5,13 +5,15 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_Log
+ * @subpackage Piwik_Log_APICall
*/
/**
* Class used to log all the API Calls information (class / method / parameters / returned value / time spent)
*
* @package Piwik_Log
- * @subpackage Piwik_Log_APICall
*/
class Piwik_Log_APICall extends Piwik_Log
{
diff --git a/modules/Log/Error.php b/modules/Log/Error.php
index 02392f2a11..57712ee4b9 100644
--- a/modules/Log/Error.php
+++ b/modules/Log/Error.php
@@ -5,13 +5,15 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_Log
+ * @subpackage Piwik_Log_Error
*/
/**
* Class used to log an error event.
*
* @package Piwik_Log
- * @subpackage Piwik_Log_Error
*/
class Piwik_Log_Error extends Piwik_Log
{
diff --git a/modules/Log/Exception.php b/modules/Log/Exception.php
index bb71d66c1d..c65484cd0e 100644
--- a/modules/Log/Exception.php
+++ b/modules/Log/Exception.php
@@ -5,13 +5,15 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_Log
+ * @subpackage Piwik_Log_Exception
*/
/**
* Class used to log an exception event.
*
* @package Piwik_Log
- * @subpackage Piwik_Log_Exception
*/
class Piwik_Log_Exception extends Piwik_Log
{
diff --git a/modules/Log/Message.php b/modules/Log/Message.php
index fad546c668..87ce18db0c 100644
--- a/modules/Log/Message.php
+++ b/modules/Log/Message.php
@@ -5,13 +5,15 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_Log
+ * @subpackage Piwik_Log_Message
*/
/**
* Class used to log a standard message event.
*
* @package Piwik_Log
- * @subpackage Piwik_Log_Message
*/
class Piwik_Log_Message extends Piwik_Log
{
diff --git a/modules/LogStats.php b/modules/LogStats.php
index 9e68ba3462..3d995ac890 100644
--- a/modules/LogStats.php
+++ b/modules/LogStats.php
@@ -5,6 +5,8 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_LogStats
*/
/**
diff --git a/modules/LogStats/Action.php b/modules/LogStats/Action.php
index 4fdcc296b0..cb42c733ec 100644
--- a/modules/LogStats/Action.php
+++ b/modules/LogStats/Action.php
@@ -5,6 +5,8 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_LogStats
*/
diff --git a/modules/LogStats/Config.php b/modules/LogStats/Config.php
index 4a1270cc8e..bac16e7cd4 100644
--- a/modules/LogStats/Config.php
+++ b/modules/LogStats/Config.php
@@ -5,6 +5,8 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_LogStats
*/
/**
diff --git a/modules/LogStats/Db.php b/modules/LogStats/Db.php
index 2f671a3749..2604fc1923 100644
--- a/modules/LogStats/Db.php
+++ b/modules/LogStats/Db.php
@@ -5,6 +5,8 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_LogStats
*/
/**
diff --git a/modules/LogStats/Generator.php b/modules/LogStats/Generator.php
index 4c0a10994b..18008c05f0 100644
--- a/modules/LogStats/Generator.php
+++ b/modules/LogStats/Generator.php
@@ -5,6 +5,8 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_LogStats
*/
/**
diff --git a/modules/LogStats/Visit.php b/modules/LogStats/Visit.php
index da541ddf12..9439be4f32 100644
--- a/modules/LogStats/Visit.php
+++ b/modules/LogStats/Visit.php
@@ -5,6 +5,8 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_LogStats
*/
/**
diff --git a/modules/Period.php b/modules/Period.php
index 3cdd7f918a..d928a26ff5 100644
--- a/modules/Period.php
+++ b/modules/Period.php
@@ -5,6 +5,8 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_Helper
*/
/**
@@ -17,8 +19,9 @@
* }
* that checks whether the subperiods have already been computed.
* This is for performance improvements, computing the subperiods is done a per demand basis.
- *
- * @package Piwik
+ *
+ *
+ * @package Piwik_Helper
*/
abstract class Piwik_Period
{
diff --git a/modules/Piwik.php b/modules/Piwik.php
index aa95424be7..8fbbfbf66f 100755
--- a/modules/Piwik.php
+++ b/modules/Piwik.php
@@ -5,18 +5,20 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik
*/
-
-/**
- *
- * @package Piwik
- */
+
require_once "Config.php";
require_once "Zend/Db.php";
require_once "Zend/Db/Table.php";
require_once "Log.php";
require_once "PluginsManager.php";
-
+
+/**
+ *
+ * @package Piwik
+ */
class Piwik
{
const CLASSES_PREFIX = "Piwik_";
diff --git a/modules/Plugin.php b/modules/Plugin.php
index 2ac36dc37d..2d65794598 100644
--- a/modules/Plugin.php
+++ b/modules/Plugin.php
@@ -5,6 +5,8 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik
*/
diff --git a/modules/PluginsManager.php b/modules/PluginsManager.php
index fa41d73442..9196a45719 100644
--- a/modules/PluginsManager.php
+++ b/modules/PluginsManager.php
@@ -5,36 +5,38 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik
*/
-/**
- * Plugin specification for a statistics logging plugin
- *
- * A plugin that display data in the Piwik Interface is very different from a plugin
- * that will save additional data in the database during the statistics logging.
- * These two types of plugins don't have the same requirements at all. Therefore a plugin
- * that saves additional data in the database during the stats logging process will have a different
- * structure.
- *
- * A plugin for logging data has to focus on performance and therefore has to stay as simple as possible.
- * For input data, it is strongly advised to use the Piwik methods available in Piwik_Common
- *
- * Things that can be done with such a plugin:
- * - having a dependency with a list of other plugins
- * - have an install step that would prepare the plugin environment
- * - install could add columns to the tables
- * - install could create tables
- * - register to hooks at several points in the logging process
- * - register to hooks in other plugins
- * - generally a plugin method can modify data (filter) and add/remove data
- *
- *
- * @package Piwik
- */
require_once "Plugin.php";
require_once "Event/Dispatcher.php";
-
+
+/**
+ * Plugin specification for a statistics logging plugin
+ *
+ * A plugin that display data in the Piwik Interface is very different from a plugin
+ * that will save additional data in the database during the statistics logging.
+ * These two types of plugins don't have the same requirements at all. Therefore a plugin
+ * that saves additional data in the database during the stats logging process will have a different
+ * structure.
+ *
+ * A plugin for logging data has to focus on performance and therefore has to stay as simple as possible.
+ * For input data, it is strongly advised to use the Piwik methods available in Piwik_Common
+ *
+ * Things that can be done with such a plugin:
+ * - having a dependency with a list of other plugins
+ * - have an install step that would prepare the plugin environment
+ * - install could add columns to the tables
+ * - install could create tables
+ * - register to hooks at several points in the logging process
+ * - register to hooks in other plugins
+ * - generally a plugin method can modify data (filter) and add/remove data
+ *
+ *
+ * @package Piwik
+ */
class Piwik_PluginsManager
{
public $dispatcher;
diff --git a/modules/Site.php b/modules/Site.php
index 306488440f..c4c52bfa92 100644
--- a/modules/Site.php
+++ b/modules/Site.php
@@ -5,6 +5,8 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik
*/
/**
diff --git a/modules/SmartyPlugins/function.url.php b/modules/SmartyPlugins/function.url.php
index d8363d4c06..73094f2a41 100644
--- a/modules/SmartyPlugins/function.url.php
+++ b/modules/SmartyPlugins/function.url.php
@@ -5,12 +5,10 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_Visualization
*/
-
-/**
- * Smarty plugin
- * @package Smarty
- */
+
require_once "Url.php";
/**
diff --git a/modules/SmartyPlugins/modifier.sumtime.php b/modules/SmartyPlugins/modifier.sumtime.php
index c15986dd3c..648afa221e 100644
--- a/modules/SmartyPlugins/modifier.sumtime.php
+++ b/modules/SmartyPlugins/modifier.sumtime.php
@@ -5,13 +5,9 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_Visualization
*/
-
-/**
- * Smarty plugin
- * @package Smarty
- * @subpackage plugins
- */
/**
* Returns a string stating the number of days and hours from a number of seconds
diff --git a/modules/TablePartitioning.php b/modules/TablePartitioning.php
index d019a3daa6..9e9860d648 100644
--- a/modules/TablePartitioning.php
+++ b/modules/TablePartitioning.php
@@ -5,6 +5,8 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik
*/
/**
diff --git a/modules/Timer.php b/modules/Timer.php
index 39a0c3177e..03339b3acd 100644
--- a/modules/Timer.php
+++ b/modules/Timer.php
@@ -5,11 +5,13 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_Helper
*/
/**
- *
- * @package Piwik
+ *
+ * @package Piwik_Helper
*/
class Piwik_Timer
{
diff --git a/modules/Translate.php b/modules/Translate.php
index fca5c08825..d44119cbf8 100644
--- a/modules/Translate.php
+++ b/modules/Translate.php
@@ -5,6 +5,8 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik
*/
/**
diff --git a/modules/Url.php b/modules/Url.php
index bd7869439a..b396bd7435 100644
--- a/modules/Url.php
+++ b/modules/Url.php
@@ -5,8 +5,14 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_Helper
*/
+/**
+ * @package Piwik_Helper
+ *
+ */
class Piwik_Url
{
static function getArrayFromCurrentQueryString()
diff --git a/modules/View.php b/modules/View.php
index d8b6ee2ee6..4dccc2bce2 100644
--- a/modules/View.php
+++ b/modules/View.php
@@ -5,11 +5,19 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_Visualization
*/
require_once 'Smarty/Smarty.class.php';
-require_once "iView.php";
+require_once "iView.php";
+
+/**
+ *
+ * @package Piwik_Visualization
+ *
+ */
class Piwik_View implements Piwik_iView
{
private $template = '';
diff --git a/modules/ViewDataTable.php b/modules/ViewDataTable.php
index d813c096a0..41e7ef64ce 100644
--- a/modules/ViewDataTable.php
+++ b/modules/ViewDataTable.php
@@ -5,8 +5,15 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_ViewDataTable
*/
+/**
+ *
+ * @package Piwik_Visualization
+ *
+ */
abstract class Piwik_ViewDataTable
{
protected $dataTableTemplate = null;
diff --git a/modules/ViewDataTable/Cloud.php b/modules/ViewDataTable/Cloud.php
index db753ad00a..f3a876bc16 100644
--- a/modules/ViewDataTable/Cloud.php
+++ b/modules/ViewDataTable/Cloud.php
@@ -5,9 +5,17 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_ViewDataTable
*/
-require_once "Visualization/Cloud.php";
+require_once "Visualization/Cloud.php";
+
+/**
+ *
+ * @package Piwik_ViewDataTable
+ *
+ */
class Piwik_ViewDataTable_Cloud extends Piwik_ViewDataTable
{
protected $displayLogoInsteadOfLabel = false;
diff --git a/modules/ViewDataTable/GenerateGraphData.php b/modules/ViewDataTable/GenerateGraphData.php
index ed63da1f37..591e5df1db 100644
--- a/modules/ViewDataTable/GenerateGraphData.php
+++ b/modules/ViewDataTable/GenerateGraphData.php
@@ -5,8 +5,15 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_ViewDataTable
*/
-
+
+/**
+ *
+ * @package Piwik_ViewDataTable
+ *
+ */
abstract class Piwik_ViewDataTable_GenerateGraphData extends Piwik_ViewDataTable
{
diff --git a/modules/ViewDataTable/Graph.php b/modules/ViewDataTable/Graph.php
index 64fdd243ed..1c5472aa21 100644
--- a/modules/ViewDataTable/Graph.php
+++ b/modules/ViewDataTable/Graph.php
@@ -5,8 +5,15 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_ViewDataTable
*/
-
+
+/**
+ *
+ * @package Piwik_ViewDataTable
+ *
+ */
abstract class Piwik_ViewDataTable_Graph extends Piwik_ViewDataTable
{
function init($currentControllerAction,
diff --git a/modules/ViewDataTable/Html.php b/modules/ViewDataTable/Html.php
index 540f4aea60..fc340f54a2 100644
--- a/modules/ViewDataTable/Html.php
+++ b/modules/ViewDataTable/Html.php
@@ -5,8 +5,15 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_ViewDataTable
*/
-
+
+/**
+ *
+ * @package Piwik_ViewDataTable
+ *
+ */
class Piwik_ViewDataTable_Html extends Piwik_ViewDataTable
{
protected $columnsToDisplay = array();
diff --git a/modules/Visualization/Chart.php b/modules/Visualization/Chart.php
index 67d491e2e4..4e246df0e9 100644
--- a/modules/Visualization/Chart.php
+++ b/modules/Visualization/Chart.php
@@ -5,9 +5,16 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_Visualization
*/
require_once "Visualization/OpenFlashChart.php";
+
+/**
+ *
+ * @package Piwik_Visualization
+ */
abstract class Piwik_Visualization_Chart extends Piwik_Visualization_OpenFlashChart
{
function setData($data)
diff --git a/modules/Visualization/ChartPie.php b/modules/Visualization/ChartPie.php
index 6a19345507..b65a325c95 100644
--- a/modules/Visualization/ChartPie.php
+++ b/modules/Visualization/ChartPie.php
@@ -5,8 +5,15 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_Visualization
*/
-require_once "Visualization/Chart.php";
+require_once "Visualization/Chart.php";
+
+/**
+ *
+ * @package Piwik_Visualization
+ */
class Piwik_Visualization_ChartPie extends Piwik_Visualization_Chart
{
function customizeGraph()
diff --git a/modules/Visualization/ChartVerticalBar.php b/modules/Visualization/ChartVerticalBar.php
index 52701a5cbf..84c6416abd 100644
--- a/modules/Visualization/ChartVerticalBar.php
+++ b/modules/Visualization/ChartVerticalBar.php
@@ -5,8 +5,17 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_Visualization
*/
+
require_once "Visualization/Chart.php";
+
+/**
+ *
+ * @package Piwik_Visualization
+ *
+ */
class Piwik_Visualization_ChartVerticalBar extends Piwik_Visualization_Chart
{
protected $limit = 10;
diff --git a/modules/Visualization/Cloud.php b/modules/Visualization/Cloud.php
index fb1deeda79..dff6719c74 100644
--- a/modules/Visualization/Cloud.php
+++ b/modules/Visualization/Cloud.php
@@ -5,8 +5,16 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_Visualization
*/
-// inspired from Derek Harvey (www.derekharvey.co.uk)
+
+// inspired from Derek Harvey (www.derekharvey.co.uk)
+
+/**
+ *
+ * @package Piwik_Visualization
+ */
class Piwik_Visualization_Cloud
{
protected $wordsArray = array();
diff --git a/modules/Visualization/OpenFlashChart.php b/modules/Visualization/OpenFlashChart.php
index 54c9da1e6f..f2214502d1 100644
--- a/modules/Visualization/OpenFlashChart.php
+++ b/modules/Visualization/OpenFlashChart.php
@@ -5,9 +5,18 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_Visualization
*/
+
require_once "iView.php";
-// Original class provided by Open Flash Chart
+
+/**
+ * Original class provided by Open Flash Chart
+ *
+ * @package Piwik_Visualization
+ */
+
abstract class Piwik_Visualization_OpenFlashChart implements iView
{
function __construct()
diff --git a/modules/iView.php b/modules/iView.php
index db5778f2fc..c014a2d90e 100644
--- a/modules/iView.php
+++ b/modules/iView.php
@@ -5,8 +5,14 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id: APIable.php 162 2008-01-14 04:27:21Z matt $
+ *
+ * @package Piwik_Visualization
*/
+/**
+ *
+ * @package Piwik_Visualization
+ */
interface Piwik_iView
{
function render();
diff --git a/plugins/Actions.php b/plugins/Actions.php
index 4fd90577d8..fbaab00759 100644
--- a/plugins/Actions.php
+++ b/plugins/Actions.php
@@ -5,6 +5,8 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_Actions
*/
class Piwik_Actions extends Piwik_Plugin
diff --git a/plugins/Actions/API.php b/plugins/Actions/API.php
index 45baaf5eaa..7dad7d2548 100644
--- a/plugins/Actions/API.php
+++ b/plugins/Actions/API.php
@@ -5,6 +5,8 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_Actions
*/
diff --git a/plugins/ExamplePlugin.php b/plugins/ExamplePlugin.php
index f44014eeaf..8836adb999 100644
--- a/plugins/ExamplePlugin.php
+++ b/plugins/ExamplePlugin.php
@@ -5,6 +5,8 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_ExamplePlugin
*/
class Piwik_ExamplePlugin extends Piwik_Plugin
diff --git a/plugins/ExamplePlugin/API.php b/plugins/ExamplePlugin/API.php
index b1d11736e4..2cbd9595f8 100644
--- a/plugins/ExamplePlugin/API.php
+++ b/plugins/ExamplePlugin/API.php
@@ -5,6 +5,8 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_ExamplePlugin
*/
class MagicObject
diff --git a/plugins/ExamplePlugin/Controller.php b/plugins/ExamplePlugin/Controller.php
index d20b0387b3..6fe8719fbd 100644
--- a/plugins/ExamplePlugin/Controller.php
+++ b/plugins/ExamplePlugin/Controller.php
@@ -5,6 +5,8 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_ExamplePlugin
*/
diff --git a/plugins/Installation.php b/plugins/Installation.php
index 4ac17ac0c2..0a61ab2486 100644
--- a/plugins/Installation.php
+++ b/plugins/Installation.php
@@ -5,6 +5,8 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_Installation
*/
diff --git a/plugins/Installation/Controller.php b/plugins/Installation/Controller.php
index aa323c17a8..46d9ee16f6 100644
--- a/plugins/Installation/Controller.php
+++ b/plugins/Installation/Controller.php
@@ -5,6 +5,8 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_Installation
*/
require_once "View.php";
diff --git a/plugins/Installation/FormDatabaseSetup.php b/plugins/Installation/FormDatabaseSetup.php
index 95ed887ec3..0634326ca3 100644
--- a/plugins/Installation/FormDatabaseSetup.php
+++ b/plugins/Installation/FormDatabaseSetup.php
@@ -5,6 +5,8 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_Installation
*/
require_once "modules/Form.php";
diff --git a/plugins/Installation/FormFirstWebsiteSetup.php b/plugins/Installation/FormFirstWebsiteSetup.php
index 5f25100318..08242bfc7a 100644
--- a/plugins/Installation/FormFirstWebsiteSetup.php
+++ b/plugins/Installation/FormFirstWebsiteSetup.php
@@ -5,6 +5,8 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_Installation
*/
require_once "modules/Form.php";
diff --git a/plugins/Installation/FormGeneralSetup.php b/plugins/Installation/FormGeneralSetup.php
index cd2c407f17..599fad4b47 100644
--- a/plugins/Installation/FormGeneralSetup.php
+++ b/plugins/Installation/FormGeneralSetup.php
@@ -5,6 +5,8 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_Installation
*/
require_once "modules/Form.php";
diff --git a/plugins/Installation/View.php b/plugins/Installation/View.php
index acbd338d05..854ce525ab 100644
--- a/plugins/Installation/View.php
+++ b/plugins/Installation/View.php
@@ -5,6 +5,8 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_Installation
*/
class Piwik_Install_View extends Piwik_View
diff --git a/plugins/Login.php b/plugins/Login.php
index 425cdd5340..9a986afd23 100644
--- a/plugins/Login.php
+++ b/plugins/Login.php
@@ -5,6 +5,8 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_Login
*/
require "Login/Controller.php";
require "Cookie.php";
diff --git a/plugins/Login/Controller.php b/plugins/Login/Controller.php
index ec70cf34f7..321f9e27af 100644
--- a/plugins/Login/Controller.php
+++ b/plugins/Login/Controller.php
@@ -5,6 +5,8 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_Login
*/
require_once "UsersManager/API.php";
diff --git a/plugins/Login/Form.php b/plugins/Login/Form.php
index 566cfa2c4e..6d3379174a 100644
--- a/plugins/Login/Form.php
+++ b/plugins/Login/Form.php
@@ -5,6 +5,8 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_Login
*/
require_once "modules/Form.php";
diff --git a/plugins/Logout/Controller.php b/plugins/Logout/Controller.php
index 3739330cb3..619d0ea001 100644
--- a/plugins/Logout/Controller.php
+++ b/plugins/Logout/Controller.php
@@ -5,6 +5,8 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_Logout
*/
class Piwik_Logout_Controller extends Piwik_Controller
diff --git a/plugins/Openads.php b/plugins/Openads.php
index fded77674f..ba8ba08d1c 100644
--- a/plugins/Openads.php
+++ b/plugins/Openads.php
@@ -5,6 +5,8 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_Openads
*/
class Piwik_Openads extends Piwik_Plugin
diff --git a/plugins/Openads/Controller.php b/plugins/Openads/Controller.php
index f55b48f655..29dc6fe219 100644
--- a/plugins/Openads/Controller.php
+++ b/plugins/Openads/Controller.php
@@ -5,6 +5,8 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_Openads
*/
class Piwik_Openads_Controller extends Piwik_Installation_Controller
diff --git a/plugins/Provider.php b/plugins/Provider.php
index 7069e2d249..396665a84c 100644
--- a/plugins/Provider.php
+++ b/plugins/Provider.php
@@ -5,6 +5,8 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_Provider
*/
class Piwik_Provider extends Piwik_Plugin
diff --git a/plugins/Provider/API.php b/plugins/Provider/API.php
index 23586be808..fa8d5e3471 100644
--- a/plugins/Provider/API.php
+++ b/plugins/Provider/API.php
@@ -5,6 +5,8 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_Provider
*/
diff --git a/plugins/Referers.php b/plugins/Referers.php
index 97f318d877..60b7f6a1d2 100644
--- a/plugins/Referers.php
+++ b/plugins/Referers.php
@@ -5,6 +5,8 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_Referers
*/
class Piwik_Referers extends Piwik_Plugin
diff --git a/plugins/Referers/API.php b/plugins/Referers/API.php
index 00b1dfc225..55cc147417 100644
--- a/plugins/Referers/API.php
+++ b/plugins/Referers/API.php
@@ -5,6 +5,8 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_Referers
*/
diff --git a/plugins/SitesManager.php b/plugins/SitesManager.php
index d2b23f93b2..54fd549e3d 100644
--- a/plugins/SitesManager.php
+++ b/plugins/SitesManager.php
@@ -5,6 +5,8 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_SitesManager
*/
class Piwik_SitesManager extends Piwik_Plugin
diff --git a/plugins/SitesManager/API.php b/plugins/SitesManager/API.php
index ae445adc1b..1ad9b22185 100755
--- a/plugins/SitesManager/API.php
+++ b/plugins/SitesManager/API.php
@@ -5,6 +5,8 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_SitesManager
*/
/**
diff --git a/plugins/SitesManager/Controller.php b/plugins/SitesManager/Controller.php
index 0410a4657c..0907559721 100644
--- a/plugins/SitesManager/Controller.php
+++ b/plugins/SitesManager/Controller.php
@@ -5,6 +5,8 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_SitesManager
*/
class Piwik_SitesManager_Controller extends Piwik_Controller
diff --git a/plugins/UserCountry.php b/plugins/UserCountry.php
index a8b6e617e3..a7d02c50ce 100644
--- a/plugins/UserCountry.php
+++ b/plugins/UserCountry.php
@@ -5,6 +5,8 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_UserCountry
*/
class Piwik_UserCountry extends Piwik_Plugin
diff --git a/plugins/UserCountry/API.php b/plugins/UserCountry/API.php
index e17e027689..51fe5f9ad8 100644
--- a/plugins/UserCountry/API.php
+++ b/plugins/UserCountry/API.php
@@ -5,6 +5,8 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_UserCountry
*/
diff --git a/plugins/UserSettings.php b/plugins/UserSettings.php
index 255c4988f7..ef03dba1ec 100644
--- a/plugins/UserSettings.php
+++ b/plugins/UserSettings.php
@@ -5,6 +5,8 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_UserSettings
*/
class Piwik_UserSettings extends Piwik_Plugin
diff --git a/plugins/UserSettings/API.php b/plugins/UserSettings/API.php
index 37dfae3e4e..10c6524d7a 100644
--- a/plugins/UserSettings/API.php
+++ b/plugins/UserSettings/API.php
@@ -6,7 +6,6 @@
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
*
- *
* @package Piwik_UserSettings
*/
diff --git a/plugins/UsersManager.php b/plugins/UsersManager.php
index c1e8e5d7c0..44e91d60da 100644
--- a/plugins/UsersManager.php
+++ b/plugins/UsersManager.php
@@ -5,6 +5,8 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_UsersManager
*/
class Piwik_UsersManager extends Piwik_Plugin
diff --git a/plugins/UsersManager/API.php b/plugins/UsersManager/API.php
index 131d180618..2300457fa5 100755
--- a/plugins/UsersManager/API.php
+++ b/plugins/UsersManager/API.php
@@ -5,6 +5,8 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_UsersManager
*/
/**
diff --git a/plugins/UsersManager/Controller.php b/plugins/UsersManager/Controller.php
index 70be63aab9..552b7c89e4 100644
--- a/plugins/UsersManager/Controller.php
+++ b/plugins/UsersManager/Controller.php
@@ -5,6 +5,8 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_UsersManager
*/
class Piwik_UsersManager_Controller extends Piwik_Controller
diff --git a/plugins/VisitFrequency.php b/plugins/VisitFrequency.php
index bdf1fe38c7..fcfbd686f8 100644
--- a/plugins/VisitFrequency.php
+++ b/plugins/VisitFrequency.php
@@ -5,6 +5,8 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_VisitFrequency
*/
class Piwik_VisitFrequency extends Piwik_Plugin
diff --git a/plugins/VisitFrequency/API.php b/plugins/VisitFrequency/API.php
index 02baa9eb7e..8ba7d76a3d 100644
--- a/plugins/VisitFrequency/API.php
+++ b/plugins/VisitFrequency/API.php
@@ -5,6 +5,8 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_VisitFrequency
*/
class Piwik_VisitFrequency_API extends Piwik_Apiable
diff --git a/plugins/VisitTime.php b/plugins/VisitTime.php
index baab19e87c..d0afd32b41 100644
--- a/plugins/VisitTime.php
+++ b/plugins/VisitTime.php
@@ -5,6 +5,9 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ *
+ * @package Piwik_VisitTime
*/
class Piwik_VisitTime extends Piwik_Plugin
diff --git a/plugins/VisitTime/API.php b/plugins/VisitTime/API.php
index 73e39abf12..38d79c3ea7 100644
--- a/plugins/VisitTime/API.php
+++ b/plugins/VisitTime/API.php
@@ -5,6 +5,8 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_VisitTime
*/
class Piwik_VisitTime_API extends Piwik_Apiable
diff --git a/plugins/VisitorInterest.php b/plugins/VisitorInterest.php
index 1239c2269c..d0b0a36c7e 100644
--- a/plugins/VisitorInterest.php
+++ b/plugins/VisitorInterest.php
@@ -5,6 +5,8 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_VisitorInterest
*/
class Piwik_VisitorInterest extends Piwik_Plugin
diff --git a/plugins/VisitorInterest/API.php b/plugins/VisitorInterest/API.php
index de87f5fd80..534585bb13 100644
--- a/plugins/VisitorInterest/API.php
+++ b/plugins/VisitorInterest/API.php
@@ -5,6 +5,8 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_VisitorInterest
*/
diff --git a/plugins/VisitsSummary.php b/plugins/VisitsSummary.php
index 3b9b7fd85d..7ec5c0a57b 100644
--- a/plugins/VisitsSummary.php
+++ b/plugins/VisitsSummary.php
@@ -5,6 +5,8 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_VisitsSummary
*/
class Piwik_VisitsSummary extends Piwik_Plugin
diff --git a/plugins/VisitsSummary/API.php b/plugins/VisitsSummary/API.php
index 2594f5f694..d684b5bf1e 100644
--- a/plugins/VisitsSummary/API.php
+++ b/plugins/VisitsSummary/API.php
@@ -5,6 +5,8 @@
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
+ *
+ * @package Piwik_VisitsSummary
*/
class Piwik_VisitsSummary_API extends Piwik_Apiable