spip / SPIP

ecrire/base/dump.php

Doc Comments +1 added lines, -1 removed lines

@@ -311,7 +311,7 @@
  * peut etre utilise pour l'import depuis xml,
  * ou la copie de base a base (mysql<->sqlite par exemple)
  *
- * @param array $tables
+ * @param string[] $tables
  * @param array $exclure_tables
  * @param string $serveur
  */

ecrire/inc/cookie.php

Doc Comments +1 added lines, -1 removed lines

@@ -35,7 +35,7 @@
  *     Chemin sur lequel le cookie sera disponible
  * @param string $domain
  *     Domaine à partir duquel le cookie est disponible
- * @param bool $secure
+ * @param string|boolean $secure
  *     cookie sécurisé ou non ?
  * @return bool
  *     true si le cookie a été posé, false sinon.

ecrire/inc/modifier.php

Doc Comments +1 added lines, -1 removed lines

@@ -83,7 +83,7 @@
  *     Couples champ/valeur à modifier
  * @param string $serveur
  *     Nom du connecteur à la base de données
- * @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_images_mini.php

Doc Comments +1 added lines, -1 removed lines

@@ -122,7 +122,7 @@
  * @param int $height_max
  *    Hauteur minimale de l'image à traiter (10000 par défaut)
  * @return
