From afd3868a8a8e70d27eab5468ba8a46a5202639b3 Mon Sep 17 00:00:00 2001
From: Philippe GRAND <philippe.grand@atoo-net.com>
Date: Wed, 4 Jul 2018 14:38:56 +0200
Subject: [PATCH] docs: complete comments

---
 .../livraison/doc/pdf_typhon.modules.php      | 91 +++++++++++++++----
 .../project/doc/pdf_baleine.modules.php       | 73 ++++++++++++++-
 2 files changed, 145 insertions(+), 19 deletions(-)

diff --git a/htdocs/core/modules/livraison/doc/pdf_typhon.modules.php b/htdocs/core/modules/livraison/doc/pdf_typhon.modules.php
index 6b0bb759a19..f3329fa9b18 100644
--- a/htdocs/core/modules/livraison/doc/pdf_typhon.modules.php
+++ b/htdocs/core/modules/livraison/doc/pdf_typhon.modules.php
@@ -35,27 +35,82 @@ require_once DOL_DOCUMENT_ROOT.'/core/lib/pdf.lib.php';
 
 
 /**
- *	Classe permettant de generer les bons de livraison au modele Typho
+ *	Class to build Delivery Order documents with typhon model 
  */
 class pdf_typhon extends ModelePDFDeliveryOrder
 {
-    var $db;
-    var $name;
-    var $description;
-    var $type;
-
-    var $phpmin = array(4,3,0); // Minimum version of PHP required by module
-    var $version = 'dolibarr';
-
-    var $page_largeur;
-    var $page_hauteur;
-    var $format;
-	var $marge_gauche;
-	var	$marge_droite;
-	var	$marge_haute;
-	var	$marge_basse;
-
-	var $emetteur;	// Objet societe qui emet
+	/**
+     * @var DoliDb Database handler
+     */
+    public $db;
+    
+	/**
+     * @var string model name
+     */
+    public $name;
+    
+	/**
+     * @var string model description (short text)
+     */
+    public $description;
+    
+	/**
+     * @var string document type
+     */
+    public $type;
+    
+    /**
+     * @var array() Minimum version of PHP required by module.
+	 * e.g.: PHP ≥ 5.4 = array(5, 4)
+     */
+	public $phpmin = array(5, 4); 
+	
+	/**
+     * Dolibarr version of the loaded document
+     * @public string
+     */
+	public $version = 'dolibarr';
+	
+	/**
+     * @var int page_largeur
+     */
+    public $page_largeur;
+	
+	/**
+     * @var int page_hauteur
+     */
+    public $page_hauteur;
+	
+	/**
+     * @var array format
+     */
+    public $format;
+	
+	/**
+     * @var int marge_gauche
+     */
+	public $marge_gauche;
+	
+	/**
+     * @var int marge_droite
+     */
+	public $marge_droite;
+	
+	/**
+     * @var int marge_haute
+     */
+	public $marge_haute;
+	
+	/**
+     * @var int marge_basse
+     */
+	public $marge_basse;
+    
+	/**
+	 * Issuer
+	 * @var Societe
+	 */
+	public $emetteur;	// Objet societe qui emet
 
 	/**
 	 *	Constructor
diff --git a/htdocs/core/modules/project/doc/pdf_baleine.modules.php b/htdocs/core/modules/project/doc/pdf_baleine.modules.php
index baa38e8ad2d..384d192e1ed 100644
--- a/htdocs/core/modules/project/doc/pdf_baleine.modules.php
+++ b/htdocs/core/modules/project/doc/pdf_baleine.modules.php
@@ -38,7 +38,78 @@ require_once DOL_DOCUMENT_ROOT.'/core/lib/date.lib.php';
 
 class pdf_baleine extends ModelePDFProjects
 {
-	var $emetteur;	// Objet societe qui emet
+	/**
+     * @var DoliDb Database handler
+     */
+    public $db;
+    
+	/**
+     * @var string model name
+     */
+    public $name;
+    
+	/**
+     * @var string model description (short text)
+     */
+    public $description;
+    
+	/**
+     * @var string document type
+     */
+    public $type;
+    
+    /**
+     * @var array() Minimum version of PHP required by module.
+	 * e.g.: PHP ≥ 5.4 = array(5, 4)
+     */
+	public $phpmin = array(5, 4); 
+	
+	/**
+     * Dolibarr version of the loaded document
+     * @public string
+     */
+	public $version = 'dolibarr';
+	
+	/**
+     * @var int page_largeur
+     */
+    public $page_largeur;
+	
+	/**
+     * @var int page_hauteur
+     */
+    public $page_hauteur;
+	
+	/**
+     * @var array format
+     */
+    public $format;
+	
+	/**
+     * @var int marge_gauche
+     */
+	public $marge_gauche;
+	
+	/**
+     * @var int marge_droite
+     */
+	public $marge_droite;
+	
+	/**
+     * @var int marge_haute
+     */
+	public $marge_haute;
+	
+	/**
+     * @var int marge_basse
+     */
+	public $marge_basse;
+    
+	/**
+	 * Issuer
+	 * @var Societe
+	 */
+	public $emetteur;	// Objet societe qui emet
 
 	/**
 	 *	Constructor