refs #2256 - more invalid tags

git-svn-id: http://dev.piwik.org/svn/trunk@4312 59fd770c-687e-43c8-a1e3-f5a4ff64c105

core/Visualization/Cloud.php

@@ -92,7 +92,7 @@ protected function shuffleCloud()
 	/*
 	 * Get the class range using a percentage
 	 *
-	 * @returns int $class
+	 * @return int $class
 	 */	 
 	protected function getClassFromPercent($percent)
 	{

plugins/API/API.php

@@ -510,8 +510,8 @@ private function handleTableReport($idSite, $period, $dataTable, &$reportMetadat
 
 	/**
 	 * API metadata are sorted by category/name
-	 * @param $a
-	 * @param $b
+	 * @param string $a
+	 * @param string $b
 	 * @return int
 	 */
 	private function sort($a, $b)

plugins/Actions/Actions.php

@@ -604,8 +604,8 @@ protected function updateActionsTableWithRowQuery($query)
 	 * Given a page name and type, builds a recursive datatable where
 	 * each level of the tree is a category, based on the page name split by a delimiter (slash / by default)
 	 *  
-	 * @param $actionName
-	 * @param $actionType
+	 * @param string $actionName
+	 * @param int $actionType
 	 * @return Piwik_DataTable
 	 */
 	protected function parseActionNameCategoriesInDataTable($actionName, $actionType)

plugins/AnonymizeIP/AnonymizeIP.php

@@ -44,8 +44,8 @@ public function getListHooksRegistered()
 	/**
 	 * Internal function to mask portions of the visitor IP address
 	 *
-	 * @param $ip Unsigned long representation of IP address
-	 * @param $maskLength Number of octets to reset
+	 * @param string $ip Unsigned long representation of IP address
+	 * @param int $maskLength Number of octets to reset
 	 */
 	static public function applyIPMask($ip, $maskLength)
 	{

plugins/CustomVariables/CustomVariables.php

@@ -119,7 +119,7 @@ function __construct()
 	/**
 	 * Hooks on daily archive to trigger various log processing
 	 * 
-	 * @param $notification
+	 * @param Piwik_Event_Notification $notification
 	 * @return void
 	 */
 	public function archiveDay( $notification )
@@ -140,7 +140,7 @@ public function archiveDay( $notification )
 	}
 
 	/**
-	 * @param $archiveProcessing
+	 * @param Piwik_ArchiveProcessing $archiveProcessing
 	 * @return void
 	 */
 	protected function archiveDayAggregate(Piwik_ArchiveProcessing $archiveProcessing)
@@ -181,7 +181,7 @@ protected function archiveDayAggregate(Piwik_ArchiveProcessing $archiveProcessin
 	}
 
 	/**
-	 * @param $archiveProcessing
+	 * @param Piwik_ArchiveProcessing $archiveProcessing
 	 * @return void
 	 */
 	protected function archiveDayRecordInDatabase($archiveProcessing)

plugins/ExampleAPI/API.php

@@ -88,8 +88,8 @@ public function getObject()
 	 * when the API function is called. You can also use default values
 	 * as shown in this example.
 	 * 
-	 * @param $a
-	 * @param $b
+	 * @param float $a
+	 * @param float $b
 	 * @return float
 	 */
 	public function getSum($a = 0, $b = 0)

plugins/Goals/API.php

@@ -32,8 +32,8 @@ static public function getInstance()
 	/**
 	 * Returns all Goals for a given website
 	 * 
-	 * @param $idSite
-	 * @return Array of Goal attributes
+	 * @param int $idSite
+	 * @return array Array of Goal attributes
 	 */
 	public function getGoals( $idSite )
 	{
@@ -59,14 +59,14 @@ public function getGoals( $idSite )
 	/**
 	 * Creates a Goal for a given website.
 	 * 
-	 * @param $idSite
-	 * @param $name
-	 * @param $matchAttribute 'url', 'file', 'external_website' or 'manually'
-	 * @param $pattern eg. purchase-confirmation.htm
-	 * @param $patternType 'regex', 'contains', 'exact' 
-	 * @param $caseSensitive bool
-	 * @param $revenue If set, default revenue to assign to conversions
-	 * @param $allowMultipleConversionsPerVisit By default, multiple conversions in the same visit will only record the first conversion.
+	 * @param int $idSite
+	 * @param string $name
+	 * @param string $matchAttribute 'url', 'file', 'external_website' or 'manually'
+	 * @param string $pattern eg. purchase-confirmation.htm
+	 * @param string $patternType 'regex', 'contains', 'exact' 
+	 * @param bool $caseSensitive
+	 * @param float|string $revenue If set, default revenue to assign to conversions
+	 * @param bool $allowMultipleConversionsPerVisit By default, multiple conversions in the same visit will only record the first conversion.
 	 * 						If set to true, multiple conversions will all be recorded within a visit (useful for Ecommerce goals)
 	 * @return int ID of the new goal
 	 */
@@ -154,8 +154,8 @@ private function checkPattern($pattern)
 	 * Soft deletes a given Goal.
 	 * Stats data in the archives will still be recorded, but not displayed.
 	 * 
-	 * @param $idSite
-	 * @param $idGoal
+	 * @param int $idSite
+	 * @param int $idGoal
 	 * @return void
 	 */
 	public function deleteGoal( $idSite, $idGoal )
@@ -173,11 +173,11 @@ public function deleteGoal( $idSite, $idGoal )
 	/**
 	 * Returns Goals data
 	 * 
-	 * @param $idSite
-	 * @param $period
-	 * @param $date
-	 * @param $idGoal
-	 * @param $columns Comma separated list of metrics to fetch: nb_conversions, conversion_rate, revenue
+	 * @param int $idSite
+	 * @param string $period
+	 * @param string $date
+	 * @param int $idGoal
+	 * @param array $columns Array of metrics to fetch: nb_conversions, conversion_rate, revenue
 	 * @return Piwik_DataTable
 	 */
 	public function get( $idSite, $period, $date, $segment = false, $idGoal = false, $columns = array() )

plugins/Goals/Goals.php

@@ -216,7 +216,7 @@ static public function getRecordName($recordName, $idGoal = false, $visitorRetur
 	 * Hooks on Period archiving. 
 	 * Sums up Goal conversions stats, and processes overall conversion rate
 	 * 
-	 * @param $notification
+	 * @param Piwik_Event_Notification $notification
 	 * @return void
 	 */
 	function archivePeriod($notification )
@@ -258,7 +258,8 @@ function archivePeriod($notification )
 	 * Hooks on the Daily archiving.
 	 * Will process Goal stats overall and for each Goal. 
 	 * Also processes the New VS Returning visitors conversion stats.
-	 * @param $notification
+	 *
+	 * @param Piwik_Event_Notification $notification
 	 * @return void
 	 */
 	function archiveDay( $notification )

plugins/MultiSites/Controller.php

@@ -145,8 +145,8 @@ public function getSitesInfo()
 	/**
 	 * The Multisites reports displays the first calendar date as the earliest day available for all websites.
 	 * Also, today is the later "today" available across all timezones.
-	 * @param $mySites
-	 * @param $view
+	 * @param array $mySites
+	 * @param Piwik_View $view
 	 * @return void
 	 */
 	private function setMinMaxDateAcrossWebsites($mySites, $view)

plugins/PDFReports/API.php

@@ -38,13 +38,13 @@ static public function getInstance()
 	/**
 	 * Creates a new PDF report and schedules it. 
 	 * 
-	 * @param $idSite 
-	 * @param $description Report description
-	 * @param $period Schedule frequency: day, week or month 
-	 * @param $sendToMe bool
-	 * @param $additionalEmails Comma separated list of emails
-	 * @param $reports Comma separated list of reports
-	 * @return idReport generated
+	 * @param int $idSite 
+	 * @param string $description Report description
+	 * @param string $period Schedule frequency: day, week or month 
+	 * @param bool $sendToMe
+	 * @param string $additionalEmails Comma separated list of emails
+	 * @param string $reports Comma separated list of reports
+	 * @return int idReport generated
 	 */
 	public function addReport( $idSite, $description, $period, $reports, $emailMe = true, $additionalEmails = false)
 	{
@@ -112,7 +112,7 @@ public function updateReport( $idReport, $idSite, $description, $period, $report
 	/**
 	 * Deletes a specific report
 	 * 
-	 * @param $idReport
+	 * @param int $idReport
 	 */
 	public function deleteReport($idReport)
 	{
@@ -135,10 +135,9 @@ public function deleteReport($idReport)
 	/**
 	 * Returns the list of PDF reports matching the passed parameters
 	 * 
-	 * @param $idSite If specified, will filter reports that belong to a specific idsite
-	 * @param $period If specified, will filter reports that are scheduled for this period (day,week,month)
-	 * @param $idReport If specified, will filter the report that has the given idReport 
-	 * 
+	 * @param int $idSite If specified, will filter reports that belong to a specific idsite
+	 * @param string $period If specified, will filter reports that are scheduled for this period (day,week,month)
+	 * @param int $idReport If specified, will filter the report that has the given idReport 
 	 * @throws Exception if $idReport was specified but the report wasn't found
 	 */
 	public function getReports($idSite = false, $period = false, $idReport = false, $ifSuperUserReturnOnlySuperUserReports = false)

plugins/PDFReports/PDFRenderer.php

@@ -362,7 +362,7 @@ private function paintReportTableHeader()
 	/**
 	 * Prints a message
 	 *
-	 * @param $message
+	 * @param string $message
 	 * @return void
 	 */
 	private function paintMessage($message)

plugins/Referers/Referers.php

@@ -162,7 +162,7 @@ function addMenus()
 	/**
 	 * Adds Goal dimensions, so that the dimensions are displayed in the UI Goal Overview page
 	 * 
-	 * @param $notification
+	 * @param Piwik_Event_Notification $notification
 	 * @return void
 	 */
 	function getReportsWithGoalMetrics( $notification )
@@ -208,7 +208,7 @@ function __construct()
 	 * Period archiving: sums up daily stats and sums report tables, 
 	 * making sure that tables are still truncated.
 	 * 
-	 * @param $notification
+	 * @param Piwik_Event_Notification $notification
 	 * @return void
 	 */
 	function archivePeriod( $notification )
@@ -271,7 +271,7 @@ function archivePeriod( $notification )
 	/**
 	 * Hooks on daily archive to trigger various log processing
 	 * 
-	 * @param $notification
+	 * @param Piwik_Event_Notification $notification
 	 * @return void
 	 */
 	public function archiveDay( $notification )
@@ -307,7 +307,7 @@ protected function cleanup()
 	 * Daily archive: processes all Referers reports, eg. Visits by Keyword, 
 	 * Visits by websites, etc.
 	 * 
-	 * @param $archiveProcessing
+	 * @param Piwik_ArchiveProcessing $archiveProcessing
 	 * @return void
 	 */
 	protected function archiveDayAggregateVisits(Piwik_ArchiveProcessing $archiveProcessing)
@@ -391,7 +391,7 @@ protected function archiveDayAggregateVisits(Piwik_ArchiveProcessing $archivePro
 	 * Daily Goal archiving:  processes reports of Goal conversions by Keyword,
 	 * Goal conversions by Referer Websites, etc.
 	 * 
-	 * @param $archiveProcessing
+	 * @param Piwik_ArchiveProcessing $archiveProcessing
 	 * @return void
 	 */
 	protected function archiveDayAggregateGoals($archiveProcessing)
@@ -454,7 +454,7 @@ protected function archiveDayAggregateGoals($archiveProcessing)
 	/**
 	 * Records the daily stats (numeric or datatable blob) into the archive tables.
 	 *  
-	 * @param $archiveProcessing
+	 * @param Piwik_ArchiveProcessing $archiveProcessing
 	 * @return void
 	 */
 	protected function archiveDayRecordInDatabase($archiveProcessing)

plugins/SEO/API.php

@@ -34,7 +34,9 @@ static public function getInstance()
 	}
 
 	/**
-	 * @param $url URL to request Ranks for
+	 * Get rank
+	 *
+	 * @param string $url URL to request Ranks for
 	 * @return Piwik_DataTable
 	 */
 	public function getRank( $url )

plugins/SitesManager/API.php

@@ -60,7 +60,7 @@ public function getJavascriptTag( $idSite, $piwikUrl = '')
 
 	/**
 	 * Returns all websites belonging to the specified group 
-	 * @param $group string Group name
+	 * @param string $group Group name
 	 */
 	public function getSitesFromGroup($group)
 	{
@@ -473,8 +473,8 @@ private function checkValidCurrency($currency)
 	/**
 	 * Checks that the submitted IPs (comma separated list) are valid
 	 * Returns the cleaned up IPs
-	 * @param $excludedIps 
-	 * 
+	 *
+	 * @param string $excludedIps Comma separated list of IP addresses
 	 * @return array of IPs
 	 */
 	private function checkAndReturnExcludedIps($excludedIps)
@@ -592,7 +592,7 @@ public function getDefaultCurrency()
 	/**
 	 * Sets the default currency that will be used when creating websites
 	 * 
-	 * @param $defaultCurrency string eg. 'USD'
+	 * @param string $defaultCurrency Currency code, eg. 'USD'
 	 * @return bool
 	 */
 	public function setDefaultCurrency($defaultCurrency)
@@ -622,7 +622,7 @@ public function getDefaultTimezone()
 	/**
 	 * Sets the default timezone that will be used when creating websites
 	 * 
-	 * @param $defaultTimezone string eg. Europe/Paris or UTC+8
+	 * @param string $defaultTimezone Timezone string eg. Europe/Paris or UTC+8
 	 * @return bool
 	 */
 	public function setDefaultTimezone($defaultTimezone)
@@ -908,7 +908,7 @@ private function isValidUrl( $url )
 	 * Tests if the IP is a valid IP, allowing wildcards, except in the first octet.
 	 * Wildcards can only be used from right to left, ie. 1.1.*.* is allowed, but 1.1.*.1 is not.
 	 * 
-	 * @param $ip
+	 * @param string $ip IP address
 	 * @return bool
 	 */
 	private function isValidIp( $ip )