From 07b387cece48d080c820ef8d8815d27225e2cdc8 Mon Sep 17 00:00:00 2001
From: Matthieu Marcillaud <marcimat@rezo.net>
Date: Tue, 19 Mar 2013 16:13:34 +0000
Subject: [PATCH] Quelques PHPDoc

---
 ecrire/inc/cookie.php                  |  2 +-
 ecrire/inc/presentation_mini.php       | 21 ++++++++++++++++++---
 prive/formulaires/recherche_ecrire.php | 19 ++++++++++++++++++-
 3 files changed, 37 insertions(+), 5 deletions(-)

diff --git a/ecrire/inc/cookie.php b/ecrire/inc/cookie.php
index 20dbdbb138..e6e5b2e3a7 100644
--- a/ecrire/inc/cookie.php
+++ b/ecrire/inc/cookie.php
@@ -103,7 +103,7 @@ function spip_cookie_envoye($set = '') {
  * ils appellent simplement `$_COOKIE['spip_xx']` qui sera forcément
  * la bonne donnée.
  * 
- * @param string $cookie_prefixe
+ * @param string $cookie_prefix
  *     Préfixe des cookies de SPIP
 **/
 function recuperer_cookies_spip($cookie_prefix) {
diff --git a/ecrire/inc/presentation_mini.php b/ecrire/inc/presentation_mini.php
index 3aa5ed424a..28a2eee6c4 100644
--- a/ecrire/inc/presentation_mini.php
+++ b/ecrire/inc/presentation_mini.php
@@ -56,7 +56,7 @@ function fin_grand_cadre(){ return "\n</div>";}
 // div extra lui-meme ferme par debut_droite qui ouvre
 // div contenu lui-meme ferme par fin_gauche() ainsi que
 // div conteneur
-// http://doc.spip.org/@debut_gauche
+
 /**
  * Retourne le code HTML du début de la colonne gauche
  * @return string Code HTML
@@ -207,7 +207,12 @@ function info_maj_spip(){
 	return "$maj<br />";
 }
 
-// http://doc.spip.org/@info_copyright
+/**
+ * Retourne les informations de copyright (version de SPIP, de l'écran de sécurité)
+ * pour le pied de page de l'espace privé
+ *
+ * @return string Code HTML
+**/
 function info_copyright() {
 	global $spip_version_affichee, $spip_lang;
 
@@ -236,7 +241,17 @@ function info_copyright() {
 
 }
 
-// http://doc.spip.org/@formulaire_recherche
+/**
+ * Retourne un formulaire de recherche pour l'espace privé
+ *
+ * Préférez l'usage en squelettes via la balise `#FORMULAIRE_RECHERCHE_ECRIRE`.
+ *
+ * @see formulaires_recherche_ecrire_charger_dist()
+ * 
+ * @param string $page        Nom de la page exec
+ * @param string $complement  Code HTML supplémentaire
+ * @return string             Code HTML
+**/
 function formulaire_recherche($page, $complement=""){
 	$recherche = _request('recherche');
 	$recherche_aff = entites_html($recherche);
diff --git a/prive/formulaires/recherche_ecrire.php b/prive/formulaires/recherche_ecrire.php
index 157e4f91d7..63f95b700f 100644
--- a/prive/formulaires/recherche_ecrire.php
+++ b/prive/formulaires/recherche_ecrire.php
@@ -10,9 +10,26 @@
  *  Pour plus de details voir le fichier COPYING.txt ou l'aide en ligne.   *
 \***************************************************************************/
 
+/**
+ * Gestion du formulaire de recherche pour l'espace privé
+ *
+ * @package SPIP\Core\Formulaires
+**/
+
 if (!defined('_ECRIRE_INC_VERSION')) return;
 
-// chargement des valeurs par defaut des champs du formulaire
+/**
+ * Chargement des valeurs par defaut des champs du formulaire de recherche de l'espace privé
+ *
+ * Le formulaire dirige son action directement sur la page de l'action demandée.
+ * Il n'y a pas de vérification ni de traitement dans ce formulaire.
+ * 
+ * @param string $action
+ *     URL de la page exec qui reçoit la recherche. Par défaut l'URL de l'exec 'recherche'.
+ * @param string $class
+ *     Classe CSS supplémentaire appliquée sur le formulaire
+ * @return array Environnement du formulaire
+**/
 function formulaires_recherche_ecrire_charger_dist($action = '',$class=''){
 	if ($GLOBALS['spip_lang'] != $GLOBALS['meta']['langue_site'])
 		$lang = $GLOBALS['spip_lang'];
-- 
GitLab