fixed doc blocks

12 files changed, 59 insertions, 4 deletions

diff --git a/core/Archive/DataCollection.php b/core/Archive/DataCollection.php
index 9cd96f3540..9103ae8ad6 100644
--- a/core/Archive/DataCollection.php
+++ b/core/Archive/DataCollection.php
@@ -228,7 +228,8 @@ class DataCollection
      *                             by the metadata specified here.
      *
      *                             Eg, array('site' => 'idSite', 'period' => 'Date')
-     * @param int $idSubTable The subtable to return.
+     * @param int|null $idSubTable The subtable to return.
+     * @param int|null $depth max depth for subtables.
      * @param bool $addMetadataSubTableId Whether to add the DB subtable ID as metadata
      *                                    to each datatable, or not.
      * @throws Exception
diff --git a/core/Archive/DataTableFactory.php b/core/Archive/DataTableFactory.php
index f45e1a3d58..6d6e170d7e 100644
--- a/core/Archive/DataTableFactory.php
+++ b/core/Archive/DataTableFactory.php
@@ -98,6 +98,7 @@ class DataTableFactory
      * Tells the factory instance to expand the DataTables that are created by
      * creating subtables and setting the subtable IDs of rows w/ subtables correctly.
      *
+     * @param null|int $maxSubtableDepth  max depth for subtables.
      * @param bool $addMetadataSubtableId Whether to add the subtable ID used in the
      *                                    database to the in-memory DataTables as
      *                                    metadata or not.
diff --git a/core/Config.php b/core/Config.php
index 40f032d851..ef3ad1dc8f 100644
--- a/core/Config.php
+++ b/core/Config.php
@@ -73,6 +73,9 @@ class Config
     protected $pathGlobal = null;
     protected $pathLocal = null;
 
