XoopsModules25x / oledrion

class/oledrion_products_list.php

Doc Comments +2 added lines, -2 removed lines

@@ -58,7 +58,7 @@ 
      * Supprime un produit de toutes les listes
      *
      * @param  integer $productlist_product_id
-     * @return booelan
+     * @return boolean
      */
     public function deleteProductFromLists($productlist_product_id)
     {
@@ -94,7 +94,7 @@ 
     /**
      * Ajoute un produit à une liste utilisateur
      *
-     * @param  integer $productlist_id         Id de la liste
+     * @param  integer $productlist_list_id         Id de la liste
      * @param  integer $productlist_product_id Id du produit
      * @return boolean
      */

class/oledrion_shelf_parameters.php

Doc Comments +12 added lines, -12 removed lines

@@ -42,7 +42,7 @@ 
     /**
      * Réinitialisation des valeurs
      *
-     * @return object
+     * @return oledrion_shelf_parameters
      */
     public function resetDefaultValues()
     {
@@ -75,7 +75,7 @@ 
      * Positione la valeur de début
      *
      * @param  integer $value
-     * @return object
+     * @return oledrion_shelf_parameters
      */
     public function setStart($value)
     {
@@ -88,7 +88,7 @@ 
      * Fixe le nombre maximum d'enregistrements à retourner
      *
      * @param  integer $value
-     * @return object
+     * @return oledrion_shelf_parameters
      */
     public function setLimit($value)
     {
@@ -101,7 +101,7 @@ 
      * Fixe la catégorie à utiliser
      *
      * @param  integer $value
-     * @return object
+     * @return oledrion_shelf_parameters
      */
     public function setCategory($value)
     {
@@ -114,7 +114,7 @@ 
      * Fixe la zone qui sert de tri
      *
      * @param  string $value
-     * @return object
+     * @return oledrion_shelf_parameters
      */
     public function setSort($value)
     {
@@ -127,7 +127,7 @@ 
      * Fixe l'ordre de tri
      *
      * @param  string $value
-     * @return array
+     * @return oledrion_shelf_parameters
      */
     public function setOrder($value)
     {
@@ -140,7 +140,7 @@ 
      * Fixe la liste des produits à exclure
      *
      * @param  mixed  $value
-     * @return string
+     * @return oledrion_shelf_parameters
      */
     public function setExcluded($value)
     {
@@ -153,7 +153,7 @@ 
      * Indique s'il faut retourner les utilisateurs Xoops
      *
      * @param  boolean $value
-     * @return object
+     * @return oledrion_shelf_parameters
      */
     public function setWithXoopsUser($value)
     {
@@ -166,7 +166,7 @@ 
      * Indique s'il faut retourner les produits relatifs
      *
      * @param  boolean $value
-     * @return object
+     * @return oledrion_shelf_parameters
      */
     public function setWithRelatedProducts($value)
     {
@@ -179,7 +179,7 @@ 
      * Indique s'il faut retourner les quantités
      *
      * @param  boolean $value
-     * @return object
+     * @return oledrion_shelf_parameters
      */
     public function setWithQuantity($value)
     {
@@ -192,7 +192,7 @@ 
      * Fixe le type de produits à retourner
      *
      * @param  string $value
-     * @return object
+     * @return oledrion_shelf_parameters
      */
     public function setProductsType($value)
     {
@@ -205,7 +205,7 @@ 
      * Indique s'il faut retourner seulement les mois
      *
      * @param  boolean $value
-     * @return object
+     * @return oledrion_shelf_parameters
      */
     public function setThisMonthOnly($value)
     {

class/oledrion_sms.php

Doc Comments -1 removed lines

@@ -81,7 +81,6 @@
     }
 
     /**
-     * @param string $smsGatewayName
      */
     public static function sendSms($information = array())
     {

class/oledrion_utils.php

Doc Comments +16 added lines, -12 removed lines

@@ -38,7 +38,7 @@ 
     /**
      * Access the only instance of this class
      *
-     * @return object
+     * @return oledrion_utils
      *
      * @static
      * @staticvar   object
@@ -277,7 +277,7 @@ 
     /**
      * Send an email from a template to a list of recipients
      *
-     * @param  string  $tpl_name   Template's name
+     * @param  string  $tplName   Template's name
      * @param  array   $recipients List of recipients
      * @param  string  $subject    Email's subject
      * @param  array   $variables  Varirables to give to the template
@@ -457,7 +457,7 @@ 
     /**
      * Retourne la liste des emails des utilisateurs membres d'un groupe
      *
-     * @param  int   $group_id Group's number
+     * @param  int   $groupId Group's number
      * @return array Emails list
      */
     public static function getEmailsFromGroup($groupId)
@@ -474,7 +474,7 @@ 
     /**
      * Vérifie que l'utilisateur courant fait partie du groupe des administrateurs
      *
-     * @return booleean Admin or not
+     * @return boolean Admin or not
      */
     public static function isAdmin()
     {
@@ -576,7 +576,6 @@ 
      * Mark the mandatory fields of a form with a star
      *
      * @param  object $sform    The form to modify
-     * @param  string $caracter The character to use to mark fields
      * @return object The modified form
      */
     public static function &formMarkRequiredFields(&$sform)
@@ -1046,7 +1045,7 @@ 
      * Fonction chargée de gérer l'upload
      *
      * @param  integer $indice L'indice du fichier à télécharger
-     * @return mixed   True si l'upload s'est bien déroulé sinon le message d'erreur correspondant
+     * @return boolean|string   True si l'upload s'est bien déroulé sinon le message d'erreur correspondant
      */
     public static function uploadFile($indice, $dstpath = XOOPS_UPLOAD_PATH, $mimeTypes = null, $uploadMaxSize = null, $maxWidth = null, $maxHeight = null)
     {
@@ -1149,7 +1148,7 @@ 
     /**
      * Ajoute des jours à une date et retourne la nouvelle date au format Date de Mysql
      *
-     * @param integer $durations    Durée en jours
+     * @param integer $duration    Durée en jours
      * @param integer $startingDate Date de départ (timestamp)
      */
     public function addDaysToDate($duration = 1, $startingDate = 0)
@@ -1191,6 +1190,9 @@ 
         return $breadcrumb;
     }
 
+    /**
+     * @param string $string
+     */
     public function close_tags($string)
     {
         // match opened tags
@@ -1322,7 +1324,7 @@ 
      *
      * @param  floatval $product_price Le montant du produit
      * @param  integer  $vat_id        Le numéro de TVA
-     * @return floatval Le montant TTC si on a trouvé sa TVA sinon
+     * @return double Le montant TTC si on a trouvé sa TVA sinon
      */
     public static function getAmountWithVat($product_price, $vat_id)
     {
@@ -1511,7 +1513,7 @@ 
      *
      * @param  string $path     The file's path
      * @param  string $filename The filename
-     * @return mixed  If the copy succeed, the new filename else false
+     * @return string|false  If the copy succeed, the new filename else false
      * @since 2.1
      */
     public function duplicateFile($path, $filename)
@@ -1593,7 +1595,7 @@ 
      * Create the <option> of an html select
      *
      * @param  array  $array   Array of index and labels
-     * @param  mixed  $default the default value
+     * @param  integer  $default the default value
      * @return string
      * @since 2.3.2009.03.13
      */
@@ -1623,8 +1625,8 @@ 
      * Creates an html select
      *
      * @param  string  $selectName Selector's name
-     * @param  array   $array      Options
-     * @param  mixed   $default    Default's value
+     * @param  string[]   $array      Options
+     * @param  integer   $default    Default's value
      * @param  boolean $withNull   Do we include a null option ?
      * @return string
      * @since 2.3.2009.03.13
@@ -1721,6 +1723,7 @@ 
      * @package Oledrion
      * @author Instant Zero (http://xoops.instant-zero.com)
      * @copyright (c) Instant Zero
+     * @param string $fieldname
      */
     public static function fieldExists($fieldname, $table)
     {
@@ -1754,6 +1757,7 @@ 
      * @package Oledrion
      * @author Instant Zero (http://xoops.instant-zero.com)
      * @copyright (c) Instant Zero
+     * @param string $field
      */
     public static function addField($field, $table)
     {

class/oledrion_vat.php

Doc Comments -10 removed lines

@@ -53,11 +53,6 @@ 
     /**
      * Renvoie la liste de toutes les TVA du module
      *
-     * @param  integer $start   Position de départ
-     * @param  integer $limit   Nombre total d'enregistrements à renvoyer
-     * @param  string  $order   Champ sur lequel faire le tri
-     * @param  string  $order   Ordre du tri
-     * @param  boolean $idaskey Indique si le tableau renvoyé doit avoir pour clé l'identifiant unique de l'enregistrement
      * @return array   tableau d'objets de type TVA
      */
     public function getAllVats(oledrion_parameters $parameters)
@@ -77,11 +72,6 @@ 
     /**
      * Renvoie la liste de toutes les TVA du module
      *
-     * @param  integer $start   Position de départ
-     * @param  integer $limit   Nombre total d'enregistrements à renvoyer
-     * @param  string  $order   Champ sur lequel faire le tri
-     * @param  string  $order   Ordre du tri
-     * @param  boolean $idaskey Indique si le tableau renvoyé doit avoir pour clé l'identifiant unique de l'enregistrement
      * @return array   tableau d'objets de type TVA
      */
     public function getCountryVats($country)

class/oledrion_vendors.php

Doc Comments -5 removed lines

@@ -42,11 +42,6 @@
     /**
      * Renvoie la liste de tous les vendeurs du module
      *
-     * @param  integer $start   Position de départ
-     * @param  integer $limit   Nombre total d'enregistrements à renvoyer
-     * @param  string  $order   Champ sur lequel faire le tri
-     * @param  string  $order   Ordre du tri
-     * @param  boolean $idaskey Indique si le tableau renvoyé doit avoir pour clé l'identifiant unique de l'enregistrement
      * @return array   tableau d'objets de type vendors
      */
     public function getAllVendors(oledrion_parameters $parameters)

class/oledrion_votedata.php

Doc Comments +3 added lines, -3 removed lines

@@ -49,7 +49,7 @@ 
      * @param  integer $product_id Identifiant du produit
      * @param  integer $totalVotes Variable passée par référence et devant contenir le nombre total de votes du produit
      * @param  integer $sumRating  Variable passée par référence et devant contenir le cumul des votes
-     * @return none    Rien
+     * @return integer|null    Rien
      */
     public function getCountRecordSumRating($product_id, &$totalVotes, &$sumRating)
     {
@@ -88,7 +88,7 @@ 
      * Suppression des votes d'un produit
      *
      * @param  integer $vote_product_id L'identifiant du produit
-     * @return le      résultat de la suppression
+     * @return boolean      résultat de la suppression
      */
     public function deleteProductRatings($vote_product_id)
     {
@@ -153,7 +153,7 @@ 
      * @param  integer $vote_product_id L'identifiant du produit
      * @param  integer $vote_uid        L'identifiant de l'utilisateur
      * @param  integer $vote_rating     Le vote
-     * @return le      résultat de la création du vote
+     * @return boolean      résultat de la création du vote
      */
     public function createRating($vote_product_id, $vote_uid, $vote_rating)
     {

class/registryfile.php

Doc Comments +1 added lines, -1 removed lines

@@ -28,7 +28,7 @@
     /**
      * Access the only instance of this class
      *
-     * @return object
+     * @return oledrion_registryfile
      *
      * @static
      * @staticvar   object

class/tree.php

Doc Comments +4 added lines, -1 removed lines

@@ -214,7 +214,7 @@ 
      * @param  string  $fieldName      Name of the member variable from the node objects that should be used as the title for the options.
      * @param  string  $prefix         String to indent deeper levels
      * @param  string  $selected       Value to display as selected
-     * @param  bool    $addEmptyOption Set TRUE to add an empty option with value "0" at the top of the hierarchy
+     * @param  string|boolean    $addEmptyOption Set TRUE to add an empty option with value "0" at the top of the hierarchy
      * @param  integer $key            ID of the object to display as the root of select options
      * @return string  HTML select box
      **/
@@ -239,6 +239,9 @@ 
 
     /**
      * Internal function used by makeTreeAsArray
+     * @param string $fieldName
+     * @param integer $key
+     * @param string $prefix_orig
      */
     public function _recursiveMakeTreeAsArray($fieldName, $key, &$ret, $prefix_orig, $prefix_curr = '')
     {