Doxygen

Dolibarr · Mar 18, 2012 · dc86095 · dc86095
1 parent 59bef9c
commit dc86095
Show file tree

Hide file tree

Showing 6 changed files with 51 additions and 36 deletions.
diff --git a/htdocs/core/modules/member/labels/pdf_standardlabel.class.php b/htdocs/core/modules/member/labels/pdf_standardlabel.class.php
@@ -67,8 +67,7 @@
 
 
 /**
- *	\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 @@ function __construct($db)
 
 	//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 @@ function Set_Char_Size(&$pdf,$pt) {
 
 
 	// 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 @@ function _Set_Format(&$pdf, $format) {
 
 
     /**
-     *      \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
@@ -85,10 +85,11 @@ function __construct($db)
 
 
 	/**
-	 *	\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
@@ -121,8 +121,9 @@ function get_substitutionarray_object($object,$outputlangs)
     /**
      *	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 @@ function get_substitutionarray_lines($line,$outputlangs)
 
 	/**
 	 *	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 @@ function write_file($object,$outputlangs,$srctemplatepath)
 
                 // 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
@@ -60,9 +60,11 @@ function getExample()
 	}
 
 
-	/**     \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 @@ function canBeActivated()
 		}
 	}
 
-	/**		\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 @@ function getNextValue($objsoc,$propal)
 		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
@@ -100,11 +100,13 @@ function getExample()
 		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
@@ -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
 {