+    /**
+     * Constructor
+     */
     protected function __construct()
     {
         $this->pathGlobal = self::getGlobalConfigPath();
diff --git a/core/DataAccess/LogAggregator.php b/core/DataAccess/LogAggregator.php
index b05bd327cb..afc262529f 100644
--- a/core/DataAccess/LogAggregator.php
+++ b/core/DataAccess/LogAggregator.php
@@ -66,6 +66,13 @@ class LogAggregator
     /** @var \Piwik\Segment */
     protected $segment;
 
+    /**
+     * Constructor
+     * @param Date $dateStart
+     * @param Date $dateEnd
+     * @param Site $site
+     * @param Segment $segment
+     */
     public function __construct(Date $dateStart, Date $dateEnd, Site $site, Segment $segment)
     {
         $this->dateStart = $dateStart;
diff --git a/core/DataTableVisualization.php b/core/DataTableVisualization.php
index e582284fb3..e0be29e8d1 100644
--- a/core/DataTableVisualization.php
+++ b/core/DataTableVisualization.php
@@ -115,8 +115,8 @@ abstract class DataTableVisualization
      * DataTableVisualization class and above.
      * 
      * @param string $klass The class name of the DataTableVisualization.
-     * @return array The list of parent classes in order from highest ancestor to
-     *               the descended class.
+     * @return DataTableVisualization[]  The list of parent classes in order from highest
+     *                                   ancestor to the descended class.
      */
     public static function getVisualizationClassLineage($klass)
     {
@@ -136,6 +136,8 @@ abstract class DataTableVisualization
      * @see self::getVisualizationClassLineage
      * 
      * @param string $klass The visualization class.
+     *
+     * @return DataTableVisualization[]
      */
     public static function getVisualizationIdsWithInheritance($klass)
     {
diff --git a/core/PluginsArchiver.php b/core/PluginsArchiver.php
index dd49ba37e7..475e4bb106 100644
--- a/core/PluginsArchiver.php
+++ b/core/PluginsArchiver.php
@@ -23,6 +23,10 @@ abstract class PluginsArchiver
 {
     protected $processor;
 
+    /**
+     * Constructor
+     * @param ArchiveProcessor $processing
+     */
     public function __construct(ArchiveProcessor $processing)
     {
         $this->maximumRows = Config::getInstance()->General['datatable_archiving_maximum_rows_standard'];
diff --git a/core/ScheduledTime/Daily.php b/core/ScheduledTime/Daily.php
index af6a6e4f4f..28505c616b 100644
--- a/core/ScheduledTime/Daily.php
+++ b/core/ScheduledTime/Daily.php
@@ -22,6 +22,10 @@ use Piwik\ScheduledTime;
  */
 class Daily extends ScheduledTime
 {
+    /**
+     * @see ScheduledTime::getRescheduledTime
+     * @return int
+     */
     public function getRescheduledTime()
     {
         $currentTime = $this->getTime();
@@ -41,6 +45,11 @@ class Daily extends ScheduledTime
         return $rescheduledTime;
     }
 
+    /**
+     * @see ScheduledTime::setDay
+     * @param int $_day
+     * @throws \Exception
+     */
     public function setDay($_day)
     {
         throw new Exception ("Method not supported");
diff --git a/core/ScheduledTime/Hourly.php b/core/ScheduledTime/Hourly.php
index 70a62bb757..4a88042834 100644
--- a/core/ScheduledTime/Hourly.php
+++ b/core/ScheduledTime/Hourly.php
@@ -22,6 +22,10 @@ use Piwik\ScheduledTime;
  */
 class Hourly extends ScheduledTime
 {
+    /**
+     * @see ScheduledTime::getRescheduledTime
+     * @return int
+     */
     public function getRescheduledTime()
     {
         $currentTime = $this->getTime();
@@ -37,11 +41,23 @@ class Hourly extends ScheduledTime
         return $rescheduledTime;
     }
 
+    /**
+     * @see ScheduledTime::setHour
+     * @param int $_hour
+     * @throws \Exception
+     * @return int
+     */
     public function setHour($_hour)
     {
         throw new Exception ("Method not supported");
     }
 
+    /**
+     * @see ScheduledTime::setDay
+     * @param int $_day
+     * @throws \Exception
+     * @return int
+     */
     public function setDay($_day)
     {
         throw new Exception ("Method not supported");
diff --git a/core/ScheduledTime/Weekly.php b/core/ScheduledTime/Weekly.php
index 40b348c153..8cad7961f6 100644
--- a/core/ScheduledTime/Weekly.php
+++ b/core/ScheduledTime/Weekly.php
@@ -23,6 +23,10 @@ use Piwik\ScheduledTime;
 class Weekly extends ScheduledTime
 {
 
+    /**
+     * @see ScheduledTime::getRescheduledTime
+     * @return int
+     */
     public function getRescheduledTime()
     {
         $currentTime = $this->getTime();
diff --git a/core/Tracker/GoalManager.php b/core/Tracker/GoalManager.php
index 2ede67fca2..7e36d61a72 100644
--- a/core/Tracker/GoalManager.php
+++ b/core/Tracker/GoalManager.php
@@ -57,6 +57,10 @@ class GoalManager
     protected $request;
     protected $orderId;
 
+    /**
+     * Constructor
+     * @param Request $request
+     */
     public function __construct(Request $request)
     {
         $this->request = $request;
diff --git a/core/Updater.php b/core/Updater.php
index 740bb2e031..db405da9e1 100644
--- a/core/Updater.php
+++ b/core/Updater.php
@@ -29,6 +29,9 @@ class Updater
     private $componentsToCheck = array();
     private $hasMajorDbUpdate = false;
 
+    /**
+     * Constructor
+     */
     public function __construct()
     {
         $this->pathUpdateFileCore = PIWIK_INCLUDE_PATH . '/core/Updates/';
diff --git a/core/ViewDataTable.php b/core/ViewDataTable.php
index 39fe5996dd..a4d2037183 100644
--- a/core/ViewDataTable.php
+++ b/core/ViewDataTable.php
@@ -395,13 +395,14 @@ class ViewDataTable
 
         return self::$reportPropertiesCache;
     }
-    
+
     /**
      * Sets a view property by name. This function handles special view properties
      * like 'translations' & 'related_reports' that store arrays.
      *
      * @param string $name
      * @param mixed $value For array properties, $value can be a comma separated string.
+     * @throws \Exception
      */
     private function setViewProperty($name, $value)
     {