doxygen

htdocs/core/modules/societe/mod_codeclient_elephant.php

@@ -4,6 +4,7 @@
  * Copyright (C) 2007-2012 Regis Houssin        <regis.houssin@inodbox.com>
  * Copyright (C) 2011      Juanjo Menent	    <jmenent@2byte.es>
  * Copyright (C) 2013-2018 Philippe Grand      	<philippe.grand@atoo-net.com>
+ * Copyright (C) 2020		Frédéric France		<frederic.france@netlogic.fr>
  *
  * 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
@@ -39,13 +40,25 @@ class mod_codeclient_elephant extends ModeleThirdPartyCode
 	 */
 	public $name = 'Elephant';
 
-	public $code_modifiable; // Code modifiable
+	/**
+	 * @var int Code modifiable
+	 */
+	public $code_modifiable;
 
-	public $code_modifiable_invalide; // Code modifiable si il est invalide
+	/**
+	 * @var int Code modifiable si il est invalide
+	 */
+	public $code_modifiable_invalide;
 
-	public $code_modifiable_null; // Code modifiables si il est null
+	/**
+	 * @var int Code modifiables si il est null
+	 */
+	public $code_modifiable_null;
 
-	public $code_null; // Code facultatif
+	/**
+	 * @var int Code facultatif
+	 */
+	public $code_null;
 
 	/**
 	 * Dolibarr version of the loaded document
@@ -58,11 +71,20 @@ class mod_codeclient_elephant extends ModeleThirdPartyCode
 	 */
 	public $code_auto;
 
-	public $searchcode; // String de recherche
+	/**
+	 * @var string search string
+	 */
+	public $searchcode;
 
-	public $numbitcounter; // Nombre de chiffres du compteur
+	/**
+	 * @var int Nombre de chiffres du compteur
+	 */
+	public $numbitcounter;
 
-	public $prefixIsRequired; // Le champ prefix du tiers doit etre renseigne quand on utilise {pre}
+	/**
+	 * @var int thirdparty prefix is required when using {pre}
+	 */
+	public $prefixIsRequired;
 
 
 	/**
@@ -138,6 +160,8 @@ class mod_codeclient_elephant extends ModeleThirdPartyCode
 	 */
 	public function getExample($langs, $objsoc = 0, $type = -1)
 	{
+		$examplecust = '';
+		$examplesup = '';
 		$errmsg = array(
 			"ErrorBadMask",
 			"ErrorCantUseRazIfNoYearInMask",