added/fixed doc blocks

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

4 files changed, 54 insertions, 47 deletions

diff --git a/core/Menu/Abstract.php b/core/Menu/Abstract.php
index fcf12076d3..8b0201367e 100644
--- a/core/Menu/Abstract.php
+++ b/core/Menu/Abstract.php
@@ -43,11 +43,12 @@ abstract class Piwik_Menu_Abstract
 
 	/**
 	 * Adds a new entry to the menu.
-	 * @param string $menuName
-	 * @param string $subMenuName
-	 * @param string $url
-	 * @param bool $displayedForCurrentUser
-	 * @param int $order
+	 *
+	 * @param string  $menuName
+	 * @param string  $subMenuName
+	 * @param string  $url
+	 * @param bool    $displayedForCurrentUser
+	 * @param int     $order
 	 */
 	public function add($menuName, $subMenuName, $url, $displayedForCurrentUser, $order = 50)
 	{
@@ -64,10 +65,11 @@ abstract class Piwik_Menu_Abstract
 
 	/**
 	 * Builds a single menu item
-	 * @param string $menuName
-	 * @param string $subMenuName
-	 * @param string $url
-	 * @param int $order
+	 *
+	 * @param string  $menuName
+	 * @param string  $subMenuName
+	 * @param string  $url
+	 * @param int     $order
 	 */
 	private function buildMenuItem($menuName, $subMenuName, $url, $order = 50)
 	{
@@ -89,7 +91,6 @@ abstract class Piwik_Menu_Abstract
 
 	/**
 	 * Builds the menu from the $this->menuEntries variable.
-	 *
 	 */
 	private function buildMenu()
 	{
@@ -101,6 +102,7 @@ abstract class Piwik_Menu_Abstract
 
 	/**
 	 * Renames a single menu entry.
+	 *
 	 * @param $mainMenuOriginal
 	 * @param $subMenuOriginal
 	 * @param $mainMenuRenamed
@@ -114,6 +116,7 @@ abstract class Piwik_Menu_Abstract
 
 	/**
 	 * Edits a URL of an existing menu entry.
+	 *
 	 * @param $mainMenuToEdit
 	 * @param $subMenuToEdit
 	 * @param $newUrl
@@ -125,7 +128,6 @@ abstract class Piwik_Menu_Abstract
 
 	/**
 	 * Applies all edits to the menu.
-	 *
 	 */
 	private function applyEdits()
 	{
@@ -147,7 +149,6 @@ abstract class Piwik_Menu_Abstract
 
 	/**
 	 * Applies renames to the menu.
-	 *
 	 */
 	private function applyRenames()
 	{
@@ -181,7 +182,6 @@ abstract class Piwik_Menu_Abstract
 
 	/**
 	 * Orders the menu according to their order.
-	 *
 	 */
 	private function applyOrdering()
 	{
@@ -206,8 +206,8 @@ abstract class Piwik_Menu_Abstract
 	/**
 	 * Compares two menu entries. Used for ordering.
 	 *
-	 * @param array $itemOne
-	 * @param array $itemTwo
+	 * @param array  $itemOne
+	 * @param array  $itemTwo
 	 * @return boolean
 	 */
 	protected function menuCompare($itemOne, $itemTwo)
diff --git a/core/Menu/Admin.php b/core/Menu/Admin.php
index 592765e292..ddc7da32fd 100644
--- a/core/Menu/Admin.php
+++ b/core/Menu/Admin.php
@@ -16,6 +16,7 @@
 class Piwik_Menu_Admin extends Piwik_Menu_Abstract
 {
 	static private $instance = null;
+
 	/**
 	 * @return Piwik_Menu_Admin
 	 */
@@ -45,6 +46,7 @@ class Piwik_Menu_Admin extends Piwik_Menu_Abstract
 
 /**
  * Returns the current AdminMenu name
+ *
  * @return boolean
  */
 function Piwik_GetCurrentAdminMenuName()
@@ -63,7 +65,11 @@ function Piwik_GetCurrentAdminMenuName()
 	return false;
 }
 
-
+/**
+ * Returns the AdminMenu
+ *
+ * @return Array
+ */
 function Piwik_GetAdminMenu()
 {
 	return Piwik_Menu_Admin::getInstance()->get();
@@ -72,10 +78,10 @@ function Piwik_GetAdminMenu()
 /**
  * Adds a new AdminMenu entry.
  *
- * @param string $adminMenuName
- * @param string $url
- * @param boolean $displayedForCurrentUser
- * @param int $order
+ * @param string   $adminMenuName
+ * @param string   $url
+ * @param boolean  $displayedForCurrentUser
+ * @param int      $order
  */
 function Piwik_AddAdminMenu( $adminMenuName, $url, $displayedForCurrentUser = true, $order = 10 )
 {
@@ -85,8 +91,8 @@ function Piwik_AddAdminMenu( $adminMenuName, $url, $displayedForCurrentUser = tr
 /**
  * Renames an AdminMenu entry.
  *
- * @param string $adminMenuOriginal
- * @param string $adminMenuRenamed
+ * @param string  $adminMenuOriginal
+ * @param string  $adminMenuRenamed
  */
 function Piwik_RenameAdminMenuEntry($adminMenuOriginal, $adminMenuRenamed)
 {
diff --git a/core/Menu/Main.php b/core/Menu/Main.php
index 06ba79533a..3b85b163c2 100644
--- a/core/Menu/Main.php
+++ b/core/Menu/Main.php
@@ -32,7 +32,7 @@ class Piwik_Menu_Main extends Piwik_Menu_Abstract
 	/**
 	 * Returns if the URL was found in the menu.
 	 *
-	 * @param string $url
+	 * @param string  $url
 	 * @return boolean
 	 */
 	public function isUrlFound($url)
@@ -72,7 +72,7 @@ class Piwik_Menu_Main extends Piwik_Menu_Abstract
 /**
  * Checks if an entry uses the URL $url.
  * 
- * @param string $url
+ * @param string  $url
  * @return boolean
  */
 function Piwik_IsMenuUrlFound($url)
@@ -93,11 +93,11 @@ function Piwik_GetMenu()
 /**
  * Adds a new entry to the MainMenu.
  *
- * @param string $mainMenuName
- * @param string $subMenuName
- * @param string $url
- * @param boolean $displayedForCurrentUser
- * @param int $order
+ * @param string   $mainMenuName
+ * @param string   $subMenuName
+ * @param string   $url
+ * @param boolean  $displayedForCurrentUser
+ * @param int      $order
  */
 function Piwik_AddMenu( $mainMenuName, $subMenuName, $url, $displayedForCurrentUser = true, $order = 10)
 {
@@ -107,10 +107,10 @@ function Piwik_AddMenu( $mainMenuName, $subMenuName, $url, $displayedForCurrentU
 /**
  * Renames a menu entry.
  * 
- * @param string $mainMenuOriginal
- * @param string $subMenuOriginal
- * @param string $mainMenuRenamed
- * @param string $subMenuRenamed
+ * @param string  $mainMenuOriginal
+ * @param string  $subMenuOriginal
+ * @param string  $mainMenuRenamed
+ * @param string  $subMenuRenamed
  */
 function Piwik_RenameMenuEntry($mainMenuOriginal, $subMenuOriginal, 
 								$mainMenuRenamed, $subMenuRenamed)
@@ -121,9 +121,9 @@ function Piwik_RenameMenuEntry($mainMenuOriginal, $subMenuOriginal,
 /**
  * Edits the URL of a menu entry.
  * 
- * @param string $mainMenuToEdit
- * @param string $subMenuToEdit
- * @param string $newUrl
+ * @param string  $mainMenuToEdit
+ * @param string  $subMenuToEdit
+ * @param string  $newUrl
  */
 function Piwik_EditMenuUrl( $mainMenuToEdit, $subMenuToEdit, $newUrl )
 {
diff --git a/core/Menu/Top.php b/core/Menu/Top.php
index 66556dd1d5..3d5b37edd1 100644
--- a/core/Menu/Top.php
+++ b/core/Menu/Top.php
@@ -16,6 +16,7 @@
 class Piwik_Menu_Top extends Piwik_Menu_Abstract
 {
 	static private $instance = null;
+
 	/**
 	 * @return Piwik_Menu_Top
 	 */
@@ -31,10 +32,10 @@ class Piwik_Menu_Top extends Piwik_Menu_Abstract
 	/**
 	 * Directly adds a menu entry containing html.
 	 *
-	 * @param string $menuName
-	 * @param string $data
-	 * @param boolean $displayedForCurrentUser
-	 * @param int $order
+	 * @param string   $menuName
+	 * @param string   $data
+	 * @param boolean  $displayedForCurrentUser
+	 * @param int      $order
 	 */
 	public function addHtml($menuName, $data, $displayedForCurrentUser, $order)
 	{
@@ -77,11 +78,11 @@ function Piwik_GetTopMenu()
 /**
  * Adds a new entry to the TopMenu.
  *
- * @param string $topMenuName
- * @param $data
- * @param boolean $displayedForCurrentUser
- * @param int $order
- * @param bool $isHTML
+ * @param string   $topMenuName
+ * @param string   $data
+ * @param boolean  $displayedForCurrentUser
+ * @param int      $order
+ * @param bool     $isHTML
  */
 function Piwik_AddTopMenu( $topMenuName, $data, $displayedForCurrentUser = true, $order = 10, $isHTML = false)
 {
@@ -98,8 +99,8 @@ function Piwik_AddTopMenu( $topMenuName, $data, $displayedForCurrentUser = true,
 /**
  * Renames a entry of the TopMenu
  *
- * @param string $topMenuOriginal
- * @param string $topMenuRenamed
+ * @param string  $topMenuOriginal
+ * @param string  $topMenuRenamed
  */
 function Piwik_RenameTopMenuEntry($topMenuOriginal, $topMenuRenamed)
 {