From b1a7cd82bec6c2f15741ddede5b823ce7466d007 Mon Sep 17 00:00:00 2001
From: Laurent Destailleur <eldy@destailleur.fr>
Date: Wed, 25 Jan 2012 23:41:51 +0100
Subject: [PATCH] Doxygen
---
htdocs/core/boxes/box_actions.php | 7 +++++--
htdocs/core/boxes/modules_boxes.php | 23 +++++++++++++++--------
2 files changed, 20 insertions(+), 10 deletions(-)
diff --git a/htdocs/core/boxes/box_actions.php b/htdocs/core/boxes/box_actions.php
index 267d238d5ce..68bb550ea09 100644
--- a/htdocs/core/boxes/box_actions.php
+++ b/htdocs/core/boxes/box_actions.php
@@ -25,8 +25,11 @@
include_once(DOL_DOCUMENT_ROOT."/core/boxes/modules_boxes.php");
-
-class box_actions extends ModeleBoxes {
+/**
+ * Class to manage the box to show actions
+ */
+class box_actions extends ModeleBoxes
+{
var $boxcode="lastactions";
var $boximg="object_action";
diff --git a/htdocs/core/boxes/modules_boxes.php b/htdocs/core/boxes/modules_boxes.php
index b38c37494fa..63441ff7866 100644
--- a/htdocs/core/boxes/modules_boxes.php
+++ b/htdocs/core/boxes/modules_boxes.php
@@ -33,17 +33,21 @@ class ModeleBoxes // Can't be abtract as it is instanciated to build "empty"
var $error='';
var $max=5;
- /*
- * \brief Constructeur
+
+ /**
+ * Constructor
+ *
+ * @param DoliDB $db Database hanlder
*/
- function ModeleBoxes($DB)
+ function ModeleBoxes($db)
{
- $this->db=$DB;
+ $this->db=$db;
}
-
/**
- * \brief Renvoi le dernier message d'erreur de creation de facture
+ * Return last error message
+ *
+ * @return string Error message
*/
function error()
{
@@ -52,7 +56,10 @@ class ModeleBoxes // Can't be abtract as it is instanciated to build "empty"
/**
- * \brief Charge une ligne boxe depuis son rowid
+ * Load a box line from its rowid
+ *
+ * @param int $rowid Row id to load
+ * @return int <0 if KO, >0 if OK
*/
function fetch($rowid)
{
@@ -60,7 +67,7 @@ class ModeleBoxes // Can't be abtract as it is instanciated to build "empty"
$sql = "SELECT b.rowid, b.box_id, b.position, b.box_order, b.fk_user";
$sql.= " FROM ".MAIN_DB_PREFIX."boxes as b";
$sql.= " WHERE b.rowid = ".$rowid;
- dol_syslog("ModeleBoxes::fetch rowid=".$rowid);
+ dol_syslog(get_class($this)."::fetch rowid=".$rowid);
$resql = $this->db->query($sql);
if ($resql)
--
GitLab