From dc86095c06bcc5ffa7315db5ed5c0027affe9788 Mon Sep 17 00:00:00 2001 From: Laurent Destailleur Date: Sun, 18 Mar 2012 02:19:27 +0100 Subject: [PATCH] Doxygen --- .../member/labels/pdf_standardlabel.class.php | 17 +++++------ .../project/pdf/pdf_baleine.modules.php | 9 +++--- .../doc/doc_generic_proposal_odt.modules.php | 17 +++++++---- .../modules/propale/mod_propale_marbre.php | 28 +++++++++++-------- .../modules/propale/mod_propale_saphir.php | 12 ++++---- .../mod_commande_fournisseur_muguet.php | 4 +-- 6 files changed, 51 insertions(+), 36 deletions(-) diff --git a/htdocs/core/modules/member/labels/pdf_standardlabel.class.php b/htdocs/core/modules/member/labels/pdf_standardlabel.class.php index bbb85f780f4..f5f74cd8c40 100644 --- a/htdocs/core/modules/member/labels/pdf_standardlabel.class.php +++ b/htdocs/core/modules/member/labels/pdf_standardlabel.class.php @@ -67,8 +67,7 @@ require_once(DOL_DOCUMENT_ROOT.'/core/lib/format_cards.lib.php'); /** - * \class pdf_standardlabel - * \brief Classe afin d'editer au format PDF des pages d'etiquette adresse au format Avery ou personnalise + * Classe afin d'editer au format PDF des pages d'etiquette adresse au format Avery ou personnalise */ class pdf_standardlabel { @@ -109,7 +108,8 @@ class pdf_standardlabel //Methode qui permet de modifier la taille des caracteres // Cela modiera aussi l'espace entre chaque ligne - function Set_Char_Size(&$pdf,$pt) { + function Set_Char_Size(&$pdf,$pt) + { if ($pt > 3) { $this->_Char_Size = $pt; $this->_Line_Height = $this->_Get_Height_Chars($pt); @@ -119,7 +119,7 @@ class pdf_standardlabel // On imprime une etiquette - function Add_PDF_card(&$pdf,$textleft,$header='',$footer='',$outputlangs,$textright='') + function Add_PDF_card(&$pdf,$textleft,$header,$footer,$outputlangs,$textright='') { global $mysoc,$conf,$langs; @@ -339,10 +339,11 @@ class pdf_standardlabel /** - * \brief Function to build PDF on disk, then output on HTTP strem. - * \param arrayofmembers Array of members informations - * \param outputlangs Lang object for output language - * \return int 1=ok, 0=ko + * Function to build PDF on disk, then output on HTTP strem. + * + * @param array $arrayofmembers Array of members informations + * @param Translate $outputlangs Lang object for output language + * @return int 1=OK, 0=KO */ function write_file($arrayofmembers,$outputlangs) { diff --git a/htdocs/core/modules/project/pdf/pdf_baleine.modules.php b/htdocs/core/modules/project/pdf/pdf_baleine.modules.php index cd669386f3b..11b9fab9f42 100644 --- a/htdocs/core/modules/project/pdf/pdf_baleine.modules.php +++ b/htdocs/core/modules/project/pdf/pdf_baleine.modules.php @@ -85,10 +85,11 @@ class pdf_baleine extends ModelePDFProjects /** - * \brief Fonction generant le projet sur le disque - * \param object Object project a generer - * \param outputlangs Lang output object - * \return int 1 if OK, <=0 if KO + * Fonction generant le projet sur le disque + * + * @param Project $object Object project a generer + * @param Translate $outputlangs Lang output object + * @return int 1 if OK, <=0 if KO */ function write_file($object,$outputlangs) { diff --git a/htdocs/core/modules/propale/doc/doc_generic_proposal_odt.modules.php b/htdocs/core/modules/propale/doc/doc_generic_proposal_odt.modules.php index 5b2c22e7414..70b37af314c 100644 --- a/htdocs/core/modules/propale/doc/doc_generic_proposal_odt.modules.php +++ b/htdocs/core/modules/propale/doc/doc_generic_proposal_odt.modules.php @@ -121,8 +121,9 @@ class doc_generic_proposal_odt extends ModelePDFPropales /** * 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 Substitution array */ function get_substitutionarray_lines($line,$outputlangs) { @@ -147,8 +148,9 @@ class doc_generic_proposal_odt extends ModelePDFPropales /** * 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) { @@ -338,11 +340,14 @@ class doc_generic_proposal_odt extends ModelePDFPropales // Open and load template require_once(ODTPHP_PATH.'odf.php'); - $odfHandler = new odf($srctemplatepath, array( + $odfHandler = new odf( + $srctemplatepath, + array( 'PATH_TO_TMP' => $conf->propale->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/propale/mod_propale_marbre.php b/htdocs/core/modules/propale/mod_propale_marbre.php index 5796c7480af..e30770cf9ce 100644 --- a/htdocs/core/modules/propale/mod_propale_marbre.php +++ b/htdocs/core/modules/propale/mod_propale_marbre.php @@ -60,9 +60,11 @@ class mod_propale_marbre extends ModeleNumRefPropales } - /** \brief Test si les numeros deje en vigueur dans la base ne provoquent pas de - * de conflits qui empechera cette numerotation de fonctionner. - * \return boolean false si conflit, true si ok + /** + * Test si les numeros deje en vigueur dans la base ne provoquent pas de + * de conflits qui empechera cette numerotation de fonctionner. + * + * @return boolean false si conflit, true si ok */ function canBeActivated() { @@ -95,10 +97,12 @@ class mod_propale_marbre extends ModeleNumRefPropales } } - /** \brief Return next value - * \param objsoc Object third party - * \param propal Object commercial proposal - * \return string Valeur + /** + * Return next value + * + * @param Societe $objsoc Object third party + * @param Propal $propal Object commercial proposal + * @return string Next value */ function getNextValue($objsoc,$propal) { @@ -132,10 +136,12 @@ class mod_propale_marbre extends ModeleNumRefPropales return $this->prefix.$yymm."-".$num; } - /** \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 Object $objforref Object for number to search + * @return string Next free value */ function getNumRef($objsoc,$objforref) { diff --git a/htdocs/core/modules/propale/mod_propale_saphir.php b/htdocs/core/modules/propale/mod_propale_saphir.php index ef9c505a9fd..486710e50cd 100644 --- a/htdocs/core/modules/propale/mod_propale_saphir.php +++ b/htdocs/core/modules/propale/mod_propale_saphir.php @@ -100,11 +100,13 @@ class mod_propale_saphir extends ModeleNumRefPropales return $numExample; } - /** \brief Return next value - * \param objsoc Object third party - * \param propal Object commercial proposal - * \return string Value if OK, 0 if KO - */ + /** + * Return next value + * + * @param Societe $objsoc Object third party + * @param Propal $propal Object commercial proposal + * @return string Value if OK, 0 if KO + */ function getNextValue($objsoc,$propal) { global $db,$conf; diff --git a/htdocs/core/modules/supplier_order/mod_commande_fournisseur_muguet.php b/htdocs/core/modules/supplier_order/mod_commande_fournisseur_muguet.php index 2ffd11d2fcf..f1a6557ec01 100644 --- a/htdocs/core/modules/supplier_order/mod_commande_fournisseur_muguet.php +++ b/htdocs/core/modules/supplier_order/mod_commande_fournisseur_muguet.php @@ -26,8 +26,8 @@ require_once(DOL_DOCUMENT_ROOT ."/core/modules/supplier_order/modules_commandefournisseur.php"); -/** \class mod_commande_fournisseur_muguet - * \brief Classe du modele de numerotation de reference de commande fournisseur Muguet +/** + * Classe du modele de numerotation de reference de commande fournisseur Muguet */ class mod_commande_fournisseur_muguet extends ModeleNumRefSuppliersOrders {