From 6e864bc992575b1a32ad4c0bfa0c19fe2673900b Mon Sep 17 00:00:00 2001 From: Laurent Destailleur Date: Fri, 16 Mar 2012 09:34:19 +0100 Subject: [PATCH] Doxygen --- .../doc/doc_generic_order_odt.modules.php | 17 +++++++++++------ .../commande/doc/pdf_einstein.modules.php | 14 +++++++------- .../modules/commande/mod_commande_marbre.php | 14 ++++++++------ .../modules/commande/mod_commande_saphir.php | 16 +++++++++------- 4 files changed, 35 insertions(+), 26 deletions(-) diff --git a/htdocs/core/modules/commande/doc/doc_generic_order_odt.modules.php b/htdocs/core/modules/commande/doc/doc_generic_order_odt.modules.php index f7622881e8e..d61bba6447c 100644 --- a/htdocs/core/modules/commande/doc/doc_generic_order_odt.modules.php +++ b/htdocs/core/modules/commande/doc/doc_generic_order_odt.modules.php @@ -122,8 +122,9 @@ class doc_generic_order_odt extends ModelePDFCommandes /** * Define array with couple substitution key => substitution value * - * @param array $line - * @param Translate $outputlangs Lang object to use for output + * @param array $line Array of lines + * @param Translate $outputlangs Lang object to use for output + * @return array Return a substitution array */ function get_substitutionarray_lines($line,$outputlangs) { @@ -148,8 +149,9 @@ class doc_generic_order_odt extends ModelePDFCommandes /** * Return description of a module - * @param langs Lang object to use for output - * @return string Description + * + * @param Translate $langs Lang object to use for output + * @return string Description */ function info($langs) { @@ -339,11 +341,14 @@ class doc_generic_order_odt extends ModelePDFCommandes // Open and load template require_once(ODTPHP_PATH.'odf.php'); - $odfHandler = new odf($srctemplatepath, array( + $odfHandler = new odf( + $srctemplatepath, + array( 'PATH_TO_TMP' => $conf->commande->dir_temp, 'ZIP_PROXY' => 'PclZipProxy', // PhpZipProxy or PclZipProxy. Got "bad compression method" error when using PhpZipProxy. 'DELIMITER_LEFT' => '{', - 'DELIMITER_RIGHT' => '}') + 'DELIMITER_RIGHT' => '}' + ) ); // After construction $odfHandler->contentXml contains content and // [!-- BEGIN row.lines --]*[!-- END row.lines --] has been replaced by diff --git a/htdocs/core/modules/commande/doc/pdf_einstein.modules.php b/htdocs/core/modules/commande/doc/pdf_einstein.modules.php index 8ac3f34bacc..b264fa4c73e 100644 --- a/htdocs/core/modules/commande/doc/pdf_einstein.modules.php +++ b/htdocs/core/modules/commande/doc/pdf_einstein.modules.php @@ -61,7 +61,7 @@ class pdf_einstein extends ModelePDFCommandes /** * Constructor * - * @param DoliDB $DB Database handler + * @param DoliDB $db Database handler */ function __construct($db) { @@ -438,13 +438,13 @@ class pdf_einstein extends ModelePDFCommandes } /** - * Affiche tableau des versement + * Affiche tableau des versement * - * @param pdf Object PDF - * @param object Object order - * @param posy Position y in PDF - * @param outputlangs Object langs for output - * @return int <0 if KO, >0 if OK + * @param PDF &$pdf Object PDF + * @param Object $object Object order + * @param int $posy Position y in PDF + * @param Translate $outputlangs Object langs for output + * @return int <0 if KO, >0 if OK */ function _tableau_versements(&$pdf, $object, $posy, $outputlangs) { diff --git a/htdocs/core/modules/commande/mod_commande_marbre.php b/htdocs/core/modules/commande/mod_commande_marbre.php index 277de8f5312..793aa1901e4 100644 --- a/htdocs/core/modules/commande/mod_commande_marbre.php +++ b/htdocs/core/modules/commande/mod_commande_marbre.php @@ -99,7 +99,7 @@ class mod_commande_marbre extends ModeleNumRefCommandes * @param Object $object Object we need next value for * @return string Value if KO, <0 if KO */ - function getNextValue($objsoc,$commande) + function getNextValue($objsoc,$object) { global $db,$conf; @@ -124,7 +124,7 @@ class mod_commande_marbre extends ModeleNumRefCommandes } //$date=time(); - $date=$commande->date; + $date=$object->date; $yymm = strftime("%y%m",$date); $num = sprintf("%04s",$max+1); @@ -133,10 +133,12 @@ class mod_commande_marbre extends ModeleNumRefCommandes } - /** \brief Return next free value - * \param objsoc Object third party - * \param objforref Object for number to search - * \return string Next free value + /** + * Return next free value + * + * @param Societe $objsoc Object third party + * @param string $objforref Object for number to search + * @return string Next free value */ function commande_get_num($objsoc,$objforref) { diff --git a/htdocs/core/modules/commande/mod_commande_saphir.php b/htdocs/core/modules/commande/mod_commande_saphir.php index 6dc9a9219a1..ae836539098 100644 --- a/htdocs/core/modules/commande/mod_commande_saphir.php +++ b/htdocs/core/modules/commande/mod_commande_saphir.php @@ -107,7 +107,7 @@ class mod_commande_saphir extends ModeleNumRefCommandes * @param Object $object Object we need next value for * @return string Value if KO, <0 if KO */ - function getNextValue($objsoc,$commande) + function getNextValue($objsoc,$object) { global $db,$conf; @@ -122,17 +122,19 @@ class mod_commande_saphir extends ModeleNumRefCommandes return 0; } - $numFinal=get_next_value($db,$mask,'commande','ref','',$objsoc->code_client,$commande->date); + $numFinal=get_next_value($db,$mask,'commande','ref','',$objsoc->code_client,$object->date); return $numFinal; } - /** \brief Return next free value - * \param objsoc Object third party - * \param objforref Object for number to search - * \return string Next free value - */ + /** + * Return next free value + * + * @param Societe $objsoc Object third party + * @param string $objforref Object for number to search + * @return string Next free value + */ function commande_get_num($objsoc,$objforref) { return $this->getNextValue($objsoc,$objforref);