diff --git a/core/TaskScheduler.php b/core/TaskScheduler.php
index a606a359a51e421a7c60fc95523cb9713434b4fc..aa39e703de8aa4c74d56d1a6e889826482dc4016 100644
--- a/core/TaskScheduler.php
+++ b/core/TaskScheduler.php
@@ -110,10 +110,17 @@ class Piwik_TaskScheduler
return self::taskHasBeenScheduledOnce($taskName, $timetable) ? $timetable[$taskName] : false;
}
- /*
+ /**
+ * Checks if the task should be executed
+ *
* Task has to be executed if :
* - the task has already been scheduled once and the current system time is greater than the scheduled time.
- * - execution is forced, see $forceTaskExecution
+ * - execution is forced, see $forceTaskExecution
+ *
+ * @param string $taskName
+ * @param array $timetable
+ *
+ * @return boolean
*/
static private function taskShouldBeExecuted($taskName, $timetable)
{
@@ -124,10 +131,17 @@ class Piwik_TaskScheduler
return $forceTaskExecution || (self::taskHasBeenScheduledOnce($taskName, $timetable) && time() >= $timetable[$taskName]);
}
- /*
+ /**
+ * Checks if a task should be rescheduled
+ *
* Task has to be rescheduled if :
* - the task has to be executed
- * - the task has never been scheduled before
+ * - the task has never been scheduled before
+ *
+ * @param string $taskName
+ * @param array $timetable
+ *
+ * @return boolean
*/
static private function taskShouldBeRescheduled($taskName, $timetable)
{
diff --git a/core/Tracker.php b/core/Tracker.php
index ad846e6ed32c3518e45ee8d8a03b9653524b4424..c499872e4c94fb2e9b39e15d93248b9c7cc0378b 100644
--- a/core/Tracker.php
+++ b/core/Tracker.php
@@ -326,7 +326,7 @@ class Piwik_Tracker
static public $initTrackerMode = false;
- /*
+ /**
* Used to initialize core Piwik components on a piwik.php request
* Eg. when cache is missed and we will be calling some APIs to generate cache
*/
diff --git a/core/Tracker/VisitExcluded.php b/core/Tracker/VisitExcluded.php
index c94a9d9efe6ba1dcefead41ec25d019d7aa8a9d0..2e465c46219f571e172c1a9b6fe58277835ee468 100644
--- a/core/Tracker/VisitExcluded.php
+++ b/core/Tracker/VisitExcluded.php
@@ -117,10 +117,12 @@ class Piwik_Tracker_VisitExcluded
&& $_SERVER['HTTP_X_MOZ'] == "prefetch");
}
- /*
+ /**
* Live/Bing/MSN bot and Googlebot are evolving to detect cloaked websites.
* As a result, these sophisticated bots exhibit characteristics of
* browsers (cookies enabled, executing JavaScript, etc).
+ *
+ * @return boolean
*/
protected function isNonHumanBot()
{
diff --git a/plugins/CoreHome/Controller.php b/plugins/CoreHome/Controller.php
index fe9875c3d03d3b845e61933f407b71b9ba91a60a..4268411fb584b6d6c15c67edc373fa5931d18aca 100644
--- a/plugins/CoreHome/Controller.php
+++ b/plugins/CoreHome/Controller.php
@@ -92,7 +92,7 @@ class Piwik_CoreHome_Controller extends Piwik_Controller
echo $view->render();
}
- /*
+ /**
* This method is called when the asset manager is configured in merged mode.
* It returns the content of the css merged file.
*
@@ -104,7 +104,7 @@ class Piwik_CoreHome_Controller extends Piwik_Controller
Piwik::serveStaticFile($cssMergedFile, "text/css");
}
- /*
+ /**
* This method is called when the asset manager is configured in merged mode.
* It returns the content of the js merged file.
*
diff --git a/plugins/DevicesDetection/DevicesDetection.php b/plugins/DevicesDetection/DevicesDetection.php
index 2409c58fb2908ac1eda45a2eb592aa14c7534d9c..99e3da909fd79b878f72f1ad4bfcc1d0cfdb654a 100644
--- a/plugins/DevicesDetection/DevicesDetection.php
+++ b/plugins/DevicesDetection/DevicesDetection.php
@@ -30,7 +30,7 @@ class Piwik_DevicesDetection extends Piwik_Plugin
);
}
- /*
+ /**
* Defines API reports.
* Also used to define Widgets, and Segment(s)
*
diff --git a/plugins/DevicesDetection/UserAgentParserEnhanced/UserAgentParserEnhanced.php b/plugins/DevicesDetection/UserAgentParserEnhanced/UserAgentParserEnhanced.php
index 4847a59b2782273eb240ec2fbcd1e2f7e1ed1964..d078305d978d7e7ae0184d4d85e6d08be5c02f30 100644
--- a/plugins/DevicesDetection/UserAgentParserEnhanced/UserAgentParserEnhanced.php
+++ b/plugins/DevicesDetection/UserAgentParserEnhanced/UserAgentParserEnhanced.php
@@ -655,7 +655,7 @@ class UserAgentParserEnhanced
if (!isset($this->os[$attr])) {
return self::UNKNOWN;
}
-
+
return $this->os[$attr];
}
diff --git a/plugins/MobileMessaging/javascripts/MobileMessagingSettings.js b/plugins/MobileMessaging/javascripts/MobileMessagingSettings.js
index 207d4c725d8b5832196381badaf5a32c423fbe7a..17f4dcc8e3ac0285a466d490495364439c806a3f 100644
--- a/plugins/MobileMessaging/javascripts/MobileMessagingSettings.js
+++ b/plugins/MobileMessaging/javascripts/MobileMessagingSettings.js
@@ -234,7 +234,7 @@ var MobileMessagingSettings = MobileMessagingSettings || (function () {
return {
- /*
+ /**
* Initialize UI events
*/
initUIEvents: function () {
diff --git a/plugins/SitesManager/Controller.php b/plugins/SitesManager/Controller.php
index 74eda62af7af2edce2ec857dccb2896847db647c..5be35b59c7879f33051a690d268dce005953ba10 100644
--- a/plugins/SitesManager/Controller.php
+++ b/plugins/SitesManager/Controller.php
@@ -15,7 +15,7 @@
*/
class Piwik_SitesManager_Controller extends Piwik_Controller_Admin
{
- /*
+ /**
* Main view showing listing of websites and settings
*/
public function index()
@@ -74,7 +74,7 @@ class Piwik_SitesManager_Controller extends Piwik_Controller_Admin
echo $view->render();
}
- /*
+ /**
* Records Global settings when user submit changes
*/
public function setGlobalSettings()
@@ -112,7 +112,7 @@ class Piwik_SitesManager_Controller extends Piwik_Controller_Admin
/**
* Displays the admin UI page showing all tracking tags
- * @return unknown_type
+ * @return void
*/
function displayJavascriptCode()
{
@@ -129,7 +129,7 @@ class Piwik_SitesManager_Controller extends Piwik_Controller_Admin
echo $view->render();
}
- /*
+ /**
* User will download a file called PiwikTracker.php that is the content of the actual script
*/
function downloadPiwikTracker()
diff --git a/plugins/UserSettings/UserSettings.php b/plugins/UserSettings/UserSettings.php
index e3d907628048693db3541484770bcc645cb9f376..e7a15f9e792c2787fc0497688ebb67a772a9f947 100644
--- a/plugins/UserSettings/UserSettings.php
+++ b/plugins/UserSettings/UserSettings.php
@@ -25,8 +25,10 @@ class Piwik_UserSettings extends Piwik_Plugin
);
}
- /*
+ /**
* Mapping between the browser family shortcode and the displayed name
+ *
+ * @type array
*/
static public $browserType_display = array(
'ie' => 'Trident (IE)',
@@ -36,12 +38,14 @@ class Piwik_UserSettings extends Piwik_Plugin
'opera' => 'Presto (Opera)',
);
- /*
+ /**
* Defines API reports.
* Also used to define Widgets.
*
- * @array Category, Report Name, API Module, API action, Translated column name,
- * $segment, $sqlSegment, $acceptedValues, $sqlFilter
+ * @type array
+ *
+ * Category, Report Name, API Module, API action, Translated column name,
+ * $segment, $sqlSegment, $acceptedValues, $sqlFilter
*/
protected $reportMetadata = array(
array('UserSettings_VisitorSettings',
@@ -159,8 +163,10 @@ class Piwik_UserSettings extends Piwik_Plugin
null),
);
- /*
- * List of hooks
+ /**
+ * returns list of hooks
+ *
+ * @return array
*/
function getListHooksRegistered()
{
@@ -175,8 +181,10 @@ class Piwik_UserSettings extends Piwik_Plugin
return $hooks;
}
- /*
+ /**
* Registers reports metadata
+ *
+ * @param array $reports
*/
public function getReportMetadata(&$reports)
{
diff --git a/plugins/Zeitgeist/javascripts/piwikHelper.js b/plugins/Zeitgeist/javascripts/piwikHelper.js
index 9cfef6089b31f93fb5f74503202d420e430e356a..a4b5b181a2f054c54b08b38e6d0427cb01c361b7 100644
--- a/plugins/Zeitgeist/javascripts/piwikHelper.js
+++ b/plugins/Zeitgeist/javascripts/piwikHelper.js
@@ -12,7 +12,7 @@ var piwikHelper = {
return $('<div/>').html(value).text();
},
- /*
+ /**
* a nice cross-browser logging function
*/
log: function() {