- *    Le tag html `<img src=... />` avec une class `filtre_inactif` ou pas
+ string    Le tag html `<img src=... />` avec une class `filtre_inactif` ou pas
  */
 function image_select($img, $width_min = 0, $height_min = 0, $width_max = 10000, $height_max = 1000) {
 	if (!$img) {

ecrire/inc/flock.php

Doc Comments +1 added lines, -1 removed lines

@@ -644,7 +644,7 @@
  *
  * @param string $dir
  *     Répertoire à parcourir
- * @param int|string $pattern
+ * @param integer $pattern
  *     Expression régulière pour trouver des fichiers, tel que `[.]lock$`
  * @param int $maxfiles
  *     Nombre de fichiers maximums retournés

ecrire/inc/lang.php

Doc Comments +11 added lines, -1 removed lines

@@ -31,7 +31,7 @@ 
  *
  * @param string $lang
  *     La langue à utiliser
- * @return string|bool
+ * @return false|string
  *     string : La langue qui a été utilisée si trouvée
  *     false : aucune langue ne correspondait à la demande
  **/
@@ -80,6 +80,9 @@ 
 // retourne son 2e argument si c'est un index du premier
 // ou un index approchant sinon et si possible, 
 // la langue X etant consideree comme une approche de X_Y
+/**
+ * @return string
+ */
 function approcher_langue($trads, $lang = '') {
 
 	if (!$lang) {
@@ -175,6 +178,9 @@ 
 // pour 'changer_lang' (langue de l'article, espace prive), c'est en Ajax
 // 
 // http://code.spip.net/@menu_langues
+/**
+ * @param string $nom_select
+ */
 function menu_langues($nom_select, $default = '') {
 	include_spip('inc/actions');
 
@@ -209,6 +215,10 @@ 
 }
 
 // http://code.spip.net/@select_langues
+/**
+ * @param string $change
+ * @param string $options
+ */
 function select_langues($nom_select, $change, $options, $label = "") {
 	static $cpt = 0;
 	$id = "menu_langues" . $cpt++;

ecrire/inc/queue.php

Doc Comments +3 added lines, -3 removed lines

@@ -32,7 +32,7 @@ 
  *
  * @param $function
  *   The function name to call.
- * @param $description
+ * @param string $description
  *   A human-readable description of the queued job.
  * @param $arguments
  *   Optional array of arguments to pass to the function.
@@ -162,7 +162,7 @@ 
  *
  * @param int $id_job
  *  id de la tache a retirer
- * @return bool
+ * @return boolean|string
  */
 function queue_remove_job($id_job) {
 	include_spip('base/abstract_sql');
@@ -466,7 +466,7 @@ 
  *     Nom de la fonction de tâche
  * @param string $inclure
  *     Nom de l'inclusion contenant la fonction
- * @return bool|int
+ * @return integer
  *     Périodicité de la tâche en secondes, si tâche périodique, sinon false.
  */
 function queue_is_cron_job($function, $inclure) {

ecrire/inc/texte_mini.php

Doc Comments +9 added lines

@@ -80,6 +80,9 @@ 
 // une $source differente ; le script detecte automagiquement si ce qu'on
 // echappe est un div ou un span
 // http://code.spip.net/@code_echappement
+/**
+ * @param string $mode
+ */
 function code_echappement($rempl, $source = '', $no_transform = false, $mode = null) {
 	if (!strlen($rempl)) {
 		return '';
@@ -284,6 +287,9 @@ 
 // Reinserer le javascript de confiance (venant des modeles)
 
 // http://code.spip.net/@echappe_retour_modeles
+/**
+ * @param string $letexte
+ */
 function echappe_retour_modeles($letexte, $interdire_scripts = false) {
 	$letexte = echappe_retour($letexte);
 
@@ -433,6 +439,9 @@ 
 }
 
 
+/**
+ * @param string $letexte
+ */
 function echapper_faux_tags($letexte) {
 	if (strpos($letexte, '<') === false) {
 		return $letexte;

ecrire/public/phraser_html.php

Doc Comments +23 added lines

@@ -98,6 +98,10 @@ 
 }
 
 // http://code.spip.net/@phraser_polyglotte
+/**
+ * @param string $texte
+ * @param integer $ligne
+ */
 function phraser_polyglotte($texte, $ligne, $result) {
 
 	if (preg_match_all(BALISE_POLYGLOTTE, $texte, $m, PREG_SET_ORDER)) {
@@ -260,6 +264,9 @@ 
 // on recommence tant qu'il y a des [...] en substituant a l'appel suivant
 
 // http://code.spip.net/@phraser_champs_etendus
+/**
+ * @param integer $ligne
+ */
 function phraser_champs_etendus($texte, $ligne, $result) {
 	if ($texte === "") {
 		return $result;
@@ -279,6 +286,9 @@ 
 // Tres chevelu
 
 // http://code.spip.net/@phraser_args
+/**
+ * @param string $fin
+ */
 function phraser_args($texte, $fin, $sep, $result, &$pointeur_champ) {
 	$texte = ltrim($texte);
 	while (($texte !== "") && strpos($fin, $texte[0]) === false) {
@@ -293,6 +303,9 @@ 
 }
 
 // http://code.spip.net/@phraser_arg
+/**
+ * @param string $texte
+ */
 function phraser_arg(&$texte, $sep, $result, &$pointeur_champ) {
 	preg_match(",^(\|?[^}{)|]*)(.*)$,ms", $texte, $match);
 	$suite = ltrim($match[2]);
@@ -430,6 +443,9 @@ 
 
 
 // http://code.spip.net/@phraser_champs_exterieurs
+/**
+ * @param string $texte
+ */
 function phraser_champs_exterieurs($texte, $ligne, $sep, $nested) {
 	$res = array();
 	while (($p = strpos($texte, "%$sep")) !== false) {
@@ -449,6 +465,9 @@ 
 }
 
 // http://code.spip.net/@phraser_champs_interieurs
+/**
+ * @param string $sep
+ */
 function phraser_champs_interieurs($texte, $ligne, $sep, $result) {
 	$i = 0; // en fait count($result)
 	$x = "";
@@ -742,6 +761,10 @@ 
 }
 
 // http://code.spip.net/@phraser_critere_infixe
+/**
+ * @param string $arg1
+ * @param string $arg2
+ */
 function phraser_critere_infixe($arg1, $arg2, $args, $op, $not, $cond) {
 	$args[0] = new Texte;
 	$args[0]->texte = $arg1;