added/fixed doc blocks

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

1 files changed, 22 insertions, 2 deletions

diff --git a/core/DataTable/Filter/ExcludeLowPopulation.php b/core/DataTable/Filter/ExcludeLowPopulation.php
index 4d2ece04a1..0526e6f753 100644
--- a/core/DataTable/Filter/ExcludeLowPopulation.php
+++ b/core/DataTable/Filter/ExcludeLowPopulation.php
@@ -24,6 +24,15 @@ class Piwik_DataTable_Filter_ExcludeLowPopulation extends Piwik_DataTable_Filter
 {
 	static public $minimumValue;
 	const MINIMUM_SIGNIFICANT_PERCENTAGE_THRESHOLD = 0.02;
+
+	/**
+	 * Constructor
+	 *
+	 * @param Piwik_DataTable  $table
+	 * @param string           $columnToFilter              column to filter
+	 * @param number           $minimumValue                minimum value
+	 * @param bool             $minimumPercentageThreshold
+	 */
 	public function __construct( $table, $columnToFilter, $minimumValue, $minimumPercentageThreshold = false )
 	{
 		parent::__construct($table);
@@ -41,7 +50,12 @@ class Piwik_DataTable_Filter_ExcludeLowPopulation extends Piwik_DataTable_Filter
 		}
 		self::$minimumValue = $minimumValue;
 	}
-	
+
+	/**
+	 * Executes filter and removes all rows below the defined minimum
+	 *
+	 * @param Piwik_DataTable  $table
+	 */
 	function filter($table)
 	{
 		$table->filter('ColumnCallbackDeleteRow',
@@ -50,7 +64,13 @@ class Piwik_DataTable_Filter_ExcludeLowPopulation extends Piwik_DataTable_Filter
 							)
 						);
 	}
-	
+
+	/**
+	 * Checks whether the given value is below the defined minimum
+	 *
+	 * @param number  $value  value to check
+	 * @return bool
+	 */
 	static public function excludeLowPopulation($value)
 	{
 		return $value >= self::$minimumValue;