spip / SPIP

ecrire/inc/charsets.php

Doc Comments +2 added lines, -2 removed lines

@@ -37,7 +37,7 @@ 
  * @param string $charset
  *     Charset à charger.
  *     Par défaut (AUTO), utilise le charset du site
- * @return string|bool
+ * @return string|false
  *     - Nom du charset
  *     - false si le charset n'est pas décrit dans le répertoire charsets/
  **/
@@ -706,7 +706,7 @@ 
  *
  * @param int $num
  *    Numéro de l'entité unicode
- * @return char
+ * @return string
  *    Caractère utf8 si trouvé, '' sinon
  **/
 function caractere_utf_8($num) {

ecrire/inc/cvt_autosave.php

Doc Comments +1 added lines, -1 removed lines

@@ -23,7 +23,7 @@
 /**
  * Nettoyer les échappements
  *
- * @param $val
+ * @param string $val
  * @return string
  */
 function autosave_clean_value($val) {

ecrire/inc/distant.php

Doc Comments +7 added lines, -7 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) {
 
@@ -246,7 +246,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) {
 
@@ -642,13 +642,13 @@ 
  *
  * @param string $url
  *     URL de la page à récupérer
- * @param bool|null|string $trans
+ * @param boolean $trans
  *     - chaîne longue : c'est un nom de fichier (nom pour sa copie locale)
  *     - true : demande d'encodage/charset
  *     - null : ne retourner que les headers
  * @param string $get
  *     Type de requête HTTP à faire (HEAD, GET ou POST)
- * @param int|bool $taille_max
+ * @param integer $taille_max
  *     Arrêter le contenu au-delà (0 = seulement les entetes ==> requête HEAD).
  *     Par defaut taille_max = 1Mo.
  * @param string|array $datas
@@ -774,7 +774,7 @@ 
  *
  * @param resource $handle
  * @param int|bool $if_modified_since
- * @return bool|array
+ * @return string
  *   int status
  *   string headers
  *   int last_modified
@@ -1251,9 +1251,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
  */

ecrire/inc/documents.php

Doc Comments +4 added lines, -4 removed lines

@@ -43,7 +43,7 @@ 
  * @uses _DIR_IMG
  *
  * @param string $fichier
- * @return bool|string
+ * @return string|false
  */
 function get_spip_doc($fichier) {
 	// fichier distant
@@ -125,7 +125,7 @@ 
  * @param string $ext
  * @param string $orig
  * @param string $source
- * @return bool|mixed|string
+ * @return string|false
  */
 function copier_document($ext, $orig, $source) {
 
@@ -162,7 +162,7 @@ 
  * @uses sous_repertoire()
  *
  * @param string $type
- * @return bool|string
+ * @return false|string
  */
 function determine_upload($type = '') {
 	if (!function_exists('autoriser')) {
@@ -202,7 +202,7 @@ 
  * @param bool $move
  *     - `true` : on déplace le fichier source vers le fichier de destination
  *     - `false` : valeur par défaut. On ne fait que copier le fichier source vers la destination.
- * @return bool|mixed|string
+ * @return string|false
  */
 function deplacer_fichier_upload($source, $dest, $move = false) {
 	// Securite

ecrire/inc/editer.php

Doc Comments +4 added lines, -4 removed lines

@@ -314,7 +314,7 @@ 
  * utile pour les textes > 32ko
  *
  * @param  string $texte
- * @return array
+ * @return string[]
  */
 function coupe_trop_long($texte) {
 	$aider = charger_fonction('aider', 'inc');
@@ -347,7 +347,7 @@ 
  *
  * @param string $texte
  * @param string $att_text
- * @return array
+ * @return string[]
  */
 function editer_texte_recolle($texte, $att_text) {
 	if ((strlen($texte) < 29 * 1024)
@@ -373,8 +373,8 @@ 
 /**
  * auto-renseigner le titre si il n'existe pas
  *
- * @param $champ_titre
- * @param $champs_contenu
+ * @param string $champ_titre
+ * @param string[] $champs_contenu
  * @param int $longueur
  */
 function titre_automatique($champ_titre, $champs_contenu, $longueur = null) {

ecrire/inc/envoyer_mail.php

Doc Comments +1 added lines, -1 removed lines

@@ -187,7 +187,7 @@
  * @param string $to
  * @param string $texte
  * @param string $parts
- * @return array
+ * @return string[]
  */
 function mail_normaliser_headers($headers, $from, $to, $texte, $parts = '') {
 	$charset = $GLOBALS['meta']['charset'];

ecrire/inc/filtres.php

Doc Comments +12 added lines, -9 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é
@@ -116,7 +116,7 @@ 
  *
  * @see filtrer() Assez proche
  *
- * @param mixed $arg
+ * @param string $arg
  *     Texte (le plus souvent) sur lequel appliquer le filtre
  * @param string $filtre
  *     Nom du filtre à appliquer
@@ -673,7 +673,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
@@ -1310,7 +1310,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.
@@ -1568,7 +1568,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
@@ -1658,7 +1658,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
@@ -2042,6 +2042,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))); }
 
 /**
@@ -2184,7 +2187,7 @@ 
  *
  * @param string $adresses
  *      Adresse ou liste d'adresse
- * @return bool|string
+ * @return false|string
  *      - false si pas conforme,
  *      - la normalisation de la dernière adresse donnée sinon
  **/
@@ -2518,7 +2521,7 @@ 
  * @param int $a
  * @param int $b
  * @param int $c
- * @return int
+ * @return double
  *      Retourne `$a*$b/$c`
  **/
 function regledetrois($a, $b, $c) {
@@ -4551,7 +4554,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) {

ecrire/inc/install.php

Doc Comments +18 added lines

@@ -234,6 +234,9 @@ 
 
 
 // http://code.spip.net/@info_etape
+/**
+ * @param string $titre
+ */
 function info_etape($titre, $complement = '') {
 	return "<h2>" . $titre . "</h2>\n" .
 	($complement ? "" . $complement . "\n" : '');
@@ -259,6 +262,11 @@ 
 }
 
 // http://code.spip.net/@info_progression_etape
+/**
+ * @param integer $en_cours
+ * @param string $phase
+ * @param string $dir
+ */
 function info_progression_etape($en_cours, $phase, $dir, $erreur = false) {
 	//$en_cours = _request('etape')?_request('etape'):"";
 	$liste = find_all_in_path($dir, $phase . '(([0-9])+|fin)[.]php$');
@@ -315,6 +323,9 @@ 
 
 
 // http://code.spip.net/@fieldset
+/**
+ * @param string $legend
+ */
 function fieldset($legend, $champs = array(), $apres = '', $avant = '') {
 	return "<fieldset>\n" .
 	$avant .
@@ -382,6 +393,10 @@ 
 }
 
 // http://code.spip.net/@install_connexion_form
+/**
+ * @param string[] $pass
+ * @param integer $etape
+ */
 function install_connexion_form($db, $login, $pass, $predef, $hidden, $etape, $jquery = true) {
 	$server_db = (is_string($predef[0])) ? $predef[0] : '';
 
@@ -549,6 +564,9 @@ 
 	return array($checked, $bases);
 }
 
+/**
+ * @param string[] $hidden
+ */
 function install_propager($hidden) {
 	$res = '';
 	foreach ($hidden as $k) {

ecrire/inc/invalideur.php

Doc Comments +4 added lines, -1 removed lines

@@ -41,7 +41,7 @@ 
  * On ne calcule que la racine pour pour aller vite.
  *
  * @param string $dir Chemin du répertoire
- * @param string $nb_estim_taille Nombre de fichiers maximum pour estimer la taille
+ * @param integer $nb_estim_taille Nombre de fichiers maximum pour estimer la taille
  * @return bool|array
  *
  *     - false si le répertoire ne peut pas être ouvert
@@ -336,6 +336,9 @@ 
 
 // Calcul des pages : noter dans la base les liens d'invalidation
 // http://code.spip.net/@maj_invalideurs
+/**
+ * @param string $fichier
+ */
 function maj_invalideurs($fichier, &$page) {
 }