Merge pull request #5616 from marcosgdf/phpdoc

Little changes to PHPDoc comment block
This commit is contained in:
Laurent Destailleur
2016-08-17 15:59:08 +02:00
committed by GitHub
2 changed files with 13 additions and 11 deletions

View File

@@ -119,12 +119,14 @@ function dolGetModulesDirs($subdir='')
* @param Translate $outputlangs Output lang to use to autodetect output format if setup not done
* @return string Default paper format code
*/
function dol_getDefaultFormat($outputlangs='')
function dol_getDefaultFormat(Translate $outputlangs = null)
{
global $langs;
$selected='EUA4';
if (empty($outputlangs) || ! is_object($outputlangs)) $outputlangs=$langs;
if (!$outputlangs) {
$outputlangs=$langs;
}
if ($outputlangs->defaultlang == 'ca_CA') $selected='CAP4'; // Canada
if ($outputlangs->defaultlang == 'en_US') $selected='USLetter'; // US
@@ -1617,7 +1619,7 @@ function dol_buildlogin($lastname,$firstname)
/**
* Return array to use for SoapClient constructor
*
* @return param
* @return array
*/
function getSoapParams()
{

View File

@@ -39,7 +39,7 @@
* @param Translate $outputlangs Output lang to use to autodetect output format if setup not done
* @return array Array('width'=>w,'height'=>h,'unit'=>u);
*/
function pdf_getFormat($outputlangs='')
function pdf_getFormat(Translate $outputlangs = null)
{
global $conf,$db;
@@ -77,7 +77,7 @@ function pdf_getFormat($outputlangs='')
* @param string $format Array(width,height). Keep empty to use default setup.
* @param string $metric Unit of format ('mm')
* @param string $pagetype 'P' or 'l'
* @return TPDF PDF object
* @return TCPDF PDF object
*/
function pdf_getInstance($format='',$metric='mm',$pagetype='P')
{
@@ -568,7 +568,7 @@ function pdf_build_address($outputlangs,$sourcecompany,$targetcompany='',$target
/**
* Show header of page for PDF generation
*
* @param PDF $pdf Object PDF
* @param TCPDF $pdf Object PDF
* @param Translate $outputlangs Object lang for output
* @param int $page_height Height of page
* @return void
@@ -589,7 +589,7 @@ function pdf_pagehead(&$pdf,$outputlangs,$page_height)
/**
* Add a draft watermark on PDF files
*
* @param PDF $pdf Object PDF
* @param TCPDF $pdf Object PDF
* @param Translate $outputlangs Object lang
* @param int $h Height of PDF
* @param int $w Width of PDF
@@ -629,7 +629,7 @@ function pdf_watermark(&$pdf, $outputlangs, $h, $w, $unit, $text)
/**
* Show bank informations for PDF generation
*
* @param PDF $pdf Object PDF
* @param TCPDF $pdf Object PDF
* @param Translate $outputlangs Object lang
* @param int $curx X
* @param int $cury Y
@@ -805,7 +805,7 @@ function pdf_bank(&$pdf,$outputlangs,$curx,$cury,$account,$onlynumber=0,$default
/**
* Show footer of page for PDF generation
*
* @param PDF $pdf The PDF factory
* @param TCPDF $pdf The PDF factory
* @param Translate $outputlangs Object lang for output
* @param string $paramfreetext Constant name of free text
* @param Societe $fromcompany Object company
@@ -1037,7 +1037,7 @@ function pdf_pagefoot(&$pdf,$outputlangs,$paramfreetext,$fromcompany,$marge_bass
/**
* Show linked objects for PDF generation
*
* @param PDF $pdf Object PDF
* @param TCPDF $pdf Object PDF
* @param object $object Object
* @param Translate $outputlangs Object lang
* @param int $posx X
@@ -1074,7 +1074,7 @@ function pdf_writeLinkedObjects(&$pdf,$object,$outputlangs,$posx,$posy,$w,$h,$al
/**
* Output line description into PDF
*
* @param PDF $pdf PDF object
* @param TCPDF $pdf PDF object
* @param Object $object Object
* @param int $i Current line number
* @param Translate $outputlangs Object lang for output