Doxygen

Dolibarr · Jan 26, 2012 · 97b176b · 97b176b
1 parent 491d3dd
commit 97b176b
Show file tree

Hide file tree

Showing 21 changed files with 77 additions and 22 deletions.
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -26,7 +26,10 @@
 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
@@ -27,7 +27,10 @@
 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
@@ -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
@@ -28,7 +28,10 @@
 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
@@ -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
@@ -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
@@ -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
@@ -27,7 +27,10 @@
 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
@@ -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
@@ -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
@@ -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
@@ -27,7 +27,10 @@
 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
@@ -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
@@ -28,7 +28,10 @@
 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
@@ -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
@@ -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
@@ -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
 {