[Noalyss-commit] [noalyss] 50/107: Documentation : automatic format breaks doxygen tag

[Dany De Bontridder]

sparkyx pushed a commit to branch master
in repository noalyss.

commit 35e3de4c7c3af08bf76ac5181614eaca47ef13d9
Author: Dany De Bontridder <address@hidden>
Date:   Sat Jul 27 20:03:46 2019 +0200

    Documentation : automatic format breaks doxygen tag
---
 include/ajax/ajax_search_operation.php |  2 +-
 include/class/dossier.class.php        | 16 ++++++++--------
 include/class/extension.class.php      | 10 +++++-----
 include/class/fiche.class.php          |  2 +-
 include/class/periode.class.php        | 34 ++++++++++++++++++----------------
 include/export/export_ledger_csv.php   |  2 +-
 include/lib/database_core.class.php    |  4 ++--
 include/lib/html_input.class.php       | 34 +++++++++++++++++-----------------
 include/lib/idate.class.php            |  4 ++--
 include/lib/inum.class.php             |  8 ++++----
 include/periode.inc.php                |  2 +-
 11 files changed, 60 insertions(+), 58 deletions(-)

diff --git a/include/ajax/ajax_search_operation.php 
b/include/ajax/ajax_search_operation.php
index 4b51987..68988ea 100644
--- a/include/ajax/ajax_search_operation.php
+++ b/include/ajax/ajax_search_operation.php
@@ -18,7 +18,7 @@
  *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
 // Copyright Author Dany De Bontridder address@hidden
-/* ! \file
+/*! \file
  * \brief Search module
  */
 if (!defined('ALLOWED'))
diff --git a/include/class/dossier.class.php b/include/class/dossier.class.php
index d1eadd3..23705b1 100644
--- a/include/class/dossier.class.php
+++ b/include/class/dossier.class.php
@@ -20,13 +20,13 @@
 
 // Copyright Author Dany De Bontridder address@hidden
 
-/* !\file
+/*!\file
  * \brief the class for the dossier, everywhere we need to know to
  * which folder we are connected, because we can't use $_SESSION, we
  * need to pass the dossier_id via a _GET or a POST variable
  */
 
-/* ! \brief manage the current dossier, everywhere we need to know to
+/*! \brief manage the current dossier, everywhere we need to know to
  * which folder we are connected, because we can't use $_SESSION, we
  * need to pass the dossier_id via a _GET or a POST variable
  *  private static $variable=array("id"=>"dos_id",
@@ -52,7 +52,7 @@ class Dossier
         $this->dos_id=$p_id;
     }
 
-    /* !\brief return the $_REQUEST['gDossier'] after a check */
+    /*!\brief return the $_REQUEST['gDossier'] after a check */
 
     static function id()
     {
@@ -127,7 +127,7 @@ class Dossier
         return $nb_folder;
     }
 
-    /* !
+    /*!
      * \brief Return all the users
      * as an array
      */
@@ -161,7 +161,7 @@ class Dossier
         return $res;
     }
 
-    /* !\brief check if gDossier is set */
+    /*!\brief check if gDossier is set */
 
     static function check()
     {
@@ -177,7 +177,7 @@ class Dossier
             exit('gDossier Invalide : '.$id);
     }
 
-    /* !
+    /*!
      * \brief return a string to put to gDossier into a GET 
      */
 
@@ -187,7 +187,7 @@ class Dossier
         return "gDossier=".$_REQUEST['gDossier'];
     }
 
-    /* !\brief return a string to set gDossier into a FORM */
+    /*!\brief return a string to set gDossier into a FORM */
 
     static function hidden()
     {
@@ -195,7 +195,7 @@ class Dossier
         return '<input type="hidden" id="gDossier" name="gDossier" 
value="'.$_REQUEST['gDossier'].'">';
     }
 
