Fix Doxygen issue : @example must be in a function otherwise the detailed section of Doxygen disappear

This commit is contained in:
Dany De Bontridder 2017-10-15 00:54:27 +02:00
parent 56fd6e0635
commit 3ab3cf984e
2 changed files with 12 additions and 9 deletions

View file

@ -38,6 +38,7 @@ class HttpInput
* @param $p_name name of the variable
* @param $p_type type of the variable (number,string,date,array)
* @throws Exception if the variable doesn't exist or type incorrect
* @todo Add regex:pattern
*/
function check_type($p_name, $p_type)
{

View file

@ -18,17 +18,17 @@
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
// Copyright Author Dany De Bontridder danydb@aevalys.eu
///@file
///@brief Definition Manage_Table_SQL
/*!\file
* \brief Definition Manage_Table_SQL
*
*/
/**
* @brief Purpose is to propose a librairy to display a table content
/*!\brief Purpose is to propose a librairy to display a table content
* and allow to update and delete row , handle also the ajax call
* thanks the script managetable.js
*
* Code for ajax , here we see the ajax_input for creating a dg box
@code
\code
$objet->set_pk($p_id);
$objet->set_object_name($objet_name);
@ -55,9 +55,9 @@
echo $xml->save_XML();
@endcode
* @see ManageTable.js
*
*/
///@example test_manage_table_sql.php
/// For ajax @example ajax_manage_table_sql.php
class Manage_Table_SQL
{
@ -85,6 +85,8 @@ class Manage_Table_SQL
* @brief Constructor : set the label to the column name,
* the order of the column , set the properties and the
* permission for updating or deleting row
* @example test_manage_table_sql.php
* @example ajax_manage_table_sql.php
*/
function __construct(Data_SQL $p_table)
@ -694,7 +696,7 @@ function check()
$js=sprintf("%s.delete('%s','%s');", $this->object_name,
$p_row[$this->table->primary_key], $this->object_name
);
echo HtmlInput::image_click("delete.gif", $js, _("Effacer"));
echo HtmlInput::image_click("trash-24.gif", $js, _("Effacer"));
echo "</td>";
}
}