spip / SPIP

ecrire/inc/filtres.php

Doc Comments +22 added lines, -12 removed lines

@@ -69,7 +69,7 @@ 
  *
  * @param string $fonc
  *     Nom du filtre
- * @param null $default
+ * @param string $default
  *     Nom du filtre appliqué par défaut si celui demandé n'est pas trouvé
  * @return string
  *     Fonction PHP correspondante du filtre demandé
@@ -141,7 +141,7 @@ 
  * @see appliquer_si_filtre() Proche : retourne le texte d'origine si le filtre est absent
  * @uses appliquer_filtre_sinon()
  *
- * @param mixed $arg
+ * @param string $arg
  *     Texte (le plus souvent) sur lequel appliquer le filtre
  * @param string $filtre
  *     Nom du filtre à appliquer
@@ -776,7 +776,7 @@ 
  *   corriger toutes les `&xx;` en `&xx;`
  * @param bool $quote
  *   Échapper aussi les simples quotes en `'`
- * @return mixed|string
+ * @return string
  */
 function entites_html($texte, $tout = false, $quote = true) {
 	if (!is_string($texte) or !$texte
@@ -1412,7 +1412,7 @@ 
  *
  * @param mixed $texte
  *     Contenu de reference a tester
- * @param mixed $sinon
+ * @param string|null $sinon
  *     Contenu a retourner si le contenu de reference est vide
  * @return mixed
  *     Retourne $texte, sinon $sinon.
@@ -1594,7 +1594,7 @@ 
  * @param string $letexte
  * @param string $lang
  *     Langue à retrouver (si vide, utilise la langue en cours).
- * @param array $options Options {
+ * @param boolean $options Options {
  * @type bool $echappe_span
  *         True pour échapper les balises span (false par défaut)
  * @type string $lang_defaut
@@ -1684,7 +1684,7 @@ 
  * @param string $letexte
  * @param string $lang
  *     Langue à retrouver (si vide, utilise la langue en cours).
- * @param array $options Options {
+ * @param boolean $options Options {
  * @type bool $echappe_span
  *         True pour échapper les balises span (false par défaut)
  * @type string $lang_defaut
@@ -1893,7 +1893,7 @@ 
  *
  * @param int $i
  *     Le compteur
- * @param array $args
+ * @param string $args
  *     Liste des éléments à alterner
  * @return mixed
  *     Une des valeurs en fonction du compteur.
@@ -2158,6 +2158,9 @@ 
 // Quelques fonctions de calcul arithmetique
 //
 function floatstr($a) { return str_replace(',','.',(string)floatval($a)); }
+/**
+ * @param string $f
+ */
 function strize($f, $a, $b) { return floatstr($f(floatstr($a),floatstr($b))); }
 
 /**
@@ -2301,7 +2304,7 @@ 
  * @param string|array $adresses
  *      Adresse ou liste d'adresse
  *      si on fournit un tableau, il est filtre et la fonction renvoie avec uniquement les adresses email valides (donc possiblement vide)
- * @return bool|string|array
+ * @return string|null
  *      - false si une des adresses n'est pas conforme,
  *      - la normalisation de la dernière adresse donnée sinon
  *      - renvoie un tableau si l'entree est un tableau
@@ -2625,7 +2628,7 @@ 
  * @param int $a
  * @param int $b
  * @param int $c
- * @return int
+ * @return double
  *      Retourne `$a*$b/$c`
  **/
 function regledetrois($a, $b, $c) {
@@ -3448,6 +3451,10 @@ 
 }
 
 
+/**
+ * @param string $alt_or_size
+ * @param string|null $class_or_size
+ */
 function helper_filtre_balise_img_svg_arguments($alt_or_size, $class_or_size, $size) {
 	$args = [$alt_or_size, $class_or_size, $size];
 	while (is_null(end($args)) and count($args)) {
@@ -3476,6 +3483,10 @@ 
 	return $args;
 }
 
+/**
+ * @param string $img
+ * @param string $size
+ */
 function helper_filtre_balise_img_svg_size($img, $size) {
 	// si size est de la forme '@2x' c'est un coeff multiplicateur sur la densite
 	if (strpos($size, '@') === 0 and substr($size,-1) === 'x') {
@@ -4642,8 +4653,6 @@ 
  *     Numéro de l'objet
  * @param string $type_objet
  *     Type d'objet
- * @param string $desc
- *     Ligne SQL de l'objet avec au moins descriptif, texte et chapo
  * @param int $introduction_longueur
  *     Longueur de l'introduction donnée dans la description de la table l'objet
  * @param int|string $longueur_ou_suite
@@ -4872,7 +4881,7 @@ 
  *     Nombre d'éléments
  * @param string $objet
  *     Objet
- * @return mixed|string
+ * @return string
  *     Texte traduit du comptage, tel que '3 articles'
  */
 function objet_afficher_nb($nb, $objet) {
@@ -5352,6 +5361,7 @@ 
  *
  * @param string $objet
  * @param int|string $id_objet
+ * @param string $fonction
  * @return array
  */
 function helper_filtre_objet_lister_enfants_ou_parents($objet, $id_objet, $fonction) {