-    /* !\brief retrieve the name of the current dossier */
+    /*!\brief retrieve the name of the current dossier */
 
     static function name($id=0)
     {
diff --git a/include/class/extension.class.php 
b/include/class/extension.class.php
index 86e29a8..64e4d33 100644
--- a/include/class/extension.class.php
+++ b/include/class/extension.class.php
@@ -20,11 +20,11 @@
 
 // Copyright Author Dany De Bontridder address@hidden
 
-/* !\file
+/*!\file
  * \brief the extension class manages the plugins for the security, the access
  * the inclusion...
  */
-/* !\brief manage the extension, it involves the table extension
+/*!\brief manage the extension, it involves the table extension
  *
  * Data member
  * - $cn database connection
@@ -57,7 +57,7 @@ class Extension extends Menu_Ref_sql
             throw new Exception('Extension non trouvée, le chemin est-il 
correct?');
     }
 
-    /* !@brief search a extension, the what is the column (extends_code */
+    /*!@brief search a extension, the what is the column (extends_code */
 
     function search($p_what)
     {
@@ -67,7 +67,7 @@ class Extension extends Menu_Ref_sql
         return 1;
     }
 
-    /* !\brief return 1 if the user given in parameter can access this 
extension
+    /*!\brief return 1 if the user given in parameter can access this extension
      * otherwise returns 0
      * \param $p_login the user login
      * \return 1 has access, 0 has no access
@@ -86,7 +86,7 @@ class Extension extends Menu_Ref_sql
         return 0;
     }
 
-    /* !@brief make an array of the available plugin for the current user
+    /*!@brief make an array of the available plugin for the current user
      * @return  an array
      * @see ISelect
      */
diff --git a/include/class/fiche.class.php b/include/class/fiche.class.php
index 647b19b..f845842 100644
--- a/include/class/fiche.class.php
+++ b/include/class/fiche.class.php
@@ -184,7 +184,7 @@ class Fiche
         {
 
             /*
-                        * !! Missing attribute
+                        *!! Missing attribute
                         */
             foreach ($e->attribut as $f )
             {
diff --git a/include/class/periode.class.php b/include/class/periode.class.php
index dd63445..322dd12 100644
--- a/include/class/periode.class.php
+++ b/include/class/periode.class.php
@@ -20,10 +20,10 @@
 
 // Copyright Author Dany De Bontridder address@hidden
 
-/* !\file
+/*!\file
  * \brief definition of the class periode
  */
-/* !
+/*!
  * \brief For the periode tables parm_periode and jrn_periode
  */
 require_once NOALYSS_INCLUDE.'/lib/ac_common.php';
@@ -33,13 +33,13 @@ require_once 
NOALYSS_INCLUDE."/database/parm_periode_sql.class.php";
 class Periode
 {
 
-    var $cn;   /* !< database connection */
-    var $jrn_def_id;  /* !< the jr, 0 means all the ledger */
-    var $p_id;   /* !< pk of parm_periode */
-    var $status;   /* !< status is CL for closed, OP for
+    var $cn;   /*!< database connection */
+    var $jrn_def_id;  /*!< the jr, 0 means all the ledger */
+    var $p_id;   /*!< pk of parm_periode */
+    var $status;   /*!< status is CL for closed, OP for
       open and CE for centralized */
-    var $p_start;   /* !< start of the periode */
-    var $p_end;   /* !< end of the periode */
+    var $p_start;   /*!< start of the periode */
+    var $p_end;   /*!< end of the periode */
 
     function __construct($p_cn, $p_id=0)
     {
@@ -58,7 +58,8 @@ class Periode
         $this->p_id=$pp_id;
     }
 
-    /* !\brief return the p_id of the start and the end of the exercice
+    /**
+     * \brief return the p_id of the start and the end of the exercice
      * into an array
      * \param $p_exercice
      * \return array [start]=>,[end]=>
@@ -73,7 +74,8 @@ class Periode
         return array("start"=>$start, "end"=>$end);
     }
 
-    /* !\brief check if a periode is closed. If jrn_def_id is set to a no zero 
value then check only for this ledger
+    /*!
+    * \brief check if a periode is closed. If jrn_def_id is set to a no zero 
value then check only for this ledger
      * @see Periode::set_ledger
      * \return 1 is the periode is closed otherwise return 0
      */
@@ -274,7 +276,7 @@ class Periode
         }
     }
 
-    /* !\brief load data from database
+    /*!\brief load data from database
      * \return 0 on success and -1 on error
      */
 
@@ -295,7 +297,7 @@ class Periode
         return 0;
     }
 
-    /* !\brief return the max and the min periode of the exercice given
+    /*!\brief return the max and the min periode of the exercice given
      * in parameter
      * \param $p_exercice is the exercice
      * \return an array of Periode object
@@ -319,7 +321,7 @@ class Periode
         return array($rMax, $rMin);
     }
 
-    /* !
+    /*!
      * \brief Give the start & end date of a periode
      * \param $p_periode is the periode id, if omitted the value is the 
current object
      * \return array containing the start date & the end date, index are 
p_start and p_end or NULL if
@@ -344,7 +346,7 @@ class Periode
         return Database::fetch_array($Res, 0);
     }
 
-    /* !\brief return the first day of periode
+    /*!\brief return the first day of periode
      * the this->p_id must be set
      * \return a string with the date (DD.MM.YYYY)
      */
@@ -357,7 +359,7 @@ class Periode
         return $p_start;
     }
 
