From 8fe511cfe93bbe674ce208b0dd086519fcaea0e8 Mon Sep 17 00:00:00 2001
From: amemo <amemo@rezo.net>
Date: Sat, 10 May 2014 01:45:43 +0000
Subject: [PATCH] =?UTF-8?q?Documentation=20du=20code=20:=20-=20auteurs=5Fr?=
=?UTF-8?q?ecemment=5Fconnectes=20(par=20Ybbet)=20:=C2=A0=20-=20lien=5Fcha?=
=?UTF-8?q?nge=5Fvar=20(par=20Ybbet)=20:=C2=A0=20-=20actualise=5Fmetas=20(?=
=?UTF-8?q?par=20Ybbet)=20:=C2=A0=20-=20appliquer=5Fadresse=5Fsite=20(par?=
=?UTF-8?q?=20Ybbet)=20:=C2=A0=20-=20appliquer=5Fmodifs=5Fconfig=20(par=20?=
=?UTF-8?q?Ybbet)=20:=C2=A0=20-=20lister=5Fconfigurer=20(par=20Ybbet)=20:?=
=?UTF-8?q?=C2=A0=20-=20lister=5Fformulaires=5Fconfigurer=20(par=20Ybbet)?=
=?UTF-8?q?=20:=C2=A0Accents=E2=80=A6=20-=20liste=5Fmetas=20(par=20Ybbet)?=
=?UTF-8?q?=20:=C2=A0=20-=20En-t=C3=AAte=20de=20couleurs.php=20(par=20Ybbe?=
=?UTF-8?q?t)=20:=C2=A0=20-=20inc=5Fcouleurs=5Fdist=20(par=20Ybbet)=20:?=
=?UTF-8?q?=C2=A0=20-=20En-t=C3=AAte=20de=20csv.php=20(par=20Ybbet)=20:?=
=?UTF-8?q?=C2=A0?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Relecteur : Matthieu Marcillaud
---
ecrire/inc/commencer_page.php | 20 +++++++++--
ecrire/inc/config.php | 66 ++++++++++++++++++++++++++++-------
ecrire/inc/couleurs.php | 31 +++++++++++-----
ecrire/inc/csv.php | 6 ++++
4 files changed, 100 insertions(+), 23 deletions(-)
diff --git a/ecrire/inc/commencer_page.php b/ecrire/inc/commencer_page.php
index 4323578cec..1fdb381624 100644
--- a/ecrire/inc/commencer_page.php
+++ b/ecrire/inc/commencer_page.php
@@ -161,13 +161,29 @@ function init_body_class() {
}
-// http://doc.spip.org/@lien_change_var
+/**
+ * Créer un `<area shape="rect" />`
+ *
+ * @deprecated since version 2.0.0
+ * @param string $lien
+ * @param string $set
+ * @param string $couleur
+ * @param string $coords
+ * @param string $titre
+ * @param string $mouseOver
+ * @return string
+ */
function lien_change_var($lien, $set, $couleur, $coords, $titre, $mouseOver="") {
$lien = parametre_url($lien, $set, $couleur);
return "\n<area shape='rect' href='$lien' coords='$coords' title=\"$titre\" alt=\"$titre\" $mouseOver />";
}
-// http://doc.spip.org/@auteurs_recemment_connectes
+/**
+ * Afficher la liste des auteurs connectés à l'espace privé
+ *
+ * @param integer $id_auteur
+ * @return string
+ */
function auteurs_recemment_connectes($id_auteur){
return recuperer_fond('prive/objets/liste/auteurs_enligne');
}
diff --git a/ecrire/inc/config.php b/ecrire/inc/config.php
index 2026b35fb3..48d1511474 100644
--- a/ecrire/inc/config.php
+++ b/ecrire/inc/config.php
@@ -289,7 +289,19 @@ function effacer_config($cfg){
return true;
}
-
+/**
+ * Lister toutes les pages de configuration du site.
+ *
+ * Y compris celles fournies par des plugins.
+ *
+ * @uses _EXTENSION_SQUELETTES
+ * @uses find_all_in_path()
+ * @uses find_in_theme()
+ * @uses lister_formulaires_configurer()
+ *
+ * @param array $exclure
+ * @return array
+ */
function lister_configurer($exclure = array()){
return array();
@@ -359,10 +371,12 @@ function lister_configurer($exclure = array()){
/**
* Retourne la liste des formulaires de configuration
- * presents dans le fichier dont l'adresse est donnee
+ * présents dans le fichier dont l'adresse est donnée
*
- * @param string $file adresse du fichier
- * @return array liste des formulaires trouves
+ * @param string $file
+ * Adresse du fichier
+ * @return array
+ * Liste des formulaires trouvés
**/
function lister_formulaires_configurer($file) {
$forms = array();
@@ -396,7 +410,19 @@ function lister_formulaires_configurer($file) {
}
-// http://doc.spip.org/@liste_metas
+/**
+ * Définir les `meta` de configuration
+ *
+ * @pipeline_appel configurer_liste_metas
+ *
+ * @uses url_de_base()
+ * @uses _DEFAULT_CHARSET
+ * @uses _DIR_IMG
+ * @uses _DIR_RACINE
+ *
+ * @return array
+ * Couples nom de la `meta` => valeur par défaut
+ */
function liste_metas()
{
return pipeline('configurer_liste_metas', array(
@@ -453,10 +479,13 @@ function liste_metas()
));
}
-// mets les meta a des valeurs conventionnelles quand elles sont vides
-// et recalcule les langues
-
-// http://doc.spip.org/@actualise_metas
+/**
+ * Mets les `meta` Ã des valeurs conventionnelles quand elles sont vides
+ * et recalcule les langues
+ *
+ * @param array $liste_meta
+ * @return void
+ */
function actualise_metas($liste_meta)
{
$meta_serveur =
@@ -482,7 +511,18 @@ function actualise_metas($liste_meta)
// Gestion des modifs
//
-// http://doc.spip.org/@appliquer_modifs_config
+/**
+ * Appliquer les modifications apportées aux `metas`
+ *
+ * Si `$purger_skel` est à `true`, on purge le répertoire de cache des squelettes
+ *
+ * @uses liste_metas()
+ * @uses ecrire_meta()
+ * @uses purger_repertoire()
+ *
+ * @param bool $purger_skel
+ * @return void
+ */
function appliquer_modifs_config($purger_skel=false) {
foreach(liste_metas() as $i => $v) {
@@ -499,10 +539,10 @@ function appliquer_modifs_config($purger_skel=false) {
}
/**
- * Mettre a jour l'adresse du site a partir d'une valeur saisie
- * (ou auto detection si vide)
+ * Mettre à jour l'adresse du site à partir d'une valeur saisie
+ * (ou auto détection si vide)
*
- * @param $adresse_site
+ * @param string $adresse_site
* @return void
*/
function appliquer_adresse_site($adresse_site){
diff --git a/ecrire/inc/couleurs.php b/ecrire/inc/couleurs.php
index f410fca8c1..c2c5a505ba 100644
--- a/ecrire/inc/couleurs.php
+++ b/ecrire/inc/couleurs.php
@@ -10,16 +10,31 @@
* Pour plus de details voir le fichier COPYING.txt ou l'aide en ligne. *
\***************************************************************************/
-if (!defined('_ECRIRE_INC_VERSION')) return;
+/**
+ * Couleurs de l'interface de l’espace privé de SPIP.
+ *
+ * @package SPIP\Core\Couleurs
+ */
-// Appelee sans argument, cette fonction retourne un menu de couleurs
-// Avec un argument numerique, elle retourne les parametres d'URL
-// pour les feuilles de style calculees (cf commencer_page et svg)
-// Avec un argument de type tableau, soit elle remplace le tableau par defaut
-// par celui donne en argument, soit, avec le second parametre
-// a true, elle complete le tableau par celui donne en premier argument.
+if (!defined('_ECRIRE_INC_VERSION')) return;
-// http://doc.spip.org/@inc_couleurs_dist
+/**
+ * Obtenir ou définir les différents jeux de couleurs de l'espace privé
+ *
+ * - Appelée _sans argument_, cette fonction retourne un menu de couleurs.
+ * - Avec un _argument numérique_, elle retourne les paramètres d'URL
+ * pour les feuilles de style calculées (cf `commencer_page` et `svg`)
+ * - Avec un _argument de type tableau_, soit elle remplace le tableau par défaut
+ * par celui donné en argument, _soit_, avec le second paramètre
+ * à `true`, elle complète le tableau par celui donné en premier argument.
+ *
+ * @see commencer_page()
+ *
+ * @staticvar array $couleurs_spip
+ * @param null|int|array $choix
+ * @param bool $ajouter
+ * @return array
+ */
function inc_couleurs_dist($choix=NULL, $ajouter=false)
{
static $couleurs_spip = array(
diff --git a/ecrire/inc/csv.php b/ecrire/inc/csv.php
index 2bd59bbeec..cd6c37e6af 100644
--- a/ecrire/inc/csv.php
+++ b/ecrire/inc/csv.php
@@ -10,6 +10,12 @@
* Pour plus de details voir le fichier COPYING.txt ou l'aide en ligne. *
\***************************************************************************/
+/**
+ * Analyse de fichiers CSV
+ *
+ * @package SPIP\Core\CSV
+ */
+
if (!defined('_ECRIRE_INC_VERSION')) return;
/**
--
GitLab