From 8e772fdc5ecba6689b9ec7c6ab1b08b734d335da Mon Sep 17 00:00:00 2001
From: Laurent Destailleur <eldy@destailleur.fr>
Date: Fri, 17 Feb 2012 10:04:10 +0100
Subject: [PATCH] Doxygen
---
htdocs/core/menus/standard/auguria.lib.php | 14 ++++++-----
.../menus/standard/auguria_backoffice.php | 17 +++++++-------
.../menus/standard/auguria_frontoffice.php | 20 ++++++++--------
htdocs/core/menus/standard/eldy.lib.php | 8 ++++---
.../core/menus/standard/eldy_backoffice.php | 16 ++++++-------
.../core/menus/standard/eldy_frontoffice.php | 16 ++++++-------
htdocs/core/menus/standard/empty.php | 23 +++++++++++--------
7 files changed, 59 insertions(+), 55 deletions(-)
diff --git a/htdocs/core/menus/standard/auguria.lib.php b/htdocs/core/menus/standard/auguria.lib.php
index 8377ff4fc4f..336e35461c0 100644
--- a/htdocs/core/menus/standard/auguria.lib.php
+++ b/htdocs/core/menus/standard/auguria.lib.php
@@ -27,9 +27,10 @@
/**
* Core function to output top menu auguria
*
- * @param $db
- * @param $atarget
- * @param $type_user 0=Internal,1=External,2=All
+ * @param DoliDB $db Database handler
+ * @param string $atarget Target
+ * @param int $type_user 0=Internal,1=External,2=All
+ * @return void
*/
function print_auguria_menu($db,$atarget,$type_user)
{
@@ -151,9 +152,10 @@ function print_end_menu_array_auguria()
/**
* Core function to output left menu auguria
*
- * @param db Database handler
- * @param menu_array_before Table of menu entries to show before entries of menu handler
- * @param menu_array_after Table of menu entries to show after entries of menu handler
+ * @param DoliDB $db Database handler
+ * @param array $menu_array_before Table of menu entries to show before entries of menu handler
+ * @param array $menu_array_after Table of menu entries to show after entries of menu handler
+ * @return void
*/
function print_left_auguria_menu($db,$menu_array_before,$menu_array_after)
{
diff --git a/htdocs/core/menus/standard/auguria_backoffice.php b/htdocs/core/menus/standard/auguria_backoffice.php
index acf85d3b51e..244cb85bd9b 100644
--- a/htdocs/core/menus/standard/auguria_backoffice.php
+++ b/htdocs/core/menus/standard/auguria_backoffice.php
@@ -33,8 +33,8 @@
* \brief Classe permettant la gestion du menu du haut Auguria
*/
-class MenuTop {
-
+class MenuTop
+{
var $db;
var $require_left=array("auguria_backoffice"); // Si doit etre en phase avec un gestionnaire de menu gauche particulier
var $hideifnotallowed=0; // Put 0 for back office menu, 1 for front office menu
@@ -54,7 +54,7 @@ class MenuTop {
/**
* Show menu
- *
+ *
* @return void
*/
function showmenu()
@@ -70,8 +70,8 @@ class MenuTop {
/**
* Classe permettant la gestion du menu du gauche Auguria
*/
-class MenuLeft {
-
+class MenuLeft
+{
var $db;
var $menu_array;
var $menu_array_after;
@@ -80,10 +80,9 @@ class MenuLeft {
/**
* Constructor
*
- * @param DoliDB $DB Database handler
- * @param menu_array Table of menu entries to show before entries of menu handler
- * @param menu_array_after Table of menu entries to show after entries of menu handler
- *
+ * @param DoliDB $db Database handler
+ * @param array &$menu_array Table of menu entries to show before entries of menu handler
+ * @param array &$menu_array_after Table of menu entries to show after entries of menu handler
*/
function MenuLeft($db,&$menu_array,&$menu_array_after)
{
diff --git a/htdocs/core/menus/standard/auguria_frontoffice.php b/htdocs/core/menus/standard/auguria_frontoffice.php
index 04084ab3849..47532b7ae1b 100644
--- a/htdocs/core/menus/standard/auguria_frontoffice.php
+++ b/htdocs/core/menus/standard/auguria_frontoffice.php
@@ -29,12 +29,10 @@
/**
- * \class MenuTop
- * \brief Classe permettant la gestion du menu du haut Auguria
+ * Classe permettant la gestion du menu du haut Auguria
*/
-
-class MenuTop {
-
+class MenuTop
+{
var $db;
var $require_left=array("auguria_backoffice"); // Si doit etre en phase avec un gestionnaire de menu gauche particulier
var $hideifnotallowed=1; // Put 0 for back office menu, 1 for front office menu
@@ -55,7 +53,7 @@ class MenuTop {
/**
* Show menu
- *
+ *
* @return void
*/
function showmenu()
@@ -71,8 +69,8 @@ class MenuTop {
/**
* Classe permettant la gestion du menu du gauche Auguria
*/
-class MenuLeft {
-
+class MenuLeft
+{
var $db;
var $menu_array;
var $menu_array_after;
@@ -81,9 +79,9 @@ class MenuLeft {
/**
* Constructor
*
- * @param db Database handler
- * @param menu_array Table of menu entries to show before entries of menu handler
- * @param menu_array_after Table of menu entries to show after entries of menu handler
+ * @param DoliDB $db Database handler
+ * @param array &$menu_array Table of menu entries to show before entries of menu handler
+ * @param array &$menu_array_after Table of menu entries to show after entries of menu handler
*/
function MenuLeft($db,&$menu_array,&$menu_array_after)
{
diff --git a/htdocs/core/menus/standard/eldy.lib.php b/htdocs/core/menus/standard/eldy.lib.php
index cfddbdda8a3..c90f129b4cb 100644
--- a/htdocs/core/menus/standard/eldy.lib.php
+++ b/htdocs/core/menus/standard/eldy.lib.php
@@ -26,9 +26,10 @@
/**
* Core function to output top menu eldy
*
- * @param $db
- * @param $atarget
- * @param $type_user 0=Internal,1=External,2=All
+ * @param DoliDB $db Database handler
+ * @param string $atarget Target
+ * @param int $type_user 0=Internal,1=External,2=All
+ * @return void
*/
function print_eldy_menu($db,$atarget,$type_user)
{
@@ -549,6 +550,7 @@ function print_end_menu_array()
* @param DoliDB $db Database handler
* @param array $menu_array_before Table of menu entries to show before entries of menu handler
* @param array $menu_array_after Table of menu entries to show after entries of menu handler
+ * @return void
*/
function print_left_eldy_menu($db,$menu_array_before,$menu_array_after)
{
diff --git a/htdocs/core/menus/standard/eldy_backoffice.php b/htdocs/core/menus/standard/eldy_backoffice.php
index a825d5293f0..bdd49579a73 100644
--- a/htdocs/core/menus/standard/eldy_backoffice.php
+++ b/htdocs/core/menus/standard/eldy_backoffice.php
@@ -31,8 +31,8 @@
* \class MenuTop
* \brief Class to manage top menu Eldy (for internal users)
*/
-class MenuTop {
-
+class MenuTop
+{
var $db;
var $require_left=array("eldy_backoffice"); // Si doit etre en phase avec un gestionnaire de menu gauche particulier
var $hideifnotallowed=0; // Put 0 for back office menu, 1 for front office menu
@@ -52,7 +52,7 @@ class MenuTop {
/**
* Show menu
- *
+ *
* @return void
*/
function showmenu()
@@ -69,8 +69,8 @@ class MenuTop {
* \class MenuLeft
* \brief Classe permettant la gestion du menu du gauche Eldy
*/
-class MenuLeft {
-
+class MenuLeft
+{
var $db;
var $menu_array;
var $menu_array_after;
@@ -79,9 +79,9 @@ class MenuLeft {
/**
* Constructor
*
- * @param db Database handler
- * @param menu_array Table of menu entries to show before entries of menu handler
- * @param menu_array_after Table of menu entries to show after entries of menu handler
+ * @param DoliDB $db Database handler
+ * @param array &$menu_array Table of menu entries to show before entries of menu handler
+ * @param array &$menu_array_after Table of menu entries to show after entries of menu handler
*/
function MenuLeft($db,&$menu_array,&$menu_array_after)
{
diff --git a/htdocs/core/menus/standard/eldy_frontoffice.php b/htdocs/core/menus/standard/eldy_frontoffice.php
index 4b01b9fb74f..4c967b33a92 100644
--- a/htdocs/core/menus/standard/eldy_frontoffice.php
+++ b/htdocs/core/menus/standard/eldy_frontoffice.php
@@ -30,8 +30,8 @@
/**
* Class to manage top menu Eldy (for external users)
*/
-class MenuTop {
-
+class MenuTop
+{
var $db;
var $require_left=array("eldy_frontoffice"); // Si doit etre en phase avec un gestionnaire de menu gauche particulier
var $hideifnotallowed=1; // Put 0 for back office menu, 1 for front office menu
@@ -51,7 +51,7 @@ class MenuTop {
/**
* Show menu
- *
+ *
* @return void
*/
function showmenu()
@@ -67,8 +67,8 @@ class MenuTop {
/**
* Classe permettant la gestion du menu du gauche Eldy
*/
-class MenuLeft {
-
+class MenuLeft
+{
var $db;
var $menu_array;
var $menu_array_after;
@@ -77,9 +77,9 @@ class MenuLeft {
/**
* Constructor
*
- * @param db Database handler
- * @param menu_array Table of menu entries to show before entries of menu handler
- * @param menu_array_after Table of menu entries to show after entries of menu handler
+ * @param DoliDB $db Database handler
+ * @param array &$menu_array Table of menu entries to show before entries of menu handler
+ * @param array &$menu_array_after Table of menu entries to show after entries of menu handler
*/
function MenuLeft($db,&$menu_array,&$menu_array_after)
{
diff --git a/htdocs/core/menus/standard/empty.php b/htdocs/core/menus/standard/empty.php
index 6efd12367da..13e19711615 100644
--- a/htdocs/core/menus/standard/empty.php
+++ b/htdocs/core/menus/standard/empty.php
@@ -24,8 +24,8 @@
* \class MenuTop
* \brief Class for top empty menu
*/
-class MenuTop {
-
+class MenuTop
+{
var $db;
var $require_left=array("empty"); // If this top menu handler must be used with a particular left menu handler
var $hideifnotallowed=false; // Put 0 for back office menu, 1 for front office menu
@@ -35,7 +35,7 @@ class MenuTop {
/**
* Constructor
*
- * @param DoliDB $DB Database handler
+ * @param DoliDB $db Database handler
*/
function MenuTop($db)
{
@@ -45,6 +45,8 @@ class MenuTop {
/**
* Show menu
+ *
+ * @return void
*/
function showmenu()
{
@@ -111,11 +113,10 @@ function print_end_menu_array_empty()
/**
- * \class MenuLeft
- * \brief Class for left empty menu
+ * Class for left empty menu
*/
-class MenuLeft {
-
+class MenuLeft
+{
var $db;
var $menu_array;
var $menu_array_after;
@@ -124,9 +125,9 @@ class MenuLeft {
/**
* Constructor
*
- * @param db Database handler
- * @param menu_array Table of menu entries to show before entries of menu handler
- * @param menu_array_after Table of menu entries to show after entries of menu handler
+ * @param DoliDB $db Database handler
+ * @param array &$menu_array Table of menu entries to show before entries of menu handler
+ * @param array &$menu_array_after Table of menu entries to show after entries of menu handler
*/
function MenuLeft($db,&$menu_array,&$menu_array_after)
{
@@ -138,6 +139,8 @@ class MenuLeft {
/**
* Show menu
+ *
+ * @return void
*/
function showmenu()
{
--
GitLab