spip / SPIP

ecrire/balise/logo_.php

Doc Comments +1 added lines, -1 removed lines

@@ -148,7 +148,7 @@
  * @param int $fichier
  *     - -1 pour retourner juste le chemin de l'image
  *     - 0 pour retourner le code HTML de l'image
- * @param string $lien
+ * @param string $_lien
  *     Lien pour encadrer l'image avec si présent
  * @param Champ $p
  *     Pile au niveau de la balise

ecrire/public/fonctions.php

Doc Comments +1 added lines, -1 removed lines

@@ -592,7 +592,7 @@
  * [(#ENV{objet_source}|rang_lien{#ID_AUTEUR,#ENV{objet},#ENV{id_objet},#ENV{_objet_lien}})]
  *
  * @param $objet_source
- * @param $ids
+ * @param integer $ids
  * @param $objet_lie
  * @param $idl
  * @param $objet_lien

ecrire/public/aiguiller.php

Doc Comments +3 added lines

@@ -14,6 +14,9 @@
 	return;
 }
 
+/**
+ * @return string|null
+ */
 function securiser_redirect_action($redirect) {
 	// cas d'un double urlencode : si un urldecode de l'url n'est pas secure, on retient ca comme redirect
 	if (strpos($redirect, '%') !== false) {

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/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/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/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(

ecrire/plugins/afficher_plugin.php

Doc Comments +13 added lines

@@ -121,6 +121,10 @@ 
 // checkbox pour activer ou desactiver
 // si ce n'est pas une extension
 
+/**
+ * @param integer $id_input
+ * @param string $file
+ */
 function plugin_checkbox($id_input, $file, $actif) {
 	$name = substr(md5($file), 0, 16);
 
@@ -185,6 +189,9 @@ 
 	. "</div>";
 }
 
+/**
+ * @param string $nom
+ */
 function plugin_desintalle($plug_file, $nom, $dir_plugins = null) {
 	if (!$dir_plugins) {
 		$dir_plugins = _DIR_PLUGINS;
@@ -221,6 +228,9 @@ 
 }
 
 // https://code.spip.net/@plugin_propre
+/**
+ * @return string
+ */
 function plugin_propre($texte, $module = '',$propre='propre') {
 	// retirer le retour a la racine du module, car le find_in_path se fait depuis la racine
 	if (_DIR_RACINE and strncmp($module, _DIR_RACINE, strlen(_DIR_RACINE)) == 0) {
@@ -233,6 +243,9 @@ 
 	return $propre($texte);
 }
 
+/**
+ * @return string
+ */
 function plugin_typo($texte, $module = '') {
 	return plugin_propre($texte, $module, 'typo');
 }