From 4bf7706e387e7da524ffdff4757380b9c38bbeb8 Mon Sep 17 00:00:00 2001 From: Laurent Destailleur Date: Sat, 3 Sep 2011 00:27:02 +0000 Subject: [PATCH] Doxygen --- .../cheque/class/remisecheque.class.php | 23 +++++++++++-------- htdocs/core/class/rssparser.class.php | 20 +++++++++------- 2 files changed, 26 insertions(+), 17 deletions(-) diff --git a/htdocs/compta/paiement/cheque/class/remisecheque.class.php b/htdocs/compta/paiement/cheque/class/remisecheque.class.php index 624fa15de78..571563521d7 100644 --- a/htdocs/compta/paiement/cheque/class/remisecheque.class.php +++ b/htdocs/compta/paiement/cheque/class/remisecheque.class.php @@ -1,6 +1,6 @@ - * Copyright (C) 2007-2008 Laurent Destailleur + * Copyright (C) 2007-2011 Laurent Destailleur * Copyright (C) 2005-2009 Regis Houssin * Copyright (C) 2011 Juanjo Menent * @@ -44,9 +44,9 @@ class RemiseCheque extends CommonObject var $errno; /** - * \brief Constructeur de la classe - * \param DB handler acces base de donnees - * \param id id compte (0 par defaut) + * Constructor + * + * @param DoliDB $DB Database handler */ function RemiseCheque($DB) { @@ -56,10 +56,11 @@ class RemiseCheque extends CommonObject } /** - * \brief Load record - * \param id Id record - * \param ref Ref record - * \return int <0 if KO, > 0 if OK + * Load record + * + * @param id Id record + * @param ref Ref record + * @return int <0 if KO, > 0 if OK */ function fetch($id,$ref='') { @@ -113,6 +114,7 @@ class RemiseCheque extends CommonObject /** * Create a receipt to send cheques + * * @param user User making creation * @param account_id Bank account for cheque receipt * @param limit Limit number of cheque to this @@ -270,6 +272,7 @@ class RemiseCheque extends CommonObject /** * Supprime la remise en base + * * @param user utilisateur qui effectue l'operation */ function delete($user='') @@ -324,6 +327,7 @@ class RemiseCheque extends CommonObject /** * Validate a receipt + * * @param user User * @return int <0 if KO, >0 if OK */ @@ -387,7 +391,7 @@ class RemiseCheque extends CommonObject /** * Old module for cheque receipt numbering * - * @return string + * @return int Next number of cheque */ function getNextNumber() { @@ -421,6 +425,7 @@ class RemiseCheque extends CommonObject /** * Load indicators for dashboard (this->nbtodo and this->nbtodolate) + * * @param user Objet user * @param filteraccountid To get info for a particular account id * @return int <0 if KO, >0 if OK diff --git a/htdocs/core/class/rssparser.class.php b/htdocs/core/class/rssparser.class.php index 6b61cedc60a..fbe033ec3a6 100755 --- a/htdocs/core/class/rssparser.class.php +++ b/htdocs/core/class/rssparser.class.php @@ -448,10 +448,10 @@ class RssParser * Triggered when CDATA is found * * @param $p - * @param $element Tag - * @param $attrs Attributes of tags + * @param $text Tag */ - function feed_cdata ($p, $text) { + function feed_cdata($p, $text) + { if ($this->_format == 'atom' and $this->incontent) { $this->append_content( $text ); @@ -466,9 +466,10 @@ class RssParser * Triggered when closed tag is found * * @param $p - * @param $element Tag + * @param $el Tag */ - function feed_end_element ($p, $el) { + function feed_end_element($p, $el) + { $el = strtolower($el); if ( $el == 'item' or $el == 'entry' ) @@ -520,7 +521,8 @@ class RssParser * @param $str1 * @param $str2 */ - function concat (&$str1, $str2="") { + function concat(&$str1, $str2="") + { if (!isset($str1) ) { $str1=""; } @@ -529,7 +531,8 @@ class RssParser /** */ - function append_content($text) { + function append_content($text) + { if ( $this->initem ) { $this->concat( $this->current_item[ $this->incontent ], $text ); } @@ -541,7 +544,8 @@ class RssParser /** * smart append - field and namespace aware */ - function append($el, $text) { + function append($el, $text) + { if (!$el) { return; }