Doxygen

htdocs/lib/pdf.lib.php

@@ -29,6 +29,7 @@
 
 /**
  *      Return array with format properties of default PDF format
+ *
  *      @return     array		Array('width'=>w,'height'=>h,'unit'=>u);
  */
 function pdf_getFormat()
@@ -65,6 +66,7 @@ function pdf_getFormat()
 
 /**
  *      Return a PDF instance object. We create a FPDI instance that instanciate TCPDF.
+ *
  *      @param      format          Array(width,height). Keep empty to use default setup.
  *      @param      metric          Unit of format ('mm')
  *      @param      pagetype        'P' or 'l'
@@ -124,6 +126,7 @@ function pdf_getInstance($format='',$metric='mm',$pagetype='P')
 
 /**
  *      Return font name to use for PDF generation
+ *
  *      @param      outputlangs     Output langs object
  *      @return     string          Name of font to use
  */
@@ -142,6 +145,7 @@ function pdf_getPDFFont($outputlangs)
 
 /**
  *      Return font size to use for PDF generation
+ *
  *      @param      outputlangs     Output langs object
  *      @return     int             Size of font to use
  */
@@ -161,6 +165,7 @@ function pdf_getPDFFontSize($outputlangs)
 
 /**
  *      Return a formated address (part address/zip/town/state) according to country rules
+ *
  *      @param      outputlangs     Output langs object
  *      @param      object          A company or contact object
  *      @return     string          Formated string
@@ -350,6 +355,7 @@ function pdf_watermark(&$pdf, $outputlangs, $h, $w, $unit, $text)
 
 /**
  *   	Show bank informations for PDF generation
+ *
  *      @param      pdf             Object PDF
  *      @param      outputlangs     Object lang
  *      @param      curx            X
@@ -505,6 +511,7 @@ function pdf_bank(&$pdf,$outputlangs,$curx,$cury,$account,$onlynumber=0)
  * 		@param		page_hauteur	Page height
  * 		@param		object			Object shown in PDF
  * 		@param		showdetails		Show company details
+ * 		@return		void
  */
 function pdf_pagefoot(&$pdf,$outputlangs,$paramfreetext,$fromcompany,$marge_basse,$marge_gauche,$page_hauteur,$object,$showdetails=0)
 {
@@ -705,6 +712,7 @@ function pdf_pagefoot(&$pdf,$outputlangs,$paramfreetext,$fromcompany,$marge_bass
  *  @param      int				$hidedesc            Hide description
  * 	@param		int				$issupplierline		Is it a line for a supplier object ?
  * 	@param		HookManager		$hookmanager		Instance of HookManager
+ * 	@return		void
  */
 function pdf_writelinedesc(&$pdf,$object,$i,$outputlangs,$w,$h,$posx,$posy,$hideref=0,$hidedesc=0,$issupplierline=0,$hookmanager=false)
 {
@@ -731,12 +739,12 @@ function pdf_writelinedesc(&$pdf,$object,$i,$outputlangs,$w,$h,$posx,$posy,$hide
 /**
  *  Return line description translated in outputlangs and encoded in UTF8
  *
- *  @param      object              Object
+ *  @param      Object		$object              Object
- *  @param      i                   Current line number
+ *  @param      int			$i                   Current line number
- *  @param      outputlangs         Object langs for output
+ *  @param      Translate	$outputlangs         Object langs for output
- *  @param      hideref             Hide reference
+ *  @param      int			$hideref             Hide reference
- *  @param      hidedesc            Hide description
+ *  @param      int			$hidedesc            Hide description
- *  @param      issupplierline      Is it a line for a supplier object ?
+ *  @param      int			$issupplierline      Is it a line for a supplier object ?
  *  @return     string       				     String with line
  */
 function pdf_getlinedesc($object,$i,$outputlangs,$hideref=0,$hidedesc=0,$issupplierline=0)
@@ -869,6 +877,7 @@ function pdf_getlinedesc($object,$i,$outputlangs,$hideref=0,$hidedesc=0,$issuppl
  *  @param    	Translate	$outputlangs		Object langs for output
  *  @param		int			$hidedetails		Hide details (0=no, 1=yes, 2=just special lines)
  *  @param		HookManager	$hookmanager		Hook manager instance
+ * 	@return		void
  */
 function pdf_getlinenum($object,$i,$outputlangs,$hidedetails=0,$hookmanager=false)
 {
@@ -893,6 +902,7 @@ function pdf_getlinenum($object,$i,$outputlangs,$hidedetails=0,$hookmanager=fals
  *  @param    	Translate	$outputlangs		Object langs for output
  *  @param		int			$hidedetails		Hide details (0=no, 1=yes, 2=just special lines)
  *  @param		HookManager	$hookmanager		Hook manager instance
+ * 	@return		void
  */
 function pdf_getlineref($object,$i,$outputlangs,$hidedetails=0,$hookmanager=false)
 {
@@ -916,6 +926,7 @@ function pdf_getlineref($object,$i,$outputlangs,$hidedetails=0,$hookmanager=fals
  *  @param    	Translate	$outputlangs		Object langs for output
  *  @param		int			$hidedetails		Hide details (0=no, 1=yes, 2=just special lines)
  *  @param		HookManager	$hookmanager		Hook manager instance
+ * 	@return		void
  */
 function pdf_getlineref_supplier($object,$i,$outputlangs,$hidedetails=0,$hookmanager=false)
 {
@@ -939,6 +950,7 @@ function pdf_getlineref_supplier($object,$i,$outputlangs,$hidedetails=0,$hookman
  *  @param    	Translate	$outputlangs		Object langs for output
  *  @param		int			$hidedetails		Hide details (0=no, 1=yes, 2=just special lines)
  *  @param		HookManager	$hookmanager		Hook manager instance
+ * 	@return		void
  */
 function pdf_getlinevatrate($object,$i,$outputlangs,$hidedetails=0,$hookmanager=false)
 {
@@ -963,6 +975,7 @@ function pdf_getlinevatrate($object,$i,$outputlangs,$hidedetails=0,$hookmanager=
  *  @param    	Translate	$outputlangs		Object langs for output
  *  @param		int			$hidedetails		Hide details (0=no, 1=yes, 2=just special lines)
  *  @param		HookManager	$hookmanager		Hook manager instance
+ * 	@return		void
  */
 function pdf_getlineupexcltax($object,$i,$outputlangs,$hidedetails=0,$hookmanager=false)
 {
@@ -1014,6 +1027,7 @@ function pdf_getlineqty($object,$i,$outputlangs,$hidedetails=0,$hookmanager=fals
  *  @param    	Translate	$outputlangs		Object langs for output
  *  @param		int			$hidedetails		Hide details (0=no, 1=yes, 2=just special lines)
  *  @param		HookManager	$hookmanager		Hook manager instance
+ * 	@return		void
  */
 function pdf_getlineqty_asked($object,$i,$outputlangs,$hidedetails=0,$hookmanager=false)
 {
@@ -1041,6 +1055,7 @@ function pdf_getlineqty_asked($object,$i,$outputlangs,$hidedetails=0,$hookmanage
  *  @param    	Translate	$outputlangs		Object langs for output
  *  @param		int			$hidedetails		Hide details (0=no, 1=yes, 2=just special lines)
  *  @param		HookManager	$hookmanager		Hook manager instance
+ * 	@return		void
  */
 function pdf_getlineqty_shipped($object,$i,$outputlangs,$hidedetails=0,$hookmanager=false)
 {
@@ -1068,6 +1083,7 @@ function pdf_getlineqty_shipped($object,$i,$outputlangs,$hidedetails=0,$hookmana
  *  @param    	Translate	$outputlangs		Object langs for output
  *  @param		int			$hidedetails		Hide details (0=no, 1=yes, 2=just special lines)
  *  @param		HookManager	$hookmanager		Hook manager instance
+ * 	@return		void
  */
 function pdf_getlineqty_keeptoship($object,$i,$outputlangs,$hidedetails=0,$hookmanager=false)
 {
@@ -1095,6 +1111,7 @@ function pdf_getlineqty_keeptoship($object,$i,$outputlangs,$hidedetails=0,$hookm
  *  @param    	Translate	$outputlangs		Object langs for output
  *  @param		int			$hidedetails		Hide details (0=no, 1=yes, 2=just special lines)
  *  @param		HookManager	$hookmanager		Hook manager instance
+ * 	@return		void
  */
 function pdf_getlineremisepercent($object,$i,$outputlangs,$hidedetails=0,$hookmanager=false)
 {
@@ -1124,6 +1141,7 @@ function pdf_getlineremisepercent($object,$i,$outputlangs,$hidedetails=0,$hookma
  *  @param    	Translate	$outputlangs		Object langs for output
  *  @param		int			$hidedetails		Hide details (0=no, 1=yes, 2=just special lines)
  *  @param		HookManager	$hookmanager		Hook manager instance
+ * 	@return		void
  */
 function pdf_getlinetotalexcltax($object,$i,$outputlangs,$hidedetails=0,$hookmanager=false)
 {
@@ -1154,6 +1172,7 @@ function pdf_getlinetotalexcltax($object,$i,$outputlangs,$hidedetails=0,$hookman
  *	@param		string		$type				Type
  *  @param    	Translate	$outputlangs		Object langs for output
  *  @param		HookManager	$hookmanager		Hook manager instance
+ * 	@return		void
  */
 function pdf_getTotalQty($object,$type='',$outputlangs,$hookmanager=false)
 {