lainwir3d/dolibarr
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Doxygen

Browse Source
This commit is contained in:
Laurent Destailleur 2012-03-18 02:19:27 +01:00
parent 59bef9caa1
commit dc86095c06
6 changed files with 51 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
htdocs/core/modules/member/labels/pdf_standardlabel.class.php
View File

@ -67,8 +67,7 @@ require_once(DOL_DOCUMENT_ROOT.'/core/lib/format_cards.lib.php');
/** /**
* \class pdf_standardlabel * Classe afin d'editer au format PDF des pages d'etiquette adresse au format Avery ou personnalise
* \brief Classe afin d'editer au format PDF des pages d'etiquette adresse au format Avery ou personnalise
*/ */
class pdf_standardlabel class pdf_standardlabel
{ {
@ -109,7 +108,8 @@ class pdf_standardlabel
//Methode qui permet de modifier la taille des caracteres //Methode qui permet de modifier la taille des caracteres
// Cela modiera aussi l'espace entre chaque ligne // Cela modiera aussi l'espace entre chaque ligne
function Set_Char_Size(&$pdf,$pt) { function Set_Char_Size(&$pdf,$pt)
{
if ($pt > 3) { if ($pt > 3) {
$this->_Char_Size = $pt; $this->_Char_Size = $pt;
$this->_Line_Height = $this->_Get_Height_Chars($pt); $this->_Line_Height = $this->_Get_Height_Chars($pt);
@ -119,7 +119,7 @@ class pdf_standardlabel
// On imprime une etiquette // 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; global $mysoc,$conf,$langs;
@ -339,10 +339,11 @@ class pdf_standardlabel
/** /**
* \brief Function to build PDF on disk, then output on HTTP strem. * Function to build PDF on disk, then output on HTTP strem.
* \param arrayofmembers Array of members informations *
* \param outputlangs Lang object for output language * @param array $arrayofmembers Array of members informations
* \return int 1=ok, 0=ko * @param Translate $outputlangs Lang object for output language
* @return int 1=OK, 0=KO
*/ */
function write_file($arrayofmembers,$outputlangs) function write_file($arrayofmembers,$outputlangs)
{ {

9
htdocs/core/modules/project/pdf/pdf_baleine.modules.php
View File

@ -85,10 +85,11 @@ class pdf_baleine extends ModelePDFProjects
/** /**
* \brief Fonction generant le projet sur le disque * Fonction generant le projet sur le disque
* \param object Object project a generer *
* \param outputlangs Lang output object * @param Project $object Object project a generer
* \return int 1 if OK, <=0 if KO * @param Translate $outputlangs Lang output object
* @return int 1 if OK, <=0 if KO
*/ */
function write_file($object,$outputlangs) function write_file($object,$outputlangs)
{ {

17
htdocs/core/modules/propale/doc/doc_generic_proposal_odt.modules.php
View File

@ -121,8 +121,9 @@ class doc_generic_proposal_odt extends ModelePDFPropales
/** /**
* Define array with couple substitution key => substitution value * Define array with couple substitution key => substitution value
* *
* @param array $line * @param array $line Array of lines
* @param Translate $outputlangs Lang object to use for output * @param Translate $outputlangs Lang object to use for output
* @return array Substitution array
*/ */
function get_substitutionarray_lines($line,$outputlangs) function get_substitutionarray_lines($line,$outputlangs)
{ {
@ -147,8 +148,9 @@ class doc_generic_proposal_odt extends ModelePDFPropales
/** /**
* Return description of a module * 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) function info($langs)
{ {
@ -338,11 +340,14 @@ class doc_generic_proposal_odt extends ModelePDFPropales
// Open and load template // Open and load template
require_once(ODTPHP_PATH.'odf.php'); require_once(ODTPHP_PATH.'odf.php');
$odfHandler = new odf($srctemplatepath, array( $odfHandler = new odf(
$srctemplatepath,
array(
'PATH_TO_TMP' => $conf->propale->dir_temp, 'PATH_TO_TMP' => $conf->propale->dir_temp,
'ZIP_PROXY' => 'PclZipProxy', // PhpZipProxy or PclZipProxy. Got "bad compression method" error when using PhpZipProxy. 'ZIP_PROXY' => 'PclZipProxy', // PhpZipProxy or PclZipProxy. Got "bad compression method" error when using PhpZipProxy.
'DELIMITER_LEFT' => '{', 'DELIMITER_LEFT' => '{',
'DELIMITER_RIGHT' => '}') 'DELIMITER_RIGHT' => '}'
)
); );
// After construction $odfHandler->contentXml contains content and // After construction $odfHandler->contentXml contains content and
// [!-- BEGIN row.lines --]*[!-- END row.lines --] has been replaced by // [!-- BEGIN row.lines --]*[!-- END row.lines --] has been replaced by

28
htdocs/core/modules/propale/mod_propale_marbre.php
View File

@ -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. * Test si les numeros deje en vigueur dans la base ne provoquent pas de
* \return boolean false si conflit, true si ok * de conflits qui empechera cette numerotation de fonctionner.
*
* @return boolean false si conflit, true si ok
*/ */
function canBeActivated() function canBeActivated()
{ {
@ -95,10 +97,12 @@ class mod_propale_marbre extends ModeleNumRefPropales
} }
} }
/** \brief Return next value /**
* \param objsoc Object third party * Return next value
* \param propal Object commercial proposal *
* \return string Valeur * @param Societe $objsoc Object third party
* @param Propal $propal Object commercial proposal
* @return string Next value
*/ */
function getNextValue($objsoc,$propal) function getNextValue($objsoc,$propal)
{ {
@ -132,10 +136,12 @@ class mod_propale_marbre extends ModeleNumRefPropales
return $this->prefix.$yymm."-".$num; return $this->prefix.$yymm."-".$num;
} }
/** \brief Return next free value /**
* \param objsoc Object third party * Return next free value
* \param objforref Object for number to search *
* \return string 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) function getNumRef($objsoc,$objforref)
{ {

12
htdocs/core/modules/propale/mod_propale_saphir.php
View File

@ -100,11 +100,13 @@ class mod_propale_saphir extends ModeleNumRefPropales
return $numExample; return $numExample;
} }
/** \brief Return next value /**
* \param objsoc Object third party * Return next value
* \param propal Object commercial proposal *
* \return string Value if OK, 0 if KO * @param Societe $objsoc Object third party
*/ * @param Propal $propal Object commercial proposal
* @return string Value if OK, 0 if KO
*/
function getNextValue($objsoc,$propal) function getNextValue($objsoc,$propal)
{ {
global $db,$conf; global $db,$conf;

4
htdocs/core/modules/supplier_order/mod_commande_fournisseur_muguet.php
View File

@ -26,8 +26,8 @@
require_once(DOL_DOCUMENT_ROOT ."/core/modules/supplier_order/modules_commandefournisseur.php"); 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 class mod_commande_fournisseur_muguet extends ModeleNumRefSuppliersOrders
{ {