From b05468074c3e282492a8e78d2e37f17f5b73728b Mon Sep 17 00:00:00 2001 From: Laurent Destailleur Date: Wed, 21 Jul 2010 17:58:22 +0000 Subject: [PATCH] Doxygen --- htdocs/core/class/menubase.class.php | 6 ++++-- htdocs/core/class/translate.class.php | 10 +++++----- htdocs/user/class/user.class.php | 4 ++-- 3 files changed, 11 insertions(+), 9 deletions(-) diff --git a/htdocs/core/class/menubase.class.php b/htdocs/core/class/menubase.class.php index c4b149f4a43..0da4e906d0f 100644 --- a/htdocs/core/class/menubase.class.php +++ b/htdocs/core/class/menubase.class.php @@ -57,8 +57,10 @@ class Menubase /** - * \brief Constructor - * \param DB Database handler + * Constructor + * @param DB Database handler + * @param menu_handler + * @param type */ function Menubase($DB,$menu_handler='',$type='') { diff --git a/htdocs/core/class/translate.class.php b/htdocs/core/class/translate.class.php index 9a983e7b03b..dc8b4292409 100644 --- a/htdocs/core/class/translate.class.php +++ b/htdocs/core/class/translate.class.php @@ -129,7 +129,7 @@ class Translate { * All data in translation array are stored in UTF-8 format. * \param domain File name to load (.lang file). Use file@module if file is in a module directory. * \param alt 0 (try xx_ZZ then 1), 1 (try xx_XX then 2), 2 (try en_US or fr_FR or es_ES) - * \param soptafterdirection Stop when the DIRECTION tag is found (optimize) + * \param stopafterdirection Stop when the DIRECTION tag is found (optimize) * \param forcelangdir To force a lang directory * \return int <0 if KO, 0 if already loaded, >0 if OK * \remarks tab_loaded is completed with $domain key. @@ -355,10 +355,10 @@ class Translate { } /** - * Enter description here... + * Return translated value of key * - * @param unknown_type $key - * @return unknown + * @param key + * @return string */ function getTradFromKey($key) { @@ -583,7 +583,7 @@ class Translate { /** * \brief Return full text translated to language label for a key. Store key-label in a cache. - * \number number Number to encode in full text + * \param number Number to encode in full text * \param isamount 1=It's an amount, 0=it's just a number * \return string Label translated in UTF8 (but without entities) * 10 if setDefaultLang was en_US => ten diff --git a/htdocs/user/class/user.class.php b/htdocs/user/class/user.class.php index d93189dc0c7..0a97656813b 100644 --- a/htdocs/user/class/user.class.php +++ b/htdocs/user/class/user.class.php @@ -619,8 +619,8 @@ class User extends CommonObject /** - * \brief Delete the user - * \param int <0 if KO, >0 if OK + * Delete the user + * @return int <0 if KO, >0 if OK */ function delete() {