From 97b176ba8d06e28e5d5312d3de7f2fcbb5b79892 Mon Sep 17 00:00:00 2001
From: Laurent Destailleur <eldy@destailleur.fr>
Date: Thu, 26 Jan 2012 13:49:15 +0100
Subject: [PATCH] Doxygen
---
htdocs/core/boxes/box_actions.php | 2 +-
htdocs/core/boxes/box_bookmarks.php | 4 +++-
htdocs/core/boxes/box_clients.php | 5 ++++-
htdocs/core/boxes/box_commandes.php | 5 ++++-
htdocs/core/boxes/box_comptes.php | 5 ++++-
htdocs/core/boxes/box_contacts.php | 5 ++++-
htdocs/core/boxes/box_contracts.php | 5 ++++-
htdocs/core/boxes/box_external_rss.php | 5 ++++-
htdocs/core/boxes/box_factures.php | 5 ++++-
htdocs/core/boxes/box_factures_fourn.php | 5 ++++-
htdocs/core/boxes/box_factures_fourn_imp.php | 5 ++++-
htdocs/core/boxes/box_factures_imp.php | 5 ++++-
htdocs/core/boxes/box_fournisseurs.php | 5 ++++-
htdocs/core/boxes/box_members.php | 5 ++++-
htdocs/core/boxes/box_osc_client.php | 5 ++++-
htdocs/core/boxes/box_produits.php | 5 ++++-
htdocs/core/boxes/box_propales.php | 5 ++++-
htdocs/core/boxes/box_prospect.php | 5 ++++-
htdocs/core/boxes/box_services_expired.php | 5 ++++-
htdocs/core/boxes/box_services_vendus.php | 5 ++++-
htdocs/core/boxes/modules_boxes.php | 3 +--
21 files changed, 77 insertions(+), 22 deletions(-)
diff --git a/htdocs/core/boxes/box_actions.php b/htdocs/core/boxes/box_actions.php
index 68bb550ea09..2a4043e1da2 100644
--- a/htdocs/core/boxes/box_actions.php
+++ b/htdocs/core/boxes/box_actions.php
@@ -26,7 +26,7 @@
include_once(DOL_DOCUMENT_ROOT."/core/boxes/modules_boxes.php");
/**
- * Class to manage the box to show actions
+ * Class to manage the box to show last events
*/
class box_actions extends ModeleBoxes
{
diff --git a/htdocs/core/boxes/box_bookmarks.php b/htdocs/core/boxes/box_bookmarks.php
index 89352d908aa..0f5872e20ba 100644
--- a/htdocs/core/boxes/box_bookmarks.php
+++ b/htdocs/core/boxes/box_bookmarks.php
@@ -22,7 +22,9 @@
*/
include_once(DOL_DOCUMENT_ROOT."/core/boxes/modules_boxes.php");
-
+/**
+ * Class to manage the box to show bookmarks
+ */
class box_bookmarks extends ModeleBoxes {
var $boxcode="bookmarks";
diff --git a/htdocs/core/boxes/box_clients.php b/htdocs/core/boxes/box_clients.php
index 509641b7570..593d6ca2ce8 100644
--- a/htdocs/core/boxes/box_clients.php
+++ b/htdocs/core/boxes/box_clients.php
@@ -26,7 +26,10 @@
include_once(DOL_DOCUMENT_ROOT."/core/boxes/modules_boxes.php");
-class box_clients extends ModeleBoxes {
+/**
+ * Class to manage the box to show last thirdparties
+ */
+ class box_clients extends ModeleBoxes {
var $boxcode="lastcustomers";
var $boximg="object_company";
diff --git a/htdocs/core/boxes/box_commandes.php b/htdocs/core/boxes/box_commandes.php
index 74da5a9ab39..b61a0685d0b 100644
--- a/htdocs/core/boxes/box_commandes.php
+++ b/htdocs/core/boxes/box_commandes.php
@@ -26,7 +26,10 @@
include_once(DOL_DOCUMENT_ROOT."/core/boxes/modules_boxes.php");
-class box_commandes extends ModeleBoxes {
+/**
+ * Class to manage the box to show last orders
+ */
+ class box_commandes extends ModeleBoxes {
var $boxcode="lastcustomerorders";
var $boximg="object_order";
diff --git a/htdocs/core/boxes/box_comptes.php b/htdocs/core/boxes/box_comptes.php
index f988017338a..4238547c65a 100644
--- a/htdocs/core/boxes/box_comptes.php
+++ b/htdocs/core/boxes/box_comptes.php
@@ -26,7 +26,10 @@ include_once(DOL_DOCUMENT_ROOT."/core/boxes/modules_boxes.php");
include_once(DOL_DOCUMENT_ROOT."/compta/bank/class/account.class.php");
-class box_comptes extends ModeleBoxes {
+/**
+ * Class to manage the box to show last users
+ */
+ class box_comptes extends ModeleBoxes {
var $boxcode="currentaccounts";
var $boximg="object_bill";
diff --git a/htdocs/core/boxes/box_contacts.php b/htdocs/core/boxes/box_contacts.php
index 98c43b14f96..73808c6277f 100755
--- a/htdocs/core/boxes/box_contacts.php
+++ b/htdocs/core/boxes/box_contacts.php
@@ -27,7 +27,10 @@ include_once(DOL_DOCUMENT_ROOT."/core/boxes/modules_boxes.php");
include_once(DOL_DOCUMENT_ROOT."/contact/class/contact.class.php");
-class box_contacts extends ModeleBoxes {
+/**
+ * Class to manage the box to show last contacts
+ */
+ class box_contacts extends ModeleBoxes {
var $boxcode="lastcontacts";
var $boximg="object_contact";
diff --git a/htdocs/core/boxes/box_contracts.php b/htdocs/core/boxes/box_contracts.php
index f92494b100a..86ad58486ac 100644
--- a/htdocs/core/boxes/box_contracts.php
+++ b/htdocs/core/boxes/box_contracts.php
@@ -24,7 +24,10 @@
include_once(DOL_DOCUMENT_ROOT."/core/boxes/modules_boxes.php");
-class box_contracts extends ModeleBoxes {
+/**
+ * Class to manage the box to show last contracts
+ */
+ class box_contracts extends ModeleBoxes {
var $boxcode="lastcontracts";
var $boximg="object_contract";
diff --git a/htdocs/core/boxes/box_external_rss.php b/htdocs/core/boxes/box_external_rss.php
index f61df2d8c4c..604349ef8d9 100644
--- a/htdocs/core/boxes/box_external_rss.php
+++ b/htdocs/core/boxes/box_external_rss.php
@@ -28,7 +28,10 @@ include_once(DOL_DOCUMENT_ROOT."/core/class/rssparser.class.php");
include_once(DOL_DOCUMENT_ROOT."/core/boxes/modules_boxes.php");
-class box_external_rss extends ModeleBoxes {
+/**
+ * Class to manage the box to show RSS feeds
+ */
+ class box_external_rss extends ModeleBoxes {
var $boxcode="lastrssinfos";
var $boximg="object_rss";
diff --git a/htdocs/core/boxes/box_factures.php b/htdocs/core/boxes/box_factures.php
index f801afb650f..9cda954eef5 100644
--- a/htdocs/core/boxes/box_factures.php
+++ b/htdocs/core/boxes/box_factures.php
@@ -25,7 +25,10 @@
include_once(DOL_DOCUMENT_ROOT."/core/boxes/modules_boxes.php");
-class box_factures extends ModeleBoxes {
+/**
+ * Class to manage the box to show last invoices
+ */
+ class box_factures extends ModeleBoxes {
var $boxcode="lastcustomerbills";
var $boximg="object_bill";
diff --git a/htdocs/core/boxes/box_factures_fourn.php b/htdocs/core/boxes/box_factures_fourn.php
index 365c3a12a7f..43ff65f0a30 100644
--- a/htdocs/core/boxes/box_factures_fourn.php
+++ b/htdocs/core/boxes/box_factures_fourn.php
@@ -25,7 +25,10 @@
include_once(DOL_DOCUMENT_ROOT."/core/boxes/modules_boxes.php");
-class box_factures_fourn extends ModeleBoxes {
+/**
+ * Class to manage the box to show last supplier invoices
+ */
+ class box_factures_fourn extends ModeleBoxes {
var $boxcode="lastsupplierbills";
var $boximg="object_bill";
diff --git a/htdocs/core/boxes/box_factures_fourn_imp.php b/htdocs/core/boxes/box_factures_fourn_imp.php
index 3a9a48bedbd..95eaeeda4b9 100644
--- a/htdocs/core/boxes/box_factures_fourn_imp.php
+++ b/htdocs/core/boxes/box_factures_fourn_imp.php
@@ -24,7 +24,10 @@
include_once(DOL_DOCUMENT_ROOT."/core/boxes/modules_boxes.php");
-class box_factures_fourn_imp extends ModeleBoxes {
+/**
+ * Class to manage the box to show not payed suppliers invoices
+ */
+ class box_factures_fourn_imp extends ModeleBoxes {
var $boxcode="oldestunpaidsupplierbills";
var $boximg="object_bill";
diff --git a/htdocs/core/boxes/box_factures_imp.php b/htdocs/core/boxes/box_factures_imp.php
index 7eeac19a248..f265c4c6a52 100644
--- a/htdocs/core/boxes/box_factures_imp.php
+++ b/htdocs/core/boxes/box_factures_imp.php
@@ -27,7 +27,10 @@ require_once(DOL_DOCUMENT_ROOT."/core/boxes/modules_boxes.php");
require_once(DOL_DOCUMENT_ROOT.'/compta/facture/class/facture.class.php');
-class box_factures_imp extends ModeleBoxes {
+/**
+ * Class to manage the box to show last invoices
+ */
+ class box_factures_imp extends ModeleBoxes {
var $boxcode="oldestunpaidcustomerbills";
var $boximg="object_bill";
diff --git a/htdocs/core/boxes/box_fournisseurs.php b/htdocs/core/boxes/box_fournisseurs.php
index 9c02cab8462..19fa11414d7 100644
--- a/htdocs/core/boxes/box_fournisseurs.php
+++ b/htdocs/core/boxes/box_fournisseurs.php
@@ -25,7 +25,10 @@
include_once(DOL_DOCUMENT_ROOT."/core/boxes/modules_boxes.php");
-class box_fournisseurs extends ModeleBoxes {
+/**
+ * Class to manage the box to show last suppliers
+ */
+ class box_fournisseurs extends ModeleBoxes {
var $boxcode="lastsuppliers";
var $boximg="object_company";
diff --git a/htdocs/core/boxes/box_members.php b/htdocs/core/boxes/box_members.php
index 6d0b9f27241..e08e910aa4b 100755
--- a/htdocs/core/boxes/box_members.php
+++ b/htdocs/core/boxes/box_members.php
@@ -26,7 +26,10 @@
include_once(DOL_DOCUMENT_ROOT."/core/boxes/modules_boxes.php");
-class box_members extends ModeleBoxes {
+/**
+ * Class to manage the box to show last members
+ */
+ class box_members extends ModeleBoxes {
var $boxcode="lastmembers";
var $boximg="object_user";
diff --git a/htdocs/core/boxes/box_osc_client.php b/htdocs/core/boxes/box_osc_client.php
index a784a0c8774..3f43a4785d8 100644
--- a/htdocs/core/boxes/box_osc_client.php
+++ b/htdocs/core/boxes/box_osc_client.php
@@ -25,7 +25,10 @@
include_once(DOL_DOCUMENT_ROOT."/core/boxes/modules_boxes.php");
-class box_osc_clients extends ModeleBoxes {
+/**
+ * Class to manage the box to show last customers of shop
+ */
+ class box_osc_clients extends ModeleBoxes {
var $boxcode="nbofcustomers";
var $boximg="object_company";
diff --git a/htdocs/core/boxes/box_produits.php b/htdocs/core/boxes/box_produits.php
index 6e031577cbc..8dd89c76661 100644
--- a/htdocs/core/boxes/box_produits.php
+++ b/htdocs/core/boxes/box_produits.php
@@ -27,7 +27,10 @@ include_once(DOL_DOCUMENT_ROOT."/core/boxes/modules_boxes.php");
include_once(DOL_DOCUMENT_ROOT."/product/class/product.class.php");
-class box_produits extends ModeleBoxes {
+/**
+ * Class to manage the box to show last products
+ */
+ class box_produits extends ModeleBoxes {
var $boxcode="lastproducts";
var $boximg="object_product";
diff --git a/htdocs/core/boxes/box_propales.php b/htdocs/core/boxes/box_propales.php
index 4752e0ffc70..e02cdfb6fce 100644
--- a/htdocs/core/boxes/box_propales.php
+++ b/htdocs/core/boxes/box_propales.php
@@ -26,7 +26,10 @@
include_once(DOL_DOCUMENT_ROOT."/core/boxes/modules_boxes.php");
-class box_propales extends ModeleBoxes {
+/**
+ * Class to manage the box to show last proposals
+ */
+ class box_propales extends ModeleBoxes {
var $boxcode="lastpropals";
var $boximg="object_propal";
diff --git a/htdocs/core/boxes/box_prospect.php b/htdocs/core/boxes/box_prospect.php
index 69bb2444008..6c9380ef750 100644
--- a/htdocs/core/boxes/box_prospect.php
+++ b/htdocs/core/boxes/box_prospect.php
@@ -28,7 +28,10 @@ include_once(DOL_DOCUMENT_ROOT."/core/boxes/modules_boxes.php");
include_once(DOL_DOCUMENT_ROOT."/comm/prospect/class/prospect.class.php");
-class box_prospect extends ModeleBoxes {
+/**
+ * Class to manage the box to show last prospects
+ */
+ class box_prospect extends ModeleBoxes {
var $boxcode="lastprospects";
var $boximg="object_company";
diff --git a/htdocs/core/boxes/box_services_expired.php b/htdocs/core/boxes/box_services_expired.php
index 895fa7713a2..4dd7ea79201 100644
--- a/htdocs/core/boxes/box_services_expired.php
+++ b/htdocs/core/boxes/box_services_expired.php
@@ -24,7 +24,10 @@
include_once(DOL_DOCUMENT_ROOT."/core/boxes/modules_boxes.php");
-class box_services_expired extends ModeleBoxes {
+/**
+ * Class to manage the box to show expired services
+ */
+ class box_services_expired extends ModeleBoxes {
var $boxcode="expiredservices";
var $boximg="object_contract";
diff --git a/htdocs/core/boxes/box_services_vendus.php b/htdocs/core/boxes/box_services_vendus.php
index 477cb6383f3..a5761db0ef0 100644
--- a/htdocs/core/boxes/box_services_vendus.php
+++ b/htdocs/core/boxes/box_services_vendus.php
@@ -26,7 +26,10 @@
include_once(DOL_DOCUMENT_ROOT."/core/boxes/modules_boxes.php");
-class box_services_vendus extends ModeleBoxes {
+/**
+ * Class to manage the box to show last services lines
+ */
+ class box_services_vendus extends ModeleBoxes {
var $boxcode="lastproductsincontract";
var $boximg="object_product";
diff --git a/htdocs/core/boxes/modules_boxes.php b/htdocs/core/boxes/modules_boxes.php
index 63441ff7866..08a4d0cef86 100644
--- a/htdocs/core/boxes/modules_boxes.php
+++ b/htdocs/core/boxes/modules_boxes.php
@@ -24,8 +24,7 @@
/**
- * \class ModeleBoxes
- * \brief Classe mere des boites
+ * Parent class of boxes
*/
class ModeleBoxes // Can't be abtract as it is instanciated to build "empty" boxes
{
--
GitLab