spip / SPIP

ecrire/base/objets.php

Doc Comments +1 added lines, -1 removed lines

@@ -1578,7 +1578,7 @@
 /**
  * Donne les informations de parenté directe d'un type d'objet si on en trouve
  * 
- * @param $objet
+ * @param string $objet
  *     Type de l'objet dont on cherche les informations de parent
  * @return array|false
  *     Retourne un tableau de tableau contenant les informations de type et de champ pour trouver le parent ou false sinon

prive/themes/spip/vars.css_fonctions.php

Doc Comments +1 added lines, -1 removed lines

@@ -27,7 +27,7 @@
 /**
  * Génère les variables CSS relatif à la typo et langue pour l'espace privé
  *
- * @param Pile $pile Pile
+ * @param Pile $Pile Pile
  */
 function spip_generer_variables_css_typo(array $Pile) : \Spip_Css_Vars_Collection {
 	$vars = new \Spip_Css_Vars_Collection();

ecrire/inc/presentation.php

Doc Comments +7 added lines

@@ -31,6 +31,9 @@ 
 include_spip('inc/filtres_alertes');
 
 // https://code.spip.net/@debut_cadre
+/**
+ * @param string $style
+ */
 function debut_cadre($style, $icone = "", $fonction = "", $titre = "", $id = "", $class = "", $padding = true) {
 	$style_mapping = array(
 		'r' => 'simple',
@@ -184,6 +187,10 @@ 
 function fin_onglet() { return "</ul></div>\n"; }
 
 // https://code.spip.net/@onglet
+/**
+ * @param string $texte
+ * @param string $onglet
+ */
 function onglet($texte, $lien, $onglet_ref, $onglet, $icone = "") {
 	return "<li>"
 	. ($icone ? http_img_pack($icone, '', " class='cadre-icone'") : '')

ecrire/action/editer_article.php

Doc Comments +1 added lines, -1 removed lines

@@ -160,7 +160,7 @@
  * @param int $id_rubrique
  *     Identifiant de la rubrique parente
  * @param array|null $set
- * @return int
+ * @return boolean|string
  *     Identifiant du nouvel article
  *
  */

ecrire/action/editer_auteur.php

Doc Comments +3 added lines, -3 removed lines

@@ -85,7 +85,7 @@ 
  * @param string|null $source
  *     D'où provient l'auteur créé ? par défaut 'spip', mais peut être 'ldap' ou autre.
  * @param array|null $set
- * @return int
+ * @return boolean|string
  *     Identifiant de l'auteur créé
  */
 function auteur_inserer($source = null, $set = null) {
@@ -143,7 +143,7 @@ 
  * @param bool $force_update
  *   Permet de forcer la maj en base des champs fournis, sans passer par instancier.
  *   Utilise par auth/spip
- * @return string|null
+ * @return string|false
  *
  *     - Chaîne vide si aucune erreur,
  *     - Chaîne contenant un texte d'erreur sinon.
@@ -307,7 +307,7 @@ 
  *     Couples (colonne => valeur) des données à instituer
  * @param bool $force_webmestre
  *     Autoriser un auteur à passer webmestre (force l'autorisation)
- * @return bool|string
+ * @return false|string
  */
 function auteur_instituer($id_auteur, $c, $force_webmestre = false) {
 	if (!$id_auteur = intval($id_auteur)) {

ecrire/action/editer_rubrique.php

Doc Comments +2 added lines, -2 removed lines

@@ -73,7 +73,7 @@ 
  *     Identifiant de la rubrique parente.
  *     0 pour la racine.
  * @param array|null $set
- * @return int
+ * @return boolean|string
  *     Identifiant de la rubrique crée
  */
 function rubrique_inserer($id_parent, $set = null) {
@@ -120,7 +120,7 @@ 
  *     Identifiant de la rubrique modifiée
  * @param array|null $set
  *     Tableau qu'on peut proposer en lieu et place de _request()
- * @return bool|string
+ * @return string|false
  *     - false  : Aucune modification, aucun champ n'est à modifier
  *     - chaîne vide : Vide si tout s'est bien passé
  *     - chaîne : Texte d'un message d'erreur

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) {

ecrire/inc/livrer_fichier.php

Doc Comments +1 added lines, -1 removed lines

@@ -67,7 +67,7 @@
  * @param string $fichier
  * @param string $content_type
  * @param false $attachment
- * @param int|string $expires
+ * @param integer $expires
  */
 function spip_livrer_fichier_entetes($fichier, $content_type = 'application/octet-stream', $attachment = false, $expires=0){
 	// toujours envoyer un content type, meme vide !

ecrire/inc/distant.php

Doc Comments +5 added lines, -5 removed lines

@@ -64,7 +64,7 @@ 
  *   permet de specifier le nom du fichier local (stockage d'un cache par exemple, et non document IMG)
  * @param int $taille_max
  *   taille maxi de la copie local, par defaut _COPIE_LOCALE_MAX_SIZE
- * @return bool|string
+ * @return string|false
  */
 function copie_locale($source, $mode = 'auto', $local = null, $taille_max = null) {
 
@@ -343,7 +343,7 @@ 
  * La fonction PHP idn_to_ascii depend d'un package php5-intl et est rarement disponible
  *
  * @param string $url_idn
- * @return array|string
+ * @return string|boolean
  */
 function url_to_ascii($url_idn) {
 
@@ -738,7 +738,7 @@ 
  *
  * @param resource $handle
  * @param int|bool $if_modified_since
- * @return bool|array
+ * @return string
  *   int status
  *   string headers
  *   int last_modified
@@ -1211,9 +1211,9 @@ 
  *   donnees postees
  * @param string $vers
  *   version HTTP
- * @param int|string $date
+ * @param string $date
  *   timestamp pour entente If-Modified-Since
- * @return bool|resource
+ * @return string
  *   false|int si echec
  *   resource socket vers l'url demandee
  */