Skip to content
Snippets Groups Projects
Commit 3f11e51f authored by Laurent Destailleur's avatar Laurent Destailleur
Browse files

Doxygen

parent 4806f2ad
No related branches found
No related tags found
No related merge requests found
Hide whitespace changes
Inline Side-by-side
Showing
with 73 additions and 48 deletions
htdocs/commande/document.php
+ 2
− 1
View file @ 3f11e51f
......@@ -189,7 +189,8 @@ else
Header('Location: index.php');
}
$db->close();
llxFooter();
$db->close();
?>
htdocs/core/modules/facture/doc/doc_generic_invoice_odt.modules.php
+ 10
− 6
View file @ 3f11e51f
......@@ -132,8 +132,9 @@ class doc_generic_invoice_odt extends ModelePDFFactures
/**
* Define array with couple substitution key => substitution value
*
* @param $line
* @param $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 substitution array
*/
function get_substitutionarray_lines($line,$outputlangs)
{
......@@ -159,8 +160,8 @@ class doc_generic_invoice_odt extends ModelePDFFactures
/**
* 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)
{
......@@ -350,11 +351,14 @@ class doc_generic_invoice_odt extends ModelePDFFactures
// Open and load template
require_once(ODTPHP_PATH.'odf.php');
$odfHandler = new odf($srctemplatepath, array(
$odfHandler = new odf(
$srctemplatepath,
array(
'PATH_TO_TMP' => $conf->facture->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
......
htdocs/core/modules/facture/doc/pdf_crabe.modules.php
+ 5
− 5
View file @ 3f11e51f
......@@ -446,11 +446,11 @@ class pdf_crabe extends ModelePDFFactures
/**
* Show payments table
*
* @param pdf Object PDF
* @param object Object invoice
* @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 invoice
* @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)
{
......
htdocs/core/modules/facture/doc/pdf_oursin.modules.php
+ 7
− 6
View file @ 3f11e51f
......@@ -332,12 +332,13 @@ class pdf_oursin extends ModelePDFFactures
/**
* \brief Affiche tableau des versement
* \param pdf Objet PDF
* \param fac Objet facture
* \param posy Position y in PDF
* \param outputlangs Object langs for output
* \return int <0 if KO, >0 if OK
* Show payments table
*
* @param PDF &$pdf Object PDF
* @param Object $object Object invoice
* @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)
{
......
htdocs/core/modules/facture/mod_facture_mercure.php
+ 14
− 10
View file @ 3f11e51f
......@@ -107,11 +107,13 @@ class mod_facture_mercure extends ModeleNumRefFactures
return $numExample;
}
/** Return next value
* @param objsoc Object third party
* @param facture Object invoice
* @param mode 'next' for next value or 'last' for last value
* @return string Value if OK, 0 if KO
/**
* Return next value
*
* @param objsoc Object third party
* @param facture Object invoice
* @param mode 'next' for next value or 'last' for last value
* @return string Value if OK, 0 if KO
*/
function getNextValue($objsoc,$facture,$mode='next')
{
......@@ -140,11 +142,13 @@ class mod_facture_mercure extends ModeleNumRefFactures
}
/** Return next free value
* @param objsoc Object third party
* @param objforref Object for number to search
* @param mode 'next' for next value or 'last' for last value
* @return string Next free value
/**
* Return next free value
*
* @param Societe $objsoc Object third party
* @param string $objforref Object for number to search
* @param string $mode 'next' for next value or 'last' for last value
* @return string Next free value
*/
function getNumRef($objsoc,$objforref,$mode='next')
{
......
htdocs/core/modules/facture/mod_facture_terre.php
+ 8
− 5
View file @ 3f11e51f
......@@ -115,6 +115,7 @@ class mod_facture_terre extends ModeleNumRefFactures
}
/** Return next value not used or last value used
*
* @param objsoc Object third party
* @param facture Object invoice
* @param mode 'next' for next value or 'last' for last value
......@@ -181,11 +182,13 @@ class mod_facture_terre extends ModeleNumRefFactures
else dol_print_error('','Bad parameter for getNextValue');
}
/** Return next free value
* @param objsoc Object third party
* @param objforref Object for number to search
* @param mode 'next' for next value or 'last' for last value
* @return string Next free value
/**
* Return next free value
*
* @param Societe $objsoc Object third party
* @param string $objforref Object for number to search
* @param string $mode 'next' for next value or 'last' for last value
* @return string Next free value
*/
function getNumRef($objsoc,$objforref,$mode='next')
{
......
htdocs/core/modules/facture/modules_facture.php
+ 27
− 15
View file @ 3f11e51f
......@@ -68,16 +68,20 @@ abstract class ModeleNumRefFactures
{
var $error='';
/** Return if a module can be used or not
* @return boolean true if module can be used
/**
* Return if a module can be used or not
*
* @return boolean true if module can be used
*/
function isEnabled()
{
return true;
}
/** Renvoi la description par defaut du modele de numerotation
* @return string Texte descripif
/**
* Renvoi la description par defaut du modele de numerotation
*
* @return string Texte descripif
*/
function info()
{
......@@ -86,8 +90,10 @@ abstract class ModeleNumRefFactures
return $langs->trans("NoDescription");
}
/** Renvoi un exemple de numerotation
* @return string Example
/**
* Renvoi un exemple de numerotation
*
* @return string Example
*/
function getExample()
{
......@@ -96,19 +102,23 @@ abstract class ModeleNumRefFactures
return $langs->trans("NoExample");
}
/** Test si les numeros deja en vigueur dans la base ne provoquent pas
* de conflits qui empecheraient cette numerotation de fonctionner.
* @return boolean false si conflit, true si ok
/**
* Test si les numeros deja en vigueur dans la base ne provoquent pas
* de conflits qui empecheraient cette numerotation de fonctionner.
*
* @return boolean false si conflit, true si ok
*/
function canBeActivated()
{
return true;
}
/** Renvoi prochaine valeur attribuee
* @param objsoc Objet societe
* @param facture Objet facture
* @return string Valeur
/**
* Renvoi prochaine valeur attribuee
*
* @param objsoc Objet societe
* @param facture Objet facture
* @return string Valeur
*/
function getNextValue($objsoc,$facture)
{
......@@ -116,8 +126,10 @@ abstract class ModeleNumRefFactures
return $langs->trans("NotAvailable");
}
/** Renvoi version du modele de numerotation
* @return string Valeur
/**
* Renvoi version du modele de numerotation
*
* @return string Valeur
*/
function getVersion()
{
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment