spip / SPIP

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/math.php

Doc Comments +3 added lines

@@ -21,6 +21,9 @@
 //
 
 // http://code.spip.net/@image_math
+/**
+ * @param string $tex
+ */
 function produire_image_math($tex) {
 
 	switch ($GLOBALS['traiter_math']) {

ecrire/inc/plugin.php

Doc Comments +2 added lines, -2 removed lines

@@ -623,11 +623,11 @@
  * 
  * @param $liste
  *    Liste de description des plugins
- * @param $nom
+ * @param string $nom
  *    Le plugin donc on cherche la presence
  * @param $intervalle
  *    L'éventuelle intervalle de compatibilité de la dépendance. ex: [1.1.0;]
- * @param $balise
+ * @param string $balise
  *    Permet de définir si on teste un utilise ou un nécessite
  * @return string.
  *    Vide si ok,

ecrire/inc/prepare_recherche.php

Doc Comments +1 added lines, -1 removed lines

@@ -165,7 +165,7 @@
  * @param string $primary
  * @param array $rows
  * @param string $serveur
- * @return array
+ * @return string[]
  */
 function generer_select_where_explicites($table, $primary, $rows, $serveur) {
 	# calculer le {id_article IN()} et le {... as points}

ecrire/inc/presentation.php

Doc Comments +7 added lines

@@ -30,6 +30,9 @@ 
 include_spip('inc/filtres_boites');
 
 // http://code.spip.net/@debut_cadre
+/**
+ * @param string $style
+ */
 function debut_cadre($style, $icone = "", $fonction = "", $titre = "", $id = "", $class = "", $padding = true) {
 	$style_mapping = array(
 		'r' => 'simple',
@@ -183,6 +186,10 @@ 
 function fin_onglet() { return "</ul></div>\n"; }
 
 // http://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/inc/puce_statut.php

Doc Comments +7 added lines

@@ -415,6 +415,13 @@
 }
 
 
+/**
+ * @param integer $id
+ * @param string $type
+ * @param double $n
+ * @param string|null $img
+ * @param string $titre
+ */
 function afficher_script_statut($id, $type, $n, $img, $statut, $titre, $act = '') {
 	$h = generer_action_auteur("instituer_objet", "$type-$id-$statut");
 	$h = "selec_statut('$id', '$type', $n, jQuery('img',this).attr('src'), '$h');return false;";