diff --git a/ecrire/inc/commencer_page.php b/ecrire/inc/commencer_page.php index 4323578cecce064b526721e1add75a3af3ac99d0..1fdb381624b8ec45f53f7049542367f80c185ce5 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 2026b35fb300f281c83281ef74d07feaed310640..48d1511474bed79c059822b3bc6f9025878886af 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 f410fca8c10159e80af784cdfc1bc640d37ddddf..c2c5a505ba628f01a295f6d3af4a623c5376a480 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 2bd59bbeecadc8709335ec56597df681aef064a0..cd6c37e6af1197cee5273278c48226ba6db61b07 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; /**