spip / SPIP

ecrire/inc/install.php

Doc Comments +18 added lines

@@ -234,6 +234,9 @@ 
 
 
 // https://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 @@ 
 }
 
 // https://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 @@ 
 
 
 // https://code.spip.net/@fieldset
+/**
+ * @param string $legend
+ */
 function fieldset($legend, $champs = array(), $apres = '', $avant = '') {
 	return "<fieldset>\n" .
 	$avant .
@@ -382,6 +393,10 @@ 
 }
 
 // https://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] : '';
 
@@ -559,6 +574,9 @@ 
 	return array($checked, $bases);
 }
 
+/**
+ * @param string[] $hidden
+ */
 function install_propager($hidden) {
 	$res = '';
 	foreach ($hidden as $k) {

ecrire/inc/invalideur.php

Doc Comments +8 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
@@ -270,6 +270,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);
@@ -292,6 +296,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/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
 // 
 // https://code.spip.net/@menu_langues
+/**
+ * @param string $nom_select
+ */
 function menu_langues($nom_select, $default = '') {
 	include_spip('inc/actions');
 
@@ -209,6 +215,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/lien.php

Doc Comments +13 added lines, -1 removed lines

@@ -42,6 +42,9 @@ 
 define('_RACCOURCI_LIEN', "/\[([^][]*?([[]\w*[]][^][]*)*)->(>?)([^]]*)\]/msS");
 
 // https://code.spip.net/@expanser_liens
+/**
+ * @return string
+ */
 function expanser_liens($t, $connect = '', $env = array()) {
 
 	$t = pipeline('pre_liens', $t);
@@ -56,6 +59,9 @@ 
 // Meme analyse mais pour eliminer les liens
 // et ne laisser que leur titre, a expliciter si ce n'est fait
 // https://code.spip.net/@nettoyer_raccourcis_typo
+/**
+ * @param string $texte
+ */
 function nettoyer_raccourcis_typo($texte, $connect = '') {
 	return $texte;
 }
@@ -96,6 +102,9 @@ 
 // 'url':   seulement U  (i.e. generer_url_RACCOURCI)
 
 // https://code.spip.net/@calculer_url
+/**
+ * @return string
+ */
 function calculer_url($ref, $texte = '', $pour = 'url', $connect = '', $echappe_typo = true) {
 	$r = traiter_lien_implicite($ref, $texte, $pour, $connect, $echappe_typo);
 
@@ -256,7 +265,7 @@ 
  * @param int $id Identifiant de l'objet
  * @param string $type Type d'objet
  * @param string|null $connect Connecteur SQL utilisé
- * @return array {
+ * @return string {
  * @var string $titre Titre si présent, sinon ''
  * @var string $lang Langue si présente, sinon ''
  * }
@@ -302,6 +311,9 @@ 
 define('_RACCOURCI_MODELE_DEBUT', '@^' . _RACCOURCI_MODELE . '@isS');
 
 // https://code.spip.net/@traiter_modeles
+/**
+ * @return string
+ */
 function traiter_modeles($texte, $doublons = false, $echap = '', $connect = '', $liens = null, $env = array()) {
 	// preserver la compatibilite : true = recherche des documents
 	if ($doublons === true) {

ecrire/inc/math.php

Doc Comments +3 added lines

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

ecrire/inc/presentation.php

Doc Comments +7 added lines

@@ -30,6 +30,9 @@ 
 include_spip('inc/filtres_boites');
 
 // 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',
@@ -183,6 +186,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/inc/texte_mini.php

Doc Comments +9 added lines

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

ecrire/inc/utils.php

Doc Comments +14 added lines, -5 removed lines

@@ -985,6 +985,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();
@@ -1062,7 +1065,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)`
@@ -1101,7 +1104,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');
@@ -1417,6 +1420,9 @@ 
 	return $themes;
 }
 
+/**
+ * @return string
+ */
 function find_in_theme($file, $subdir = '', $include = false) {
 	static $themefiles = array();
 	if (isset($themefiles["$subdir$file"])) {
@@ -1861,6 +1867,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;
@@ -2118,7 +2127,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` )
@@ -3315,7 +3324,7 @@ 
 /**
  * Trouve un squelette dans le repertoire modeles/
  *
- * @param  $nom
+ * @param  string $nom
  * @return string
  */
 function trouve_modele($nom) {
@@ -3533,7 +3542,7 @@ 
 		 *
 		 * @param array $input A multi-dimensional array (record set) from which to pull
 		 *                     a column of values.
-		 * @param mixed $columnKey The column of values to return. This value may be the
+		 * @param string $columnKey The column of values to return. This value may be the
 		 *                         integer key of the column you wish to retrieve, or it
 		 *                         may be the string key name for an associative array.
 		 * @param mixed $indexKey (Optional.) The column to use as the index/keys for

ecrire/install/etape_3.php

Doc Comments +3 added lines

@@ -248,6 +248,9 @@
 
 
 // https://code.spip.net/@install_premier_auteur
+/**
+ * @param string $hidden
+ */
 function install_premier_auteur($email, $login, $nom, $pass, $hidden, $auteur_obligatoire) {
 	return info_progression_etape(3, 'etape_', 'install/') .
 	info_etape(