[Noalyss-commit] [noalyss] 113/151: Correct doxygen doc

[Dany De Bontridder]

sparkyx pushed a commit to branch master
in repository noalyss.

commit 78a499b1757c3a9c783d46e32f36bbb1b9c96574
Author: Rachel <address@hidden>
Date:   Thu Jan 12 16:58:11 2017 +0100

    Correct doxygen doc
    
    Signed-off-by: Dany De Bontridder <address@hidden>
---
 html/js/card.js                                   |    2 +-
 html/js/scripts.js                                |   14 +++++++-------
 include/class/class_document_type.php             |    2 +-
 include/lib/class_html_input.php                  |    3 +--
 include/lib/class_sendmail.php                    |    2 +-
 include/template/profile_menu_display_submenu.php |    4 ++--
 6 files changed, 13 insertions(+), 14 deletions(-)

diff --git a/html/js/card.js b/html/js/card.js
index eb8b799..8b4fa93 100644
--- a/html/js/card.js
+++ b/html/js/card.js
@@ -426,7 +426,7 @@ function fill_fin_data(text,li)
 /**
  address@hidden show the ipopup window and display the details of a card,
  * to work some attribute must be set
- address@hidden obj.qcode is the qcode, obj.nohistory if you don't want to  
display
+ address@hidden obj.qcode is the qcode, obj.nohistory if you don't want to  
display
  * the history button, obj.ro is the popin is readonly
  address@hidden you must the gDossier as hidden in the calling page
  *
diff --git a/html/js/scripts.js b/html/js/scripts.js
index a940bbd..08d0873 100644
--- a/html/js/scripts.js
+++ b/html/js/scripts.js
@@ -363,8 +363,8 @@ function change_month(obj)
  * the code. In that case, you need to create the object before the 
Ajax.Request
  *The difference with success box is that
  address@hidden add_div removeDiv success_box is that the width and height are 
not changed ajax_misc.php
- address@hidden code is the ID of the object containing the html (div, 
button...)
- address@hidden value is the html code, with it you fill the ctl element
+ address@hidden code is the ID of the object containing the html (div, 
button...)
+ address@hidden value is the html code, with it you fill the ctl element
  */
 
 function success_misc(req)
@@ -543,7 +543,7 @@ function popup_select_tva(obj)
 }
 /**
  address@hidden display the popup with vat and explanations
- address@hidden
+ address@hidden this function is not used anymore
  */
 function success_popup_select_tva_obsolete(req)
 {
@@ -1158,8 +1158,8 @@ function save_periode(obj)
  * the code. In that case, you need to create the object before the 
Ajax.Request
  *The difference with success box is that
  address@hidden add_div removeDiv success_box is that the width and height are 
not changed
- address@hidden ctl is the ID of the object containing the html (div, 
button...)
- address@hidden code is the html code, with it you fill the ctl element
+ address@hidden ctl is the ID of the object containing the html (div, 
button...)
+ address@hidden code is the html code, with it you fill the ctl element
  */
 function fill_box(req)
 {
@@ -1978,7 +1978,7 @@ function detail_category_show(p_div, p_dossier, p_id)
 /**
  * @brief check if the parameter is a valid a valid date or not, returns true 
if it is valid otherwise
  * false
- * @parameter p_str_date the string of the date (format DD.MM.YYYY)
+ * @param p_str_date the string of the date (format DD.MM.YYYY)
  */
 function check_date(p_str_date)
 {
@@ -2001,7 +2001,7 @@ function check_date(p_str_date)
 }
 /**
  * @brief get the string in the id and check if the date is valid
- * @parameter p_id_date is the id of the element to check
+ * @param p_id_date is the id of the element to check
  * @return true if the date is valid
  * @see check_date
  */
diff --git a/include/class/class_document_type.php 
b/include/class/class_document_type.php
index 8bb6121..0630adc 100644
--- a/include/class/class_document_type.php
+++ b/include/class/class_document_type.php
@@ -58,7 +58,7 @@ class Document_type
 
        /**
         * @brief get a list
-        * @parameter $p_cn database connection
+        * @param $p_cn database connection
         * @return array of data from document_type
         */
        static function get_list($p_cn)
diff --git a/include/lib/class_html_input.php b/include/lib/class_html_input.php
index 74b313b..d8915e3 100755
--- a/include/lib/class_html_input.php
+++ b/include/lib/class_html_input.php
@@ -908,9 +908,8 @@ class HtmlInput
             echo '</span>';
         }
         /**
-         * Returns HTML code for displaying a icon with a link to a receipt 
document from
+         * @brief Returns HTML code for displaying a icon with a link to a 
receipt document from
          * the ledger 
-         * @global $cn database connx
          * @param $p_jr_id jrn.jr_id
          * @param $p_name name in the link , if the name is empty then we show 
the icon
          * @return nothing or HTML Code for a link to the document
diff --git a/include/lib/class_sendmail.php b/include/lib/class_sendmail.php
index c5d0a6f..4f77359 100644
--- a/include/lib/class_sendmail.php
+++ b/include/lib/class_sendmail.php
@@ -39,7 +39,7 @@ class Sendmail
 
     /**
      * set the from
-     * @parameter $p_from has the form name <address@hidden>
+     * @param $p_from has the form name <address@hidden>
      */
     function set_from($p_from)
     {
diff --git a/include/template/profile_menu_display_submenu.php 
b/include/template/profile_menu_display_submenu.php
index ce69633..8479aaf 100644
--- a/include/template/profile_menu_display_submenu.php
+++ b/include/template/profile_menu_display_submenu.php
@@ -23,8 +23,8 @@
 /**
  * @file
  * @brief  display a submenu contained in a array
- * @parameter $a_module contains rows from profile_menu
- * @parameter $p_module_id is the module / menu id main menu
+ * @param $a_module contains rows from profile_menu
+ * @param $p_module_id is the module / menu id main menu
  * @see Profile_Menu::display_module_menu
  */
 ?>