From 2c41610ac82dbc29ff98eab59882ccbf124d256b Mon Sep 17 00:00:00 2001 From: Philippe GRAND Date: Mon, 1 Apr 2019 09:21:08 +0200 Subject: [PATCH] update comments --- .../facture/doc/pdf_sponge.modules.php | 2 +- .../modules/propale/doc/pdf_cyan.modules.php | 76 ++++++++++++++++--- 2 files changed, 67 insertions(+), 11 deletions(-) diff --git a/htdocs/core/modules/facture/doc/pdf_sponge.modules.php b/htdocs/core/modules/facture/doc/pdf_sponge.modules.php index 4be117bff0b..aace72ca1da 100644 --- a/htdocs/core/modules/facture/doc/pdf_sponge.modules.php +++ b/htdocs/core/modules/facture/doc/pdf_sponge.modules.php @@ -43,7 +43,7 @@ require_once DOL_DOCUMENT_ROOT.'/core/lib/pdf.lib.php'; */ class pdf_sponge extends ModelePDFFactures { - /** + /** * @var DoliDb Database handler */ public $db; diff --git a/htdocs/core/modules/propale/doc/pdf_cyan.modules.php b/htdocs/core/modules/propale/doc/pdf_cyan.modules.php index 668693e67cc..c25d1d9e3a1 100644 --- a/htdocs/core/modules/propale/doc/pdf_cyan.modules.php +++ b/htdocs/core/modules/propale/doc/pdf_cyan.modules.php @@ -7,7 +7,7 @@ * Copyright (C) 2012 Cedric Salvador * Copyright (C) 2015 Marcos García * Copyright (C) 2017 Ferran Marcet - * Copyright (C) 2018 Frédéric France + * Copyright (C) 2018 Frédéric France * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -45,23 +45,79 @@ class pdf_cyan extends ModelePDFPropales * @var DoliDb Database handler */ public $db; - public $name; - public $description; - public $update_main_doc_field; // Save the name of generated file as the main doc when generating a doc with this template - public $type; - public $phpmin = array(5, 4); // Minimum version of PHP required by module + /** + * @var string model name + */ + public $name; + + /** + * @var string model description (short text) + */ + public $description; + + /** + * @var int Save the name of generated file as the main doc when generating a doc with this template + */ + public $update_main_doc_field; + + /** + * @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 = 'development'; - public $page_largeur; - public $page_hauteur; - public $format; + /** + * @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; - public $emetteur; // Objet societe qui emet + /** + * Issuer + * @var Societe + */ + public $emetteur; /**