-    /* !\brief return the last day of periode
+    /*!\brief return the last day of periode
      * the this->p_id must be set
      * \return a string with the date (DD.MM.YYYY)
      */
@@ -381,7 +383,7 @@ class Periode
         return Database::fetch_result($Res, 0, 0);
     }
 
-    /* !\brief retrieve the periode thanks the date_end
+    /*!\brief retrieve the periode thanks the date_end
      * \param $p_date format DD.MM.YYYY
      * \return the periode id
      * \exception if not periode is found or if more than one periode is found
diff --git a/include/export/export_ledger_csv.php 
b/include/export/export_ledger_csv.php
index f5b9109..b1eabe9 100644
--- a/include/export/export_ledger_csv.php
+++ b/include/export/export_ledger_csv.php
@@ -18,7 +18,7 @@
  *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
 // Copyright Author Dany De Bontridder address@hidden
-/* ! 
+/*! 
  * \file
  * \brief Send a ledger in CSV format , receives 
  *    - jrn_id id of the ledger
diff --git a/include/lib/database_core.class.php 
b/include/lib/database_core.class.php
index aa0aa59..ff42ea6 100644
--- a/include/lib/database_core.class.php
+++ b/include/lib/database_core.class.php
@@ -549,7 +549,7 @@ class DatabaseCore
     }
 
     /*
-     * !\brief test if a view exist
+     *!\brief test if a view exist
      * \return true if the view. exist otherwise false
      */
 
@@ -562,7 +562,7 @@ class DatabaseCore
     }
 
     /*
-     * !\brief test if a schema exists
+     *!\brief test if a schema exists
      * \return true if the schemas exists otherwise false
      */
 
diff --git a/include/lib/html_input.class.php b/include/lib/html_input.class.php
index 3fffb05..765643b 100755
--- a/include/lib/html_input.class.php
+++ b/include/lib/html_input.class.php
@@ -22,11 +22,11 @@ require_once NOALYSS_INCLUDE.'/lib/icon_action.class.php';
 
 // Copyright Author Dany De Bontridder address@hidden
 
-/* ! \file
+/*! \file
  * \brief This class is used to create all the HTML INPUT TYPE
  */
 
-/* !
+/*!
  * \brief class widget This class is used to create all the HTML INPUT TYPE
  *        and some specials which works with javascript like
  *        js_search.
@@ -55,20 +55,20 @@ require_once NOALYSS_INCLUDE.'/lib/icon_action.class.php';
 class HtmlInput
 {
 
-    var $type;                      /* !<  $type type of the widget */
-    var $name;                      /* !<  $name field NAME of the INPUT */
-    var $value;                     /* !<  $value what the INPUT contains */
-    var $readOnly;                  /* !<  $readonly true : we cannot change 
value */
-    var $size;                      /* !<  $size size of the input */
-    var $selected;                  /* !<  $selected for SELECT RADIO and 
CHECKBOX the selected value */
-    var $table;                     /* !<  $table =1 add the table tag */
-    var $label;                     /* !<  $label the question before the 
input */
-    var $disabled;                  /* !<  $disabled poss. value == true or 
nothing, to disable INPUT */
-    var $extra;                     /* !<  $extra different usage, it depends 
of the $type */
-    var $extra2;                    /* !<  $extra2 different usage,
+    var $type;                      /*!<  $type type of the widget */
+    var $name;                      /*!<  $name field NAME of the INPUT */
+    var $value;                     /*!<  $value what the INPUT contains */
+    var $readOnly;                  /*!<  $readonly true : we cannot change 
value */
+    var $size;                      /*!<  $size size of the input */
+    var $selected;                  /*!<  $selected for SELECT RADIO and 
CHECKBOX the selected value */
+    var $table;                     /*!<  $table =1 add the table tag */
+    var $label;                     /*!<  $label the question before the input 
*/
+    var $disabled;                  /*!<  $disabled poss. value == true or 
nothing, to disable INPUT */
+    var $extra;                     /*!<  $extra different usage, it depends 
of the $type */
+    var $extra2;                    /*!<  $extra2 different usage,
       it depends of the $type */
