From b8a377fa8fdaa216c9a2118ef40d901f660787df Mon Sep 17 00:00:00 2001 From: Laurent Destailleur Date: Mon, 12 Sep 2011 17:43:31 +0000 Subject: [PATCH] Doxygen --- htdocs/adherents/class/adherent.class.php | 22 +++-- htdocs/bookmarks/class/bookmark.class.php | 2 +- htdocs/categories/class/categorie.class.php | 24 +++-- htdocs/comm/propal/class/propal.class.php | 97 +++++++++++-------- .../cheque/class/remisecheque.class.php | 5 +- htdocs/core/class/smtps.class.php | 94 ++++++------------ .../includes/modules/action/rapport.pdf.php | 2 +- htdocs/lib/pdf.lib.php | 40 ++++---- htdocs/main.inc.php | 25 ++--- .../product/actions_card_product.class.php | 11 --- .../service/actions_card_service.class.php | 11 --- htdocs/projet/class/project.class.php | 13 ++- .../default/actions_card_default.class.php | 5 +- .../actions_card_individual.class.php | 7 +- 14 files changed, 167 insertions(+), 191 deletions(-) diff --git a/htdocs/adherents/class/adherent.class.php b/htdocs/adherents/class/adherent.class.php index f82b4eb6d26..376a800dc5b 100644 --- a/htdocs/adherents/class/adherent.class.php +++ b/htdocs/adherents/class/adherent.class.php @@ -133,6 +133,7 @@ class Adherent extends CommonObject /** * Fonction envoyant un email a l'adherent avec le texte fourni en parametre. + * * @param text contenu du message (not html entities encoded) * @param subject subject of message * @param filename_list tableau de fichiers attaches @@ -142,7 +143,8 @@ class Adherent extends CommonObject * @param addr_bcc email bcc * @param deliveryreceipt demande accuse reception * @param msgishtml 1=String IS already html, 0=String IS NOT html, -1=Unknown need autodetection - * @return int <0 si ko, >0 si ok + * @param errorsto erros to + * @return int <0 if KO, >0 if OK */ function send_an_email($text, $subject, $filename_list=array(), $mimetype_list=array(), $mimefilename_list=array(), $addr_cc="", $addr_bcc="", $deliveryreceipt=0, $msgishtml=-1, $errors_to='') { @@ -179,6 +181,7 @@ class Adherent extends CommonObject /** * Make substitution + * * @param text Text to make substitution to * @return string Value of input text string with substitutions done */ @@ -835,8 +838,9 @@ class Adherent extends CommonObject /** * Set link to a user - * @param userid Id of user to link to - * @return int 1=OK, -1=KO + * + * @param int $userid Id of user to link to + * @return int 1=OK, -1=KO */ function setUserId($userid) { @@ -868,8 +872,9 @@ class Adherent extends CommonObject /** * Set link to a third party - * @param userid Id of user to link to - * @return int 1=OK, -1=KO + * + * @param int $thirdpartyid Id of user to link to + * @return int 1=OK, -1=KO */ function setThirdPartyId($thirdpartyid) { @@ -939,6 +944,7 @@ class Adherent extends CommonObject /** * Load member from database + * * @param rowid Id of object to load * @param ref To load member from its ref * @param fk_soc To load member from its link to third party @@ -1064,6 +1070,7 @@ class Adherent extends CommonObject * first_subscription_amount * last_subscription_date * last_subscription_amount + * * @return int <0 si KO, >0 si OK */ function fetch_subscriptions() @@ -1123,10 +1130,11 @@ class Adherent extends CommonObject /** * Fonction qui insere la cotisation dans la base de donnees - * et eventuellement liens dans banques, mailman, etc... + * et eventuellement liens dans banques, mailman, etc. + * * @param date Date d'effet de la cotisation * @param montant Montant cotisation (accepte 0 pour les adherents non soumis e cotisation) - * @param account_id Id compte bancaire + * @param accountid Id compte bancaire * @param operation Type operation (si Id compte bancaire fourni) * @param label Label operation (si Id compte bancaire fourni) * @param num_chq Numero cheque (si Id compte bancaire fourni) diff --git a/htdocs/bookmarks/class/bookmark.class.php b/htdocs/bookmarks/class/bookmark.class.php index 6bfd0b6c286..a92d43ed23f 100644 --- a/htdocs/bookmarks/class/bookmark.class.php +++ b/htdocs/bookmarks/class/bookmark.class.php @@ -43,7 +43,7 @@ class Bookmark /** * Constructor * - * @param DoliDB $DB Database handler + * @param DoliDB $db Database handler */ function Bookmark($db) { diff --git a/htdocs/categories/class/categorie.class.php b/htdocs/categories/class/categorie.class.php index 2bffb92b113..36dcf072fec 100644 --- a/htdocs/categories/class/categorie.class.php +++ b/htdocs/categories/class/categorie.class.php @@ -399,14 +399,12 @@ class Categorie /** * Ajout d'une sous-categorie * - * @param $fille objet categorie * @return int 1 : OK * -2 : $fille est deja dans la famille de $this * -3 : categorie ($this ou $fille) invalide */ function add_fille() { - $sql = "INSERT INTO ".MAIN_DB_PREFIX."categorie_association (fk_categorie_mere, fk_categorie_fille)"; $sql.= " VALUES (".$this->id_mere.", ".$this->id.")"; @@ -488,7 +486,8 @@ class Categorie /** * Suppresion d'un produit de la categorie * - * @param $prod est un objet de type produit + * @param $obj Object + * @param $type Type * @return int 1 if OK, -1 if KO */ function del_type($obj,$type) @@ -511,9 +510,9 @@ class Categorie /** * Return list of contents of a category * - * @param field Field name for select in table. Full field name will be fk_field. - * @param class PHP Class of object to store entity - * @param table Table name for select in table. Full table name will be PREFIX_categorie_table. + * @param field Field name for select in table. Full field name will be fk_field. + * @param classname PHP Class of object to store entity + * @param table Table name for select in table. Full table name will be PREFIX_categorie_table. */ function get_type($field,$classname,$table='') { @@ -1212,10 +1211,9 @@ class Categorie /** * Build thumb * - * @param sdir Repertoire destination finale - * @param file Chemin du fichier d'origine - * @param maxWidth Largeur maximum que dois faire la miniature (160 par defaut) - * @param maxHeight Hauteur maximum que dois faire la miniature (120 par defaut) + * @param string $file Chemin du fichier d'origine + * @param int $maxWidth Largeur maximum que dois faire la miniature (160 par defaut) + * @param int $maxHeight Hauteur maximum que dois faire la miniature (120 par defaut) */ function add_thumb($file, $maxWidth = 160, $maxHeight = 120) { @@ -1231,9 +1229,9 @@ class Categorie /** * Return tableau de toutes les photos de la categorie * - * @param dir Repertoire a scanner - * @param nbmax Nombre maximum de photos (0=pas de max) - * @return array Tableau de photos + * @param string $dir Repertoire a scanner + * @param int $nbmax Nombre maximum de photos (0=pas de max) + * @return array Tableau de photos */ function liste_photos($dir,$nbmax=0) { diff --git a/htdocs/comm/propal/class/propal.class.php b/htdocs/comm/propal/class/propal.class.php index b7ee7f6bb06..9c8328f0071 100644 --- a/htdocs/comm/propal/class/propal.class.php +++ b/htdocs/comm/propal/class/propal.class.php @@ -430,20 +430,22 @@ class Propal extends CommonObject /** - * Update a proposal line - * @param rowid Id de la ligne - * @param pu Prix unitaire (HT ou TTC selon price_base_type) - * @param qty Quantity - * @param remise_percent Remise effectuee sur le produit - * @param txtva Taux de TVA - * @param txlocaltax1 Local tax 1 rate - * @param txlocaltax2 Local tax 2 rate - * @param desc Description - * @param price_base_type HT ou TTC - * @param info_bits Miscellanous informations - * @param special_code Set special code ('' = we don't change it) - * @param fk_parent_line Id of line parent - * @return int 0 en cas de succes + * Update a proposal line + * + * @param rowid Id de la ligne + * @param pu Prix unitaire (HT ou TTC selon price_base_type) + * @param qty Quantity + * @param remise_percent Remise effectuee sur le produit + * @param txtva Taux de TVA + * @param txlocaltax1 Local tax 1 rate + * @param txlocaltax2 Local tax 2 rate + * @param desc Description + * @param price_base_type HT ou TTC + * @param info_bits Miscellanous informations + * @param special_code Set special code ('' = we don't change it) + * @param fk_parent_line Id of line parent + * @param skip_update_total Skip update total + * @return int 0 if OK, <0 if KO */ function updateline($rowid, $pu, $qty, $remise_percent=0, $txtva, $txlocaltax1=0, $txlocaltax2=0, $desc='', $price_base_type='HT', $info_bits=0, $special_code=0, $fk_parent_line=0, $skip_update_total=0) { @@ -543,9 +545,10 @@ class Propal extends CommonObject /** - * \brief Supprime une ligne de detail - * \param idligne Id de la ligne detail a supprimer - * \return int >0 si ok, <0 si ko + * Supprime une ligne de detail + * + * @param int $lineid Id of line to delete + * @return int >0 if OK, <0 if KO */ function deleteline($lineid) { @@ -575,10 +578,12 @@ class Propal extends CommonObject /** - * Create commercial proposal into database - * this->ref can be set or empty. If empty, we will use "(PROVid)" - * @param user User that create - * @return int <0 if KO, >=0 if OK + * Create commercial proposal into database + * this->ref can be set or empty. If empty, we will use "(PROVid)" + * + * @param User $user User that create + * @param int $notrigger Disable trigger + * @return int <0 if KO, >=0 if OK */ function create($user='', $notrigger=0) { @@ -1288,10 +1293,11 @@ class Propal extends CommonObject } /** - * \brief Set delivery - * \param user Objet utilisateur qui modifie - * \param delivery delai de livraison - * \return int <0 si ko, >0 si ok + * Set delivery + * + * @param User $user Objet utilisateur qui modifie + * @param int $id Availability id + * @return int <0 if KO, >0 if OK */ function set_availability($user, $id) { @@ -1316,10 +1322,11 @@ class Propal extends CommonObject } /** - * \brief Set source of demand - * \param user Objet utilisateur qui modifie - * \param demand_reason source of demand - * \return int <0 si ko, >0 si ok + * Set source of demand + * + * @param User $user Objet utilisateur qui modifie + * @param int $id Input reason id + * @return int <0 if KO, >0 if OK */ function set_demand_reason($user, $id) { @@ -1344,10 +1351,11 @@ class Propal extends CommonObject } /** - * \brief Positionne numero reference client - * \param user Utilisateur qui modifie - * \param ref_client Reference client - * \return int <0 si ko, >0 si ok + * Positionne numero reference client + * + * @param user Utilisateur qui modifie + * @param ref_client Reference client + * @return int <0 si ko, >0 si ok */ function set_ref_client($user, $ref_client) { @@ -1802,9 +1810,10 @@ class Propal extends CommonObject /** - * \brief Change les conditions de reglement de la facture - * \param cond_reglement_id Id de la nouvelle condition de reglement - * \return int >0 si ok, <0 si ko + * Change les conditions de reglement de la facture + * + * @param cond_reglement_id Id de la nouvelle condition de reglement + * @return int >0 if OK, <0 if KO */ function cond_reglement($cond_reglement_id) { @@ -1836,9 +1845,10 @@ class Propal extends CommonObject /** - * \brief Change le mode de reglement - * \param mode_reglement Id du nouveau mode - * \return int >0 si ok, <0 si ko + * Change le mode de reglement + * + * @param mode_reglement_id Id du nouveau mode + * @return int >0 if OK, <0 if KO */ function mode_reglement($mode_reglement_id) { @@ -1868,10 +1878,11 @@ class Propal extends CommonObject } } -/** - * \brief Change le delai de livraison - * \param availability_id Id du nouveau delai de livraison - * \return int >0 si ok, <0 si ko + /** + * Change le delai de livraison + * + * @param availability_id Id du nouveau delai de livraison + * @return int >0 if OK, <0 if KO */ function availability($availability_id) { diff --git a/htdocs/compta/paiement/cheque/class/remisecheque.class.php b/htdocs/compta/paiement/cheque/class/remisecheque.class.php index b3b689d5737..a5c852ea014 100644 --- a/htdocs/compta/paiement/cheque/class/remisecheque.class.php +++ b/htdocs/compta/paiement/cheque/class/remisecheque.class.php @@ -426,8 +426,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 + * @param User $user Objet user * @return int <0 if KO, >0 if OK */ function load_board($user) @@ -436,7 +435,7 @@ class RemiseCheque extends CommonObject if ($user->societe_id) return -1; // protection pour eviter appel par utilisateur externe - $now=gmmktime(); + $now=dol_now(); $this->nbtodo=$this->nbtodolate=0; diff --git a/htdocs/core/class/smtps.class.php b/htdocs/core/class/smtps.class.php index 461dd78bd32..ea002ee18b5 100755 --- a/htdocs/core/class/smtps.class.php +++ b/htdocs/core/class/smtps.class.php @@ -261,19 +261,14 @@ class SMTPs } - - // ============================================================= function setDebug( $_vDebug = false ) { $this->_debug = $_vDebug; } - // ** Class methods - /** * build RECIPIENT List, all addresses who will recieve this message * - * @param void * @return void */ function buildRCPTlist() @@ -285,7 +280,6 @@ class SMTPs /** * Attempt a connection to mail server * - * @param void * @return mixed $_retVal Boolean indicating success or failure on connection */ function _server_connect() @@ -343,7 +337,6 @@ class SMTPs /** * Attempt mail server authentication for a secure connection * - * @param void * @return mixed $_retVal Boolean indicating success or failure of authentication */ function _server_authenticate() @@ -544,7 +537,6 @@ class SMTPs * - 'pipe [1] - use UNIX path to EXE * - 'phpmail [2] - use the PHP built-in mail function * - * @param void * @return int $_strHost Host Name or IP of the Mail Server to use */ function getTransportType() @@ -576,7 +568,7 @@ class SMTPs * @param string $_strHost Host Name or IP of the Mail Server to use * @return void */ - function setHost ( $_strHost ) + function setHost($_strHost) { if ( $_strHost ) $this->_smtpsHost = $_strHost; @@ -586,10 +578,9 @@ class SMTPs * Retrieves the Host Name or IP of the Mail Server to use * This is used only with 'socket' based mail transmission * - * @param void * @return string $_strHost Host Name or IP of the Mail Server to use */ - function getHost () + function getHost() { return $this->_smtpsHost; } @@ -602,7 +593,7 @@ class SMTPs * @param int $_smtpsPort Port Number of the Mail Server to use * @return void */ - function setPort ( $_intPort ) + function setPort($_intPort) { if ( ( is_numeric ($_intPort) ) && ( ( $_intPort >= 1 ) && ( $_intPort <= 65536 ) ) ) @@ -613,10 +604,9 @@ class SMTPs * Retrieves the Port Number of the Mail Server to use * This is used only with 'socket' based mail transmission * - * @param void * @return string $_smtpsPort Port Number of the Mail Server to use */ - function getPort () + function getPort() { return $this->_smtpsPort; } @@ -627,7 +617,7 @@ class SMTPs * @param string $_strID User Name for authentication on Mail Server * @return void */ - function setID ( $_strID ) + function setID($_strID ) { $this->_smtpsID = $_strID; } @@ -635,10 +625,9 @@ class SMTPs /** * Retrieves the User Name for authentication on Mail Server * - * @param void * @return string _smtpsID User Name for authentication on Mail Server */ - function getID () + function getID() { return $this->_smtpsID; } @@ -649,7 +638,7 @@ class SMTPs * @param string $_strPW User Password for authentication on Mail Server * @return void */ - function setPW ( $_strPW ) + function setPW($_strPW) { $this->_smtpsPW = $_strPW; } @@ -657,10 +646,9 @@ class SMTPs /** * Retrieves the User Password for authentication on Mail Server * - * @param void * @return string $_smtpsPW User Password for authentication on Mail Server */ - function getPW () + function getPW() { return $this->_smtpsPW; } @@ -672,7 +660,7 @@ class SMTPs * @param string $_strCharSet Character set used for current message * @return void */ - function setCharSet ( $_strCharSet ) + function setCharSet($_strCharSet) { if ( $_strCharSet ) $this->_smtpsCharSet = $_strCharSet; @@ -681,10 +669,9 @@ class SMTPs /** * Retrieves the Character set used for current message * - * @param void * @return string $_smtpsCharSet Character set used for current message */ - function getCharSet () + function getCharSet() { return $this->_smtpsCharSet; } @@ -713,10 +700,9 @@ class SMTPs /** * Retrieves the Content-Transfer-Encoding * - * @param void * @return string $_smtpsTransEncode Content-Transfer-Encoding */ - function getTransEncode () + function getTransEncode() { return $this->_smtpsTransEncode; } @@ -746,9 +732,7 @@ class SMTPs /** * Retrieves the Content-Transfer-Encoding * - * @param void * @return string $_smtpsTransEncode Content-Transfer-Encoding - * */ function getTransEncodeType() { @@ -761,10 +745,10 @@ class SMTPs /** * FROM Address from which mail will be sent * - * @param string $_msgFrom Address from which mail will be sent - * @return void + * @param string $_strFrom Address from which mail will be sent + * @return void */ - function setFrom ( $_strFrom ) + function setFrom($_strFrom) { if ( $_strFrom ) $this->_msgFrom = $this->_strip_email ( $_strFrom ); @@ -773,10 +757,10 @@ class SMTPs /** * Retrieves the Address from which mail will be sent * - * @param boolean $_strip To "strip" 'Real name' from address - * @return string $_msgFrom Address from which mail will be sent + * @param boolean $_part To "strip" 'Real name' from address + * @return string Address from which mail will be sent */ - function getFrom ( $_part = true ) + function getFrom($_part = true) { $_retValue = ''; @@ -870,7 +854,6 @@ class SMTPs * - $_aryEmail[host] = "domain.tld" * - $_aryEmail[user] = "userName" * - * @param void * @return array $_aryEmail An array of the various parts of an email address */ function _strip_email($_strAddr) @@ -913,7 +896,6 @@ class SMTPs * This is a "build as you go" method. Each time this method is called * the underlaying array is destroyed and reconstructed. * - * @param void * @return array $_RCPT_list Returns an array of bares addresses */ function get_RCPT_list() @@ -1005,10 +987,9 @@ class SMTPs /** * Retrieves the TO Address[es] inwhich to send mail to * - * @param void * @return string $_msgRecipients TO Address[es] inwhich to send mail to */ - function getTo () + function getTo() { return $this->get_email_list( 'to' ); } @@ -1019,7 +1000,7 @@ class SMTPs * @param string $_msgRecipients CC Address[es] inwhich to send mail to * @return void */ - function setCC ( $_strCC ) + function setCC($_strCC) { if ( $_strCC ) $this->_buildAddrList( 'cc', $_strCC ); @@ -1028,10 +1009,9 @@ class SMTPs /** * Retrieves the CC Address[es] inwhich to send mail to * - * @param void * @return string $_msgRecipients CC Address[es] inwhich to send mail to */ - function getCC () + function getCC() { return $this->get_email_list( 'cc' ); } @@ -1042,7 +1022,7 @@ class SMTPs * @param string $_msgRecipients BCC Address[es] inwhich to send mail to * @return void */ - function setBCC ( $_strBCC ) + function setBCC($_strBCC) { if ( $_strBCC ) $this->_buildAddrList( 'bcc', $_strBCC ); @@ -1051,10 +1031,9 @@ class SMTPs /** * Retrieves the BCC Address[es] inwhich to send mail to * - * @param void * @return string $_msgRecipients BCC Address[es] inwhich to send mail to */ - function getBCC () + function getBCC() { return $this->get_email_list( 'bcc' ); } @@ -1065,7 +1044,7 @@ class SMTPs * @param string $_msgSubject Message Subject * @return void */ - function setSubject ( $_strSubject = '' ) + function setSubject($_strSubject = '') { if ( $_strSubject ) $this->_msgSubject = $_strSubject; @@ -1074,10 +1053,9 @@ class SMTPs /** * Retrieves the Message Subject * - * @param void * @return string $_msgSubject Message Subject */ - function getSubject () + function getSubject() { return $this->_msgSubject; } @@ -1085,7 +1063,6 @@ class SMTPs /** * Constructes and returns message header * - * @param void * @return string Complete message header */ function getHeader() @@ -1163,10 +1140,9 @@ class SMTPs /** * Retrieves the Message Content * - * @param void - * @return string $_msgContent Message Content + * @return string Message Content */ - function getBodyContent () + function getBodyContent() { // Generate a new Boundary string $this->_setBoundary(); @@ -1430,7 +1406,7 @@ class SMTPs * @param string $_value Message Priority * @return void */ - function setMD5flag ( $_flag = false ) + function setMD5flag($_flag = false) { $this->_smtpMD5 = $_flag; } @@ -1438,10 +1414,9 @@ class SMTPs /** * Gets flag which determines whether to calculate message MD5 checksum. * - * @param void * @return string $_value Message Priority */ - function getMD5flag ( ) + function getMD5flag() { return $this->_smtpMD5; } @@ -1454,7 +1429,7 @@ class SMTPs * @param string $strXdata Message X-Header Content * @return void */ - function setXheader ( $strXdata ) + function setXheader($strXdata) { if ( $strXdata ) $this->_msgXheader[] = $strXdata; @@ -1463,10 +1438,9 @@ class SMTPs /** * Retrieves the Message X-Header Content * - * @param void * @return string $_msgContent Message X-Header Content */ - function getXheader () + function getXheader() { return $this->_msgXheader; } @@ -1474,7 +1448,6 @@ class SMTPs /** * Generates Random string for MIME message Boundary * - * @param void * @return void */ function _setBoundary() @@ -1485,7 +1458,6 @@ class SMTPs /** * Retrieves the MIME message Boundary * - * @param void * @return string $_smtpsBoundary MIME message Boundary */ function _getBoundary() @@ -1557,7 +1529,6 @@ class SMTPs /** * Returns errors codes and messages for Class * - * @param void * @return string $_errMsg Error Message */ function getErrors() @@ -1573,10 +1544,9 @@ class SMTPs } - // ============================================================= -} // end of Class +} + -// ============================================================= // ============================================================= // ** CSV Version Control Info diff --git a/htdocs/includes/modules/action/rapport.pdf.php b/htdocs/includes/modules/action/rapport.pdf.php index 0286c57f4a8..b4dbcc02486 100644 --- a/htdocs/includes/modules/action/rapport.pdf.php +++ b/htdocs/includes/modules/action/rapport.pdf.php @@ -227,7 +227,7 @@ class CommActionRapport * Show page head * * @param pdf Objet PDF - * @param outputlang Objet lang cible + * @param outputlangs Objet lang cible * @param pagenb Page nb */ function _pagehead(&$pdf, $outputlangs, $pagenb) diff --git a/htdocs/lib/pdf.lib.php b/htdocs/lib/pdf.lib.php index 8735706696b..bcd27ef7ef5 100644 --- a/htdocs/lib/pdf.lib.php +++ b/htdocs/lib/pdf.lib.php @@ -198,6 +198,7 @@ function pdf_format_address($outputlangs,$object) /** * Return a string with full address formated + * * @param outputlangs Output langs object * @param sourcecompany Source company object * @param targetcompany Target company object @@ -296,9 +297,10 @@ function pdf_build_address($outputlangs,$sourcecompany,$targetcompany='',$target /** * Show header of page for PDF generation - * @param pdf Object PDF - * @param outputlang Object lang for output - * @param page_height + * + * @param PDF $pdf Object PDF + * @param Translate $outputlang Object lang for output + * @param int $page_height Height of page */ function pdf_pagehead(&$pdf,$outputlangs,$page_height) { @@ -314,10 +316,11 @@ function pdf_pagehead(&$pdf,$outputlangs,$page_height) /** * Add a draft watermark on PDF files + * * @param pdf Object PDF * @param outputlangs Object lang - * @param height Height of PDF - * @param width Width of PDF + * @param h Height of PDF + * @param w Width of PDF * @param unit Unit of height (mmn, pt, ...) * @param text Text to show */ @@ -492,8 +495,9 @@ function pdf_bank(&$pdf,$outputlangs,$curx,$cury,$account,$onlynumber=0) /** * Show footer of page for PDF generation + * * @param pdf The PDF factory - * @param outputlang Object lang for output + * @param outputlangs Object lang for output * @param paramfreetext Constant name of free text * @param fromcompany Object company * @param marge_basse Margin bottom @@ -688,17 +692,19 @@ function pdf_pagefoot(&$pdf,$outputlangs,$paramfreetext,$fromcompany,$marge_bass /** * Output line description into PDF - * @param pdf PDF object - * @param object Object - * @param i Current line number - * @param outputlang Object lang for output - * @param w - * @param h - * @param posx - * @param posy - * @param hideref Hide reference - * @param hidedesc Hide description - * @param issupplierline Is it a line for a supplier object ? + * + * @param PDF $pdf PDF object + * @param Object $object Object + * @param int $i Current line number + * @param Translate $outputlangs Object lang for output + * @param int $w Width + * @param int $h Height + * @param int $posx Pos x + * @param int $posy Pos y + * @param int $hideref Hide reference + * @param int $hidedesc Hide description + * @param int $issupplierline Is it a line for a supplier object ? + * @param HookManager $hookmanager Instance of HookManager */ function pdf_writelinedesc(&$pdf,$object,$i,$outputlangs,$w,$h,$posx,$posy,$hideref=0,$hidedesc=0,$issupplierline=0,$hookmanager=false) { diff --git a/htdocs/main.inc.php b/htdocs/main.inc.php index 05465a782c3..78cb30beddf 100644 --- a/htdocs/main.inc.php +++ b/htdocs/main.inc.php @@ -85,6 +85,7 @@ function test_sql_and_script_inject($val, $get) if ($get) $sql_inj += preg_match('/"/i', $val); // We refused " in GET parameters value return $sql_inj; } + /** * Security: Return true if OK, false otherwise * @@ -784,17 +785,17 @@ if (! function_exists("llxHeader")) { /** * Show HTML header HTML + BODY + Top menu + left menu + DIV - * @param head Add optionnal head lines - * @param title Title of web page - * @param help_url Url links to help page - * Syntax is: For a wiki page: EN:EnglishPage|FR:FrenchPage|ES:SpanishPage - * For other external page: http://server/url - * @param target Target to use in menu links - * @param disablejs Do not output links to js (Ex: qd fonction utilisee par sous formulaire Ajax) - * @param disablehead Do not output head section - * @param arrayofjs Array of js files to add in header - * @param arrayofcss Array of css files to add in header - * @param morequerystring Query string to add to the link "print" to get same parameters (use only if autodetect fails) + * + * @param string $head Optionnal head lines + * @param string $title HTML title + * @param string $help_url Url links to help page + * Syntax is: For a wiki page: EN:EnglishPage|FR:FrenchPage|ES:SpanishPage + * For other external page: http://server/url + * @param int $disablejs More content into html header + * @param int $disablehead More content into html header + * @param array $arrayofjs Array of complementary js files + * @param array $arrayofcss Array of complementary css files + * @param string $morequerystring Query string to add to the link "print" to get same parameters (use only if autodetect fails) */ function llxHeader($head = '', $title='', $help_url='', $target='', $disablejs=0, $disablehead=0, $arrayofjs='', $arrayofcss='', $morequerystring='') { @@ -829,7 +830,7 @@ function top_httphead() * @param int $disablehead More content into html header * @param array $arrayofjs Array of complementary js files * @param array $arrayofcss Array of complementary css files - * @return none + * @return void */ function top_htmlhead($head, $title='', $disablejs=0, $disablehead=0, $arrayofjs='', $arrayofcss='') { diff --git a/htdocs/product/canvas/product/actions_card_product.class.php b/htdocs/product/canvas/product/actions_card_product.class.php index 5df3cd303c1..970b6fc9c59 100755 --- a/htdocs/product/canvas/product/actions_card_product.class.php +++ b/htdocs/product/canvas/product/actions_card_product.class.php @@ -72,17 +72,6 @@ class ActionsCardProduct extends Product return $langs->trans("Products"); } - /** - * \brief Lecture des donnees dans la base - * \param id Product id - */ - function fetch($id='', $ref='', $action='') - { - $result = parent::fetch($id); - - return $result; - } - /** * Assign custom values for canvas (for example into this->tpl to be used by templates) * diff --git a/htdocs/product/canvas/service/actions_card_service.class.php b/htdocs/product/canvas/service/actions_card_service.class.php index be3a65185f6..97970d4e48b 100755 --- a/htdocs/product/canvas/service/actions_card_service.class.php +++ b/htdocs/product/canvas/service/actions_card_service.class.php @@ -72,17 +72,6 @@ class ActionsCardService extends Product return $langs->trans("Products"); } - /** - * \brief Lecture des donnees dans la base - * \param id Product id - */ - function fetch($id='', $ref='', $action='') - { - $result = parent::fetch($id); - - return $result; - } - /** * Assign custom values for canvas (for example into this->tpl to be used by templates) * diff --git a/htdocs/projet/class/project.class.php b/htdocs/projet/class/project.class.php index 4cbc7624121..17c77c20d9e 100644 --- a/htdocs/projet/class/project.class.php +++ b/htdocs/projet/class/project.class.php @@ -70,8 +70,10 @@ class Project extends CommonObject /** * Create a project into database - * @param user User making creation - * @return int <0 if KO, id of created project if OK + * + * @param User $user User making creation + * @param int $notrigger Disable triggers + * @return int <0 if KO, id of created project if OK */ function create($user, $notrigger=0) { @@ -221,9 +223,10 @@ class Project extends CommonObject /** * Get object and lines from database - * @param rowid id of object to load - * @param ref Ref of project - * @return int >0 if OK, 0 if not found, <0 if KO + * + * @param int $id Id of object to load + * @param string $ref Ref of project + * @return int >0 if OK, 0 if not found, <0 if KO */ function fetch($id,$ref='') { diff --git a/htdocs/societe/canvas/default/actions_card_default.class.php b/htdocs/societe/canvas/default/actions_card_default.class.php index ed95c25e722..5c0d7ffcd6a 100644 --- a/htdocs/societe/canvas/default/actions_card_default.class.php +++ b/htdocs/societe/canvas/default/actions_card_default.class.php @@ -69,7 +69,8 @@ class ActionsCardDefault extends ActionsCardCommon /** * Execute actions - * @param Id of object (may be empty for creation) + * + * @param int $socid Id of object (may be empty for creation) */ function doActions($socid) { @@ -81,7 +82,7 @@ class ActionsCardDefault extends ActionsCardCommon /** * Assign custom values for canvas (for example into this->tpl to be used by templates) * - * @param action Type of action + * @param string $action Type of action */ function assign_values($action='') { diff --git a/htdocs/societe/canvas/individual/actions_card_individual.class.php b/htdocs/societe/canvas/individual/actions_card_individual.class.php index e1db7a5efef..e9012d4e20d 100644 --- a/htdocs/societe/canvas/individual/actions_card_individual.class.php +++ b/htdocs/societe/canvas/individual/actions_card_individual.class.php @@ -69,7 +69,8 @@ class ActionsCardIndividual extends ActionsCardCommon /** * Execute actions - * @param Id of object (may be empty for creation) + * + * @param int $socid Id of object (may be empty for creation) */ function doActions($socid) { @@ -79,9 +80,9 @@ class ActionsCardIndividual extends ActionsCardCommon } /** - * Assign custom values for canvas (for example into this->tpl to be used by templates) + * Assign custom values for canvas (for example into this->tpl to be used by templates) * - * @param action Type of action + * @param string $action Type of action */ function assign_values($action='') {