spip / SPIP

ecrire/inc/lang.php

Doc Comments +11 added lines, -1 removed lines

@@ -33,7 +33,7 @@ 
  *     La langue à utiliser
  * @param string|array $liste_langues
  *     La liste des langues valides
- * @return string|bool
+ * @return false|string
  *     string : La langue qui a été utilisée si trouvée
  *     false : aucune langue ne correspondait à la demande
  **/
@@ -89,6 +89,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) {
@@ -184,6 +187,9 @@ 
 // pour 'changer_lang' (langue de l'article, espace prive), c'est en Ajax
 // 
 // https://code.spip.net/@menu_langues
+/**
+ * @param string $nom_select
+ */
 function menu_langues($nom_select, $default = '') {
 	include_spip('inc/actions');
 
@@ -218,6 +224,10 @@ 
 }
 
 // https://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/actions.php

Doc Comments +3 added lines, -3 removed lines

@@ -35,11 +35,11 @@ 
  *     - -1 : renvoyer action, arg et hash sous forme de array()
  *     - true ou false : renvoyer une url, avec `&` (false) ou `&` (true)
  *     - string : renvoyer un formulaire
- * @param string|int $att
+ * @param string $att
  *     - id_auteur pour lequel générer l'action en mode url ou array()
  *     - attributs du formulaire en mode formulaire
  * @param bool $public
- * @return array|string
+ * @return string
  *     URL, code HTML du formulaire ou tableau (action, arg, hash)
  */
 function generer_action_auteur($action, $arg = '', $redirect = '', $mode = false, $att = '', $public = false) {
@@ -66,7 +66,7 @@ 
  *     que l'on peut récupérer dans une fonction d'action par `_request('redirect')`
  * @param string $gra
  *     Arguments transmis au script exec de retour `arg1=yy&arg2=zz`
- * @param bool|string|int $mode
+ * @param boolean $mode
  *     - -1 : renvoyer action, arg et hash sous forme de array()
  *     - true ou false : renvoyer une url, avec `&` (false) ou `&` (true)
  *     - string : renvoyer un formulaire

ecrire/public/cacher.php

Doc Comments +1 added lines, -1 removed lines

@@ -41,7 +41,7 @@
  * Attention a modifier simultanement le sanity check de
  * la fonction retire_cache() de inc/invalideur
  *
- * @param $nom_cache
+ * @param string $nom_cache
  * @return string
  */
 function cache_chemin_fichier($nom_cache, $ecrire = false) {

ecrire/inc/importer_csv.php

Doc Comments +2 added lines, -2 removed lines

@@ -34,12 +34,12 @@
  * Importe un texte de CSV dans un charset et le passe dans le charset du site (utf8 probablement)
  * Les CSV peuvent sous ms@@@ avoir le charset 'iso-8859-1', mais pasfois aussi 'windows-1252' :/
  *
- * @param mixed $texte
+ * @param string $texte
  * @param bool|string $definir_charset_source
  *     false : ne fait rien
  *     string : utilisera pour les prochains imports le charset indiqué
  *     true : remet le charset d'import par défaut de la fonction
- * @return array
+ * @return string
  */
 function importer_csv_importcharset($texte, $definir_charset_source = false) {
 	// le plus frequent, en particulier avec les trucs de ms@@@

ecrire/inc/email_valide.php

Doc Comments +1 added lines, -1 removed lines

@@ -26,7 +26,7 @@
  *
  * @param string $adresses
  *      Adresse ou liste d'adresse (separees pas des virgules)
- * @return bool|string
+ * @return false|string
  *      - false si une des adresses n'est pas conforme,
  *      - la normalisation de la dernière adresse donnée sinon
  **/

ecrire/inc/invalideur.php

Doc Comments +7 added lines

@@ -232,6 +232,10 @@ 
 // (note: si absente, n'est pas appellee)
 
 // https://code.spip.net/@calcul_invalideurs
+/**
+ * @param string $corps
+ * @param string $id_boucle
+ */
 function calcul_invalideurs($corps, $primary, &$boucles, $id_boucle) {
 	if ($calcul_invalideurs = charger_fonction('calcul_invalideurs', 'inc', true)) {
 		return $calcul_invalideurs($corps, $primary, $boucles, $id_boucle);
@@ -254,6 +258,9 @@ 
 
 // Calcul des pages : noter dans la base les liens d'invalidation
 // https://code.spip.net/@maj_invalideurs
+/**
+ * @param string $fichier
+ */
 function maj_invalideurs($fichier, &$page) {
 	if ($maj_invalideurs = charger_fonction('maj_invalideurs', 'inc', true)) {
 		return $maj_invalideurs($fichier, $page);

ecrire/inc/filtres_images_lib_mini.php

Doc Comments +8 added lines, -6 removed lines

@@ -87,7 +87,7 @@ 
  *
  * @param bool|string $stat
  *     true, false ou le statut déjà défini si traitements enchaînés.
- * @return bool
+ * @return false|null
  *     true si il faut supprimer le fichier temporaire ; false sinon.
  */
 function statut_effacer_images_temporaires($stat) {
@@ -370,8 +370,7 @@ 
 
 
 /**
- * @param string $quoi
- * @return array
+ * @return string[]
  */
 function _image_extensions_acceptees_en_entree() {
 	static $extensions = null;
@@ -409,6 +408,9 @@ 
 	return $extensions;
 }
 
+/**
+ * @param string $extension
+ */
 function _image_extension_normalisee($extension){
 	$extension = strtolower($extension);
 	if ($extension === 'jpeg') {
@@ -1450,7 +1452,7 @@ 
  * @param int $srcHeight Hauteur de l'image source
  * @param int $maxWidth Largeur maximum souhaitée
  * @param int $maxHeight Hauteur maximum souhaitée
- * @return array Liste [ largeur, hauteur, ratio de réduction ]
+ * @return integer[] Liste [ largeur, hauteur, ratio de réduction ]
  **/
 function _image_ratio($srcWidth, $srcHeight, $maxWidth, $maxHeight) {
 	$ratioWidth = $srcWidth / $maxWidth;
@@ -1488,7 +1490,7 @@ 
  * @param int $srcHeight Hauteur de l'image source
  * @param int $maxWidth Largeur maximum souhaitée
  * @param int $maxHeight Hauteur maximum souhaitée
- * @return array Liste [ largeur, hauteur, ratio de réduction ]
+ * @return integer[] Liste [ largeur, hauteur, ratio de réduction ]
  **/
 function ratio_passe_partout($srcWidth, $srcHeight, $maxWidth, $maxHeight) {
 	$ratioWidth = $srcWidth / $maxWidth;
@@ -1707,7 +1709,7 @@ 
 	/**
 	 * Transforme une ressource GD en image au format ICO
 	 *
-	 * @param array $gd_image_array
+	 * @param resource[] $gd_image_array
 	 *     Tableau de ressources d'images GD
 	 * @return string
 	 *     Image au format ICO

ecrire/public/composer.php

Doc Comments +8 added lines, -1 removed lines

@@ -148,6 +148,10 @@ 
 	return $nom ? $nom : false;
 }
 
+/**
+ * @param string $squelette
+ * @param string $phpfile
+ */
 function squelette_traduit($squelette, $sourcefile, $phpfile, $boucles) {
 
 	// Le dernier index est '' (fonction principale)
@@ -172,6 +176,9 @@ 
 
 // Le squelette compile est-il trop vieux ?
 // https://code.spip.net/@squelette_obsolete
+/**
+ * @param string $skel
+ */
 function squelette_obsolete($skel, $squelette) {
 	static $date_change = null;
 	// ne verifier la date de mes_fonctions et mes_options qu'une seule fois
@@ -485,7 +492,7 @@ 
  * tel que "A_B_C_", sinon "A_B_" sinon "A_"
  * 
  * @param string $nom
- * @return array|null
+ * @return string
  */
 function chercher_balise_generique($nom) {
 	if (false === strpos($nom, "_")) {

ecrire/inc/utils.php

Doc Comments +13 added lines, -4 removed lines

@@ -1016,6 +1016,9 @@ 
 // Renvoie False si un fichier n'est pas plus vieux que $duree secondes,
 // sinon renvoie True et le date sauf si ca n'est pas souhaite
 // https://code.spip.net/@spip_touch
+/**
+ * @param string $fichier
+ */
 function spip_touch($fichier, $duree = 0, $touch = true) {
 	if ($duree) {
 		clearstatcache();
@@ -1093,7 +1096,7 @@ 
  * @param string $description
  *     Une description humainement compréhensible de ce que fait la tâche
  *     (essentiellement pour l’affichage dans la page de suivi de l’espace privé)
- * @param array $arguments
+ * @param integer[] $arguments
  *     Facultatif, vide par défaut : les arguments qui seront passés à la fonction, sous forme de tableau PHP
  * @param string $file
  *     Facultatif, vide par défaut : nom du fichier à inclure, via `include_spip($file)`
@@ -1132,7 +1135,7 @@ 
  *
  * @param int $id_job
  *  id of jonb to delete
- * @return bool
+ * @return boolean|string
  */
 function job_queue_remove($id_job) {
 	include_spip('inc/queue');
@@ -1448,6 +1451,9 @@ 
 	return $themes;
 }
 
+/**
+ * @return string
+ */
 function find_in_theme($file, $subdir = '', $include = false) {
 	static $themefiles = array();
 	if (isset($themefiles["$subdir$file"])) {
@@ -1892,6 +1898,9 @@ 
 }
 
 // https://code.spip.net/@generer_url_entite_absolue
+/**
+ * @param boolean|string $connect
+ */
 function generer_url_entite_absolue($id = '', $entite = '', $args = '', $ancre = '', $connect = null) {
 	if (!$connect) {
 		$connect = true;
@@ -2149,7 +2158,7 @@ 
  *
  * @param string $script
  *     Nom de la page
- * @param string|array $args
+ * @param string $args
  *     Arguments à transmettre a l'URL,
  *      soit sous la forme d'un string tel que `arg1=yy&arg2=zz`
  *      soit sous la forme d'un array tel que array( `arg1` => `yy`, `arg2` => `zz` )
@@ -3351,7 +3360,7 @@ 
 /**
  * Trouve un squelette dans le repertoire modeles/
  *
- * @param  $nom
+ * @param  string $nom
  * @return string
  */
 function trouve_modele($nom) {