From 02cdd86066139fb5174bdddea143dc7d6ecac363 Mon Sep 17 00:00:00 2001 From: Laurent Destailleur Date: Sat, 17 Mar 2012 00:47:01 +0100 Subject: [PATCH] Doxygen --- .../expedition/mod_expedition_ribera.php | 12 +++--- .../expedition/mod_expedition_safor.php | 12 +++--- .../modules/facture/doc/pdf_crabe.modules.php | 12 +++--- .../fichinter/doc/pdf_soleil.modules.php | 2 +- .../modules/fichinter/modules_fichinter.php | 17 ++++++--- .../modules/import/import_csv.modules.php | 37 +++++++++++++++++++ htdocs/core/modules/import/modules_import.php | 7 +++- .../livraison/pdf/pdf_sirocco.modules.php | 11 +++--- .../livraison/pdf/pdf_typhon.modules.php | 11 +++--- 9 files changed, 86 insertions(+), 35 deletions(-) diff --git a/htdocs/core/modules/expedition/mod_expedition_ribera.php b/htdocs/core/modules/expedition/mod_expedition_ribera.php index 3abdd89eef7..bf78250774e 100755 --- a/htdocs/core/modules/expedition/mod_expedition_ribera.php +++ b/htdocs/core/modules/expedition/mod_expedition_ribera.php @@ -93,9 +93,9 @@ class mod_expedition_ribera extends ModelNumRefExpedition /** * Return next value * - * @param objsoc third party object - * @param shipment shipment object - * @return string Value if OK, 0 if KO + * @param Societe $objsoc Third party object + * @param Object $shipment Shipment object + * @return string Value if OK, 0 if KO */ function getNextValue($objsoc,$shipment) { @@ -119,9 +119,9 @@ class mod_expedition_ribera extends ModelNumRefExpedition /** * Return next free value * - * @param objsoc Object third party - * @param objforref Object for number to search - * @return string Next free value + * @param Societe $objsoc Third party object + * @param Object $shipment Shipment object + * @return string Next free value */ function expedition_get_num($objsoc,$objforref) { diff --git a/htdocs/core/modules/expedition/mod_expedition_safor.php b/htdocs/core/modules/expedition/mod_expedition_safor.php index 9b7e631fd40..0b37886267b 100755 --- a/htdocs/core/modules/expedition/mod_expedition_safor.php +++ b/htdocs/core/modules/expedition/mod_expedition_safor.php @@ -93,9 +93,9 @@ class mod_expedition_safor extends ModelNumRefExpedition /** * Return next value * - * @param objsoc third party object - * @param shipment shipment object - * @return string Value if OK, 0 if KO + * @param Societe $objsoc Third party object + * @param Object $shipment Shipment object + * @return string Value if OK, 0 if KO */ function getNextValue($objsoc,$shipment) { @@ -131,9 +131,9 @@ class mod_expedition_safor extends ModelNumRefExpedition /** * Return next free value * - * @param objsoc Object third party - * @param objforref Object for number to search - * @return string Next free value + * @param Societe $objsoc Third party object + * @param Object $shipment Shipment object + * @return string Next free value */ function expedition_get_num($objsoc,$objforref) { diff --git a/htdocs/core/modules/facture/doc/pdf_crabe.modules.php b/htdocs/core/modules/facture/doc/pdf_crabe.modules.php index 1340fb06ae1..f26ed1e708a 100755 --- a/htdocs/core/modules/facture/doc/pdf_crabe.modules.php +++ b/htdocs/core/modules/facture/doc/pdf_crabe.modules.php @@ -468,13 +468,13 @@ class pdf_crabe extends ModelePDFFactures $pdf->line($tab3_posx, $tab3_top-1+$tab3_height, $tab3_posx+$tab3_width, $tab3_top-1+$tab3_height); $pdf->SetFont('','', $default_font_size - 4); - $pdf->SetXY($tab3_posx, $tab3_top ); + $pdf->SetXY($tab3_posx, $tab3_top); $pdf->MultiCell(20, 3, $outputlangs->transnoentities("Payment"), 0, 'L', 0); - $pdf->SetXY($tab3_posx+21, $tab3_top ); + $pdf->SetXY($tab3_posx+21, $tab3_top); $pdf->MultiCell(20, 3, $outputlangs->transnoentities("Amount"), 0, 'L', 0); - $pdf->SetXY($tab3_posx+40, $tab3_top ); + $pdf->SetXY($tab3_posx+40, $tab3_top); $pdf->MultiCell(20, 3, $outputlangs->transnoentities("Type"), 0, 'L', 0); - $pdf->SetXY($tab3_posx+58, $tab3_top ); + $pdf->SetXY($tab3_posx+58, $tab3_top); $pdf->MultiCell(20, 3, $outputlangs->transnoentities("Num"), 0, 'L', 0); $y=0; @@ -504,7 +504,7 @@ class pdf_crabe extends ModelePDFFactures $invoice->fetch($obj->fk_facture_source); - $pdf->SetXY($tab3_posx, $tab3_top+$y ); + $pdf->SetXY($tab3_posx, $tab3_top+$y); $pdf->MultiCell(20, 3, dol_print_date($obj->datef,'day',false,$outputlangs,true), 0, 'L', 0); $pdf->SetXY($tab3_posx+21, $tab3_top+$y); $pdf->MultiCell(20, 3, price($obj->amount_ttc), 0, 'L', 0); @@ -541,7 +541,7 @@ class pdf_crabe extends ModelePDFFactures $y+=3; $row = $this->db->fetch_object($resql); - $pdf->SetXY($tab3_posx, $tab3_top+$y ); + $pdf->SetXY($tab3_posx, $tab3_top+$y); $pdf->MultiCell(20, 3, dol_print_date($this->db->jdate($row->date),'day',false,$outputlangs,true), 0, 'L', 0); $pdf->SetXY($tab3_posx+21, $tab3_top+$y); $pdf->MultiCell(20, 3, price($row->amount), 0, 'L', 0); diff --git a/htdocs/core/modules/fichinter/doc/pdf_soleil.modules.php b/htdocs/core/modules/fichinter/doc/pdf_soleil.modules.php index d9e01feded9..e6ed5c267db 100644 --- a/htdocs/core/modules/fichinter/doc/pdf_soleil.modules.php +++ b/htdocs/core/modules/fichinter/doc/pdf_soleil.modules.php @@ -208,7 +208,7 @@ class pdf_soleil extends ModelePDFFicheinter $pdf->SetXY($this->marge_gauche, $tab_top); $pdf->MultiCell(190,8,$outputlangs->transnoentities("Description"),0,'L',0); - $pdf->line($this->marge_gauche, $tab_top + 8, $this->page_largeur-$this->marge_droite, $tab_top + 8 ); + $pdf->line($this->marge_gauche, $tab_top + 8, $this->page_largeur-$this->marge_droite, $tab_top + 8); $pdf->SetFont('', '', $default_font_size - 1); diff --git a/htdocs/core/modules/fichinter/modules_fichinter.php b/htdocs/core/modules/fichinter/modules_fichinter.php index 393a5a712c1..f286717caf5 100644 --- a/htdocs/core/modules/fichinter/modules_fichinter.php +++ b/htdocs/core/modules/fichinter/modules_fichinter.php @@ -69,6 +69,7 @@ abstract class ModeleNumRefFicheinter /** * Return if a module can be used or not + * * @return boolean true if module can be used */ function isEnabled() @@ -78,6 +79,7 @@ abstract class ModeleNumRefFicheinter /** * Renvoi la description par defaut du modele de numerotation + * * @return string Texte descripif */ function info() @@ -89,6 +91,7 @@ abstract class ModeleNumRefFicheinter /** * Renvoi un exemple de numerotation + * * @return string Example */ function getExample() @@ -101,6 +104,7 @@ abstract class ModeleNumRefFicheinter /** * Test si les numeros deja 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() @@ -110,6 +114,7 @@ abstract class ModeleNumRefFicheinter /** * Renvoi prochaine valeur attribuee + * * @return string Valeur */ function getNextValue() @@ -120,6 +125,7 @@ abstract class ModeleNumRefFicheinter /** * Renvoi version du module numerotation + * * @return string Valeur */ function getVersion() @@ -137,11 +143,12 @@ abstract class ModeleNumRefFicheinter /** * Create an intervention document on disk using template defined into FICHEINTER_ADDON_PDF - * @param db objet base de donnee - * @param object Object fichinter - * @param modele force le modele a utiliser ('' par defaut) - * @param outputlangs objet lang a utiliser pour traduction - * @return int 0 si KO, 1 si OK + * + * @param DoliDB $db objet base de donnee + * @param Object $object Object fichinter + * @param string $modele force le modele a utiliser ('' par defaut) + * @param Translate $outputlangs objet lang a utiliser pour traduction + * @return int 0 if KO, 1 if OK */ function fichinter_create($db, $object, $modele='', $outputlangs='') { diff --git a/htdocs/core/modules/import/import_csv.modules.php b/htdocs/core/modules/import/import_csv.modules.php index bc80f69fd21..243c8b382ba 100644 --- a/htdocs/core/modules/import/import_csv.modules.php +++ b/htdocs/core/modules/import/import_csv.modules.php @@ -84,36 +84,71 @@ class ImportCsv extends ModeleImports if (preg_match('/^societe_/',$datatoimport)) $this->thirpartyobject=new Societe($this->db); } + /** + * getDriverId + * + * @return int Id + */ function getDriverId() { return $this->id; } + /** + * getDriverLabel + * + * @return string Label + */ function getDriverLabel() { return $this->label; } + /** + * getDriverDesc + * + * @return string Description + */ function getDriverDesc() { return $this->desc; } + /** + * getDriverExtension + * + * @return string Driver suffix + */ function getDriverExtension() { return $this->extension; } + /** + * getDriverVersion + * + * @return string Driver version + */ function getDriverVersion() { return $this->version; } + /** + * getDriverLabel + * + * @return string Label of external lib + */ function getLibLabel() { return $this->label_lib; } + /** + * getLibVersion + * + * @return string Version of external lib + */ function getLibVersion() { return $this->version_lib; @@ -135,6 +170,7 @@ class ImportCsv extends ModeleImports * Output title line of an example file for this format * * @param Translate $outputlangs Output language + * @param array $headerlinefields Array of fields name * @return string */ function write_title_example($outputlangs,$headerlinefields) @@ -289,6 +325,7 @@ class ImportCsv extends ModeleImports * @param array $array_match_file_to_database Array of target fields where to insert data: [fieldpos] => 's.fieldname', [fieldpos+1]... * @param Object $objimport Object import (contains objimport->import_tables_array, objimport->import_fields_array, objimport->import_convertvalue_array, ...) * @param int $maxfields Max number of fields to use + * @param string $importid Import key * @return int <0 if KO, >0 if OK */ function import_insert($arrayrecord,$array_match_file_to_database,$objimport,$maxfields,$importid) diff --git a/htdocs/core/modules/import/modules_import.php b/htdocs/core/modules/import/modules_import.php index 8178d661e5b..dd7a6df60a9 100644 --- a/htdocs/core/modules/import/modules_import.php +++ b/htdocs/core/modules/import/modules_import.php @@ -113,6 +113,7 @@ class ModeleImports /** * Return picto of import driver * + * @param string $key Key * @return string */ function getPicto($key) @@ -123,6 +124,7 @@ class ModeleImports /** * Renvoi libelle d'un driver import * + * @param string $key Key * @return string */ function getDriverLabel($key) @@ -133,6 +135,7 @@ class ModeleImports /** * Renvoi la description d'un driver import * + * @param string $key Key * @return string */ function getDriverDesc($key) @@ -143,6 +146,7 @@ class ModeleImports /** * Renvoi version d'un driver import * + * @param string $key Key * @return string */ function getDriverVersion($key) @@ -153,6 +157,7 @@ class ModeleImports /** * Renvoi libelle de librairie externe du driver * + * @param string $key Key * @return string */ function getLibLabel($key) @@ -163,6 +168,7 @@ class ModeleImports /** * Renvoi version de librairie externe du driver * + * @param string $key Key * @return string */ function getLibVersion($key) @@ -172,5 +178,4 @@ class ModeleImports } - ?> diff --git a/htdocs/core/modules/livraison/pdf/pdf_sirocco.modules.php b/htdocs/core/modules/livraison/pdf/pdf_sirocco.modules.php index 459d0f571cc..d32f1370ef0 100644 --- a/htdocs/core/modules/livraison/pdf/pdf_sirocco.modules.php +++ b/htdocs/core/modules/livraison/pdf/pdf_sirocco.modules.php @@ -76,9 +76,10 @@ class pdf_sirocco extends ModelePDFDeliveryOrder /** * Fonction generant le bon de livraison sur le disque - * @param object Object livraison a generer - * @param outputlangs Lang output object - * @return int 1 if OK, <=0 if KO + * + * @param Object $object Object livraison a generer + * @param Translate $outputlangs Lang output object + * @return int 1 if OK, <=0 if KO */ function write_file($object,$outputlangs) { @@ -191,7 +192,7 @@ class pdf_sirocco extends ModelePDFDeliveryOrder $pdf->SetFont('','', $default_font_size - 1); // Dans boucle pour gerer multi-page $nexY = $pdf->GetY(); - $pdf->SetXY(10, $curY ); + $pdf->SetXY(10, $curY); $pdf->MultiCell(20, 3, $outputlangs->convToOutputCharset($object->lines[$i]->ref), 0, 'C'); @@ -199,7 +200,7 @@ class pdf_sirocco extends ModelePDFDeliveryOrder //$pdf->SetXY(133, $curY ); //$pdf->MultiCell(10, 5, $object->lines[$i]->tva_tx, 0, 'C'); - $pdf->SetXY(145, $curY ); + $pdf->SetXY(145, $curY); $pdf->MultiCell(10, 3, $object->lines[$i]->qty_shipped, 0, 'C'); // TODO Field not yet saved in database diff --git a/htdocs/core/modules/livraison/pdf/pdf_typhon.modules.php b/htdocs/core/modules/livraison/pdf/pdf_typhon.modules.php index d550f73b495..000b5537424 100644 --- a/htdocs/core/modules/livraison/pdf/pdf_typhon.modules.php +++ b/htdocs/core/modules/livraison/pdf/pdf_typhon.modules.php @@ -97,9 +97,10 @@ class pdf_typhon extends ModelePDFDeliveryOrder /** * Fonction generant le bon de livraison sur le disque - * @param object Object livraison a generer - * @param outputlangs Lang output object - * @return int 1 if OK, <=0 if KO + * + * @param Object $object Object livraison a generer + * @param Translate $outputlangs Lang output object + * @return int 1 if OK, <=0 if KO */ function write_file($object,$outputlangs) { @@ -470,11 +471,11 @@ class pdf_typhon extends ModelePDFDeliveryOrder // Modif Seb cadres signatures $pdf->SetFont('','', $default_font_size); $larg_sign = ($this->page_largeur-$this->marge_gauche-$this->marge_droite)/3; - $pdf->Rect($this->marge_gauche, ($tab_top + $tab_height + 3), $larg_sign, 25 ); + $pdf->Rect($this->marge_gauche, ($tab_top + $tab_height + 3), $larg_sign, 25); $pdf->SetXY($this->marge_gauche + 2, $tab_top + $tab_height + 5); $pdf->MultiCell($larg_sign,2, $outputlangs->trans("For").' '.$outputlangs->convToOutputCharset($mysoc->name).":",'','L'); - $pdf->Rect(2*$larg_sign+$this->marge_gauche, ($tab_top + $tab_height + 3), $larg_sign, 25 ); + $pdf->Rect(2*$larg_sign+$this->marge_gauche, ($tab_top + $tab_height + 3), $larg_sign, 25); $pdf->SetXY(2*$larg_sign+$this->marge_gauche + 2, $tab_top + $tab_height + 5); $pdf->MultiCell($larg_sign,2, $outputlangs->trans("ForCustomer").':','','L');