-    var $javascript;                /* !< $javascript  is the javascript to 
add to the widget */
-    var $ctrl;   /* !<$ctrl is the control to update (see 
js_search_card_control) */
+    var $javascript;                /*!< $javascript  is the javascript to add 
to the widget */
+    var $ctrl;   /*!<$ctrl is the control to update (see 
js_search_card_control) */
     var $tabindex;
 
     function __construct($p_name="", $p_value="", $p_id="")
@@ -94,7 +94,7 @@ class HtmlInput
         $this->readOnly=$p_read;
     }
 
-    /* !\brief set the extra javascript property for the INPUT field
+    /*!\brief set the extra javascript property for the INPUT field
      * \param $p_name name of the parameter
      * \param $p_value default value of this parameter
      */
@@ -229,7 +229,7 @@ class HtmlInput
         return self::hidden('plugin_code', $_REQUEST['plugin_code']);
     }
 
-    /* !\brief create a button with a ref
+    /*!\brief create a button with a ref
      * \param $p_label the text
      * \param $p_value the location of the window,
      * \param $p_name the id of the span
diff --git a/include/lib/idate.class.php b/include/lib/idate.class.php
index b3a466b..f61901f 100644
--- a/include/lib/idate.class.php
+++ b/include/lib/idate.class.php
@@ -47,7 +47,7 @@ class IDate extends HtmlInput
         $this->autofocus=false;
     }
 
-    /* !\brief show the html  input of the widget */
+    /*!\brief show the html  input of the widget */
 
     public function input($p_name=null, $p_value=null)
     {
@@ -90,7 +90,7 @@ class IDate extends HtmlInput
         return $r;
     }
 
-    /* !\brief print in html the readonly value of the widget */
+    /*!\brief print in html the readonly value of the widget */
 
     public function display()
     {
diff --git a/include/lib/inum.class.php b/include/lib/inum.class.php
index e6375fe..f2755c4 100644
--- a/include/lib/inum.class.php
+++ b/include/lib/inum.class.php
@@ -20,11 +20,11 @@
 
 // Copyright Author Dany De Bontridder address@hidden
 
-/* !\file
+/*!\file
  * \brief for the numeric input text field
  */
 require_once NOALYSS_INCLUDE.'/lib/itext.class.php';
-/* !\brief
+/*!\brief
  * This class handles only the numeric input, the input will
  * call a javascript
  * to change comma to period  and will round it (2 decimal), the precision is 
given by
@@ -51,7 +51,7 @@ class INum extends IText
         $this->javascript='onchange="format_number(this,2);"';
     }
 
-    /* !\brief print in html the readonly value of the widget */
+    /*!\brief print in html the readonly value of the widget */
 
     public function display()
     {
@@ -73,7 +73,7 @@ class INum extends IText
         return $r;
     }
 
-    /* !\brief show the html  input of the widget */
+    /*!\brief show the html  input of the widget */
 
     public function input($p_name=null, $p_value=null)
     {
diff --git a/include/periode.inc.php b/include/periode.inc.php
index 3feaad4..36791c4 100644
--- a/include/periode.inc.php
+++ b/include/periode.inc.php
@@ -17,7 +17,7 @@
  *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
 // Copyright Author Dany De Bontridder address@hidden
-/* ! \file
+/*! \file
  * \brief add, modify, close or delete a period
  */
 if (!defined('ALLOWED'))