From 6e251690ab1ac680e7d465eb7fa5264e06f122fa Mon Sep 17 00:00:00 2001 From: Laurent Destailleur Date: Tue, 17 Mar 2015 11:23:45 +0100 Subject: [PATCH] Doxygen --- htdocs/compta/bank/class/account.class.php | 4 +- htdocs/contrat/class/contrat.class.php | 67 ++++++------------- .../modules/modAskPriceSupplier.class.php | 2 +- .../core/modules/modExpenseReport.class.php | 9 ++- htdocs/core/modules/modFTP.class.php | 2 +- htdocs/core/modules/modFicheinter.class.php | 2 +- htdocs/core/modules/modGeoIPMaxmind.class.php | 2 +- htdocs/core/modules/modResource.class.php | 2 +- htdocs/expensereport/ajax/ajaxprojet.php | 1 + htdocs/expensereport/card.php | 13 ++-- .../class/expensereport.class.php | 7 +- .../class/expensereportstats.class.php | 2 +- htdocs/expensereport/export_csv.php | 1 + htdocs/expensereport/index.php | 1 + htdocs/expensereport/info.php | 2 +- htdocs/expensereport/list.php | 1 + 16 files changed, 51 insertions(+), 67 deletions(-) diff --git a/htdocs/compta/bank/class/account.class.php b/htdocs/compta/bank/class/account.class.php index c0704ef8f7a..900a970d949 100644 --- a/htdocs/compta/bank/class/account.class.php +++ b/htdocs/compta/bank/class/account.class.php @@ -39,12 +39,12 @@ class Account extends CommonObject public $table_element='bank_account'; /** - * //TODO: Discuss this. $rowid is preferred over $id - * @var + * @var int Use id instead of rowid * @deprecated */ var $rowid; var $id; + var $ref; var $label; //! 1=Compte courant/check/carte, 2=Compte liquide, 0=Compte épargne diff --git a/htdocs/contrat/class/contrat.class.php b/htdocs/contrat/class/contrat.class.php index daac348e920..dcabc4e0b52 100644 --- a/htdocs/contrat/class/contrat.class.php +++ b/htdocs/contrat/class/contrat.class.php @@ -89,23 +89,7 @@ class Contrat extends CommonObject var $product; /** - * TODO: Which is the correct one? - * Author of the contract - * @var - */ - var $user_author; - - /** - * TODO: Which is the correct one? - * Author of the contract - * @var User - */ - public $user_creation; - - /** - * TODO: Which is the correct one? - * Author of the contract - * @var int + * @var int Id of user author of the contract */ public $fk_user_author; @@ -117,38 +101,37 @@ class Contrat extends CommonObject public $user_author_id; /** - * @var User + * @var User Object user that create the contract. Set by the info method. + */ + public $user_creation; + + /** + * @var User Object user that close the contract. Set by the info method. */ public $user_cloture; /** - * Date of creation - * @var int + * @var int Date of creation */ var $date_creation; /** - * Date of last modification - * Not filled until you call ->info() - * @var int + * @var int Date of last modification. Not filled until you call ->info() */ public $date_modification; /** - * Date of validation - * @var int + * @var int Date of validation */ var $date_validation; /** - * Date when contract was signed - * @var int + * @var int Date when contract was signed */ var $date_contrat; /** - * Date of contract closure - * @var int + * @var int Date of contract closure * @deprecated we close contract lines, not a contract */ var $date_cloture; @@ -157,21 +140,15 @@ class Contrat extends CommonObject var $commercial_suivi_id; /** - * @deprecated Use note_private or note_public instead - */ - var $note; - - /** - * Private note - * @var string + * @var string Private note */ var $note_private; /** - * Public note - * @var string + * @var string Public note */ var $note_public; + var $modelpdf; /** @@ -184,8 +161,7 @@ class Contrat extends CommonObject var $extraparams=array(); /** - * Contract lines - * @var ContratLigne[] + * @var ContratLigne[] Contract lines */ var $lines=array(); @@ -569,7 +545,6 @@ class Contrat extends CommonObject $this->commercial_signature_id = $result["fk_commercial_signature"]; $this->commercial_suivi_id = $result["fk_commercial_suivi"]; - $this->note = $result["note_private"]; // deprecated $this->note_private = $result["note_private"]; $this->note_public = $result["note_public"]; $this->modelpdf = $result["model_pdf"]; @@ -726,7 +701,7 @@ class Contrat extends CommonObject // Retreive all extrafield for propal // fetch optionals attributes and labels $line->fetch_optionals($line->id,$extralabelsline); - + $this->lines[] = $line; //dol_syslog("1 ".$line->desc); @@ -822,13 +797,13 @@ class Contrat extends CommonObject if ($line->statut == 4 && (! empty($line->date_fin_prevue) && $line->date_fin_prevue < $now)) $this->nbofservicesexpired++; if ($line->statut == 5) $this->nbofservicesclosed++; - + // Retreive all extrafield for propal // fetch optionals attributes and labels - + $line->fetch_optionals($line->id,$extralabelsline); - - + + $this->lines[] = $line; $total_ttc+=$objp->total_ttc; diff --git a/htdocs/core/modules/modAskPriceSupplier.class.php b/htdocs/core/modules/modAskPriceSupplier.class.php index 4614b0b819d..451caccf649 100644 --- a/htdocs/core/modules/modAskPriceSupplier.class.php +++ b/htdocs/core/modules/modAskPriceSupplier.class.php @@ -21,7 +21,7 @@ */ /** - * \defgroup askpricesupplier Module to request supplier price proposals + * \defgroup askpricesupplier Module askpricesupplier * \brief Module to request supplier price proposals * \file htdocs/core/modules/modAskPriceSupplier.class.php * \ingroup askpricesupplier diff --git a/htdocs/core/modules/modExpenseReport.class.php b/htdocs/core/modules/modExpenseReport.class.php index 53289c512ff..dfe8180e0c1 100755 --- a/htdocs/core/modules/modExpenseReport.class.php +++ b/htdocs/core/modules/modExpenseReport.class.php @@ -17,14 +17,13 @@ */ /** - * \defgroup Indicateurs - * \brief Module indicateurs - * Such a file must be copied into htdocs/includes/module directory. + * \defgroup expensereport Module expensereport + * \brief Module to manage expense report. Replace old module Deplacement. */ /** - * \file htdocs/indicateurs/core/modules/modExpenseReport.class.php - * \ingroup indicateur + * \file htdocs/core/modules/modExpenseReport.class.php + * \ingroup expensereport * \brief Description and activation file for module ExpenseReport */ include_once(DOL_DOCUMENT_ROOT ."/core/modules/DolibarrModules.class.php"); diff --git a/htdocs/core/modules/modFTP.class.php b/htdocs/core/modules/modFTP.class.php index 2d6e1689ba9..38b16127c90 100644 --- a/htdocs/core/modules/modFTP.class.php +++ b/htdocs/core/modules/modFTP.class.php @@ -17,7 +17,7 @@ */ /** - * \defgroup ftp Module FTP + * \defgroup ftp Module ftp * \brief Module for FTP client module * \file htdocs/core/modules/modFTP.class.php * \ingroup ftp diff --git a/htdocs/core/modules/modFicheinter.class.php b/htdocs/core/modules/modFicheinter.class.php index 7c54679bd9c..b41b291711a 100644 --- a/htdocs/core/modules/modFicheinter.class.php +++ b/htdocs/core/modules/modFicheinter.class.php @@ -21,7 +21,7 @@ */ /** - * \defgroup ficheinter Module intervention cards + * \defgroup ficheinter Module Interventions * \brief Module to manage intervention cards * \file htdocs/core/modules/modFicheinter.class.php * \ingroup ficheinter diff --git a/htdocs/core/modules/modGeoIPMaxmind.class.php b/htdocs/core/modules/modGeoIPMaxmind.class.php index 06d9d8f7f5e..cfe7acbdfa6 100644 --- a/htdocs/core/modules/modGeoIPMaxmind.class.php +++ b/htdocs/core/modules/modGeoIPMaxmind.class.php @@ -16,7 +16,7 @@ */ /** - * \defgroup geoip Module GeoIP + * \defgroup geoip Module geoipmaxmind * \brief Module to make geoip conversions * \file htdocs/core/modules/modGeoIPMaxmind.class.php * \ingroup geoip diff --git a/htdocs/core/modules/modResource.class.php b/htdocs/core/modules/modResource.class.php index 26fe0b4bd31..9acebd5d90d 100644 --- a/htdocs/core/modules/modResource.class.php +++ b/htdocs/core/modules/modResource.class.php @@ -17,7 +17,7 @@ */ /** - * \defgroup resource Resource module + * \defgroup resource Module resource * \brief Resource module descriptor. * \file core/modules/modResource.class.php * \ingroup resource diff --git a/htdocs/expensereport/ajax/ajaxprojet.php b/htdocs/expensereport/ajax/ajaxprojet.php index 77d22d1ac90..6b9dd7e062f 100755 --- a/htdocs/expensereport/ajax/ajaxprojet.php +++ b/htdocs/expensereport/ajax/ajaxprojet.php @@ -20,6 +20,7 @@ /** * \file htdocs/expensereport/ajax/ajaxprojet.php + * \ingroup expensereport * \brief File to return Ajax response on third parties request */ diff --git a/htdocs/expensereport/card.php b/htdocs/expensereport/card.php index c71705628b6..fad813a570b 100755 --- a/htdocs/expensereport/card.php +++ b/htdocs/expensereport/card.php @@ -19,7 +19,8 @@ /** * \file htdocs/expensereport/card.php - * \brief Page for trip and expense card + * \ingroup expensereport + * \brief Page for trip and expense report card */ $res=0; @@ -1135,7 +1136,7 @@ if ($action == 'create') print ''; print ''; } - + // Public note print ''; print '' . $langs->trans('NotePublic') . ''; @@ -1155,7 +1156,7 @@ if ($action == 'create') print $doleditor->Create(1); print ''; } - + print ''; print ''; @@ -1286,7 +1287,7 @@ else print ''; } - + // Public note print ''; print '' . $langs->trans('NotePublic') . ''; @@ -1295,7 +1296,7 @@ else $doleditor = new DolEditor('note_public', $object->note_public, '', 80, 'dolibarr_notes', 'In', 0, false, true, ROWS_3, 70); print $doleditor->Create(1); print ''; - + // Private note if (empty($user->societe_id)) { print ''; @@ -1306,7 +1307,7 @@ else print $doleditor->Create(1); print ''; } - + print ''; dol_fiche_end(); diff --git a/htdocs/expensereport/class/expensereport.class.php b/htdocs/expensereport/class/expensereport.class.php index e43c6dd4507..0d30602987f 100755 --- a/htdocs/expensereport/class/expensereport.class.php +++ b/htdocs/expensereport/class/expensereport.class.php @@ -16,6 +16,11 @@ * along with this program. If not, see . */ +/** + * \file htdocs/expensereport/class/expensereport.class.php + * \ingroup expensereport + * \brief File to manage Expense Reports + */ require_once DOL_DOCUMENT_ROOT .'/core/class/commonobject.class.php'; /** @@ -1420,7 +1425,7 @@ class ExpenseReport extends CommonObject return $this->commonGenerateDocument($modelpath, $modele, $outputlangs, $hidedetails, $hidedesc, $hideref); } - + /** * List of types * diff --git a/htdocs/expensereport/class/expensereportstats.class.php b/htdocs/expensereport/class/expensereportstats.class.php index 140e492972e..57c970b9fc8 100644 --- a/htdocs/expensereport/class/expensereportstats.class.php +++ b/htdocs/expensereport/class/expensereportstats.class.php @@ -19,7 +19,7 @@ /** * \file htdocs/expensereport/class/expensereportstats.class.php - * \ingroup ExpenseReport + * \ingroup expensereport * \brief Fichier de la classe de gestion des stats des expensereport et notes de frais */ include_once DOL_DOCUMENT_ROOT . '/core/class/stats.class.php'; diff --git a/htdocs/expensereport/export_csv.php b/htdocs/expensereport/export_csv.php index 8228eb68532..ba3621d1ac0 100755 --- a/htdocs/expensereport/export_csv.php +++ b/htdocs/expensereport/export_csv.php @@ -17,6 +17,7 @@ /** * \file htdocs/expensereport/index.php + * \ingroup expensereport * \brief Page list of expenses */ diff --git a/htdocs/expensereport/index.php b/htdocs/expensereport/index.php index 62f5cbe89fc..4af39adb633 100644 --- a/htdocs/expensereport/index.php +++ b/htdocs/expensereport/index.php @@ -21,6 +21,7 @@ /** * \file htdocs/expensereport/index.php + * \ingroup expensereport * \brief Page list of expenses */ diff --git a/htdocs/expensereport/info.php b/htdocs/expensereport/info.php index e548c6521d7..c1e0b598e7e 100644 --- a/htdocs/expensereport/info.php +++ b/htdocs/expensereport/info.php @@ -19,7 +19,7 @@ /** * \file htdocs/expensereport/info.php - * \ingroup trip + * \ingroup expensereport * \brief Page to show a trip information */ diff --git a/htdocs/expensereport/list.php b/htdocs/expensereport/list.php index 6d82b86e4af..9ef9c05a328 100755 --- a/htdocs/expensereport/list.php +++ b/htdocs/expensereport/list.php @@ -21,6 +21,7 @@ /** * \file htdocs/expensereport/index.php + * \ingroup expensereport * \brief list of expense reports */