X-Git-Url: http://git.heureux-cyclage.org/?a=blobdiff_plain;f=www%2Fplugins-dist%2Fcompagnon%2Fformulaires%2Freinitialiser_compagnon.php;h=6082374a2ffb14940c60da921b1db7a14fca02ed;hb=4f443dce95ff6f8221c189880a70c74ce1c1f238;hp=b732884f3cb577a44e4866bdd685c369fc54da0e;hpb=4a628e9b277d3617535f99d663ca79fa2e891177;p=lhc%2Fweb%2Fwww.git

diff --git a/www/plugins-dist/compagnon/formulaires/reinitialiser_compagnon.php b/www/plugins-dist/compagnon/formulaires/reinitialiser_compagnon.php
index b732884f..6082374a 100644
--- a/www/plugins-dist/compagnon/formulaires/reinitialiser_compagnon.php
+++ b/www/plugins-dist/compagnon/formulaires/reinitialiser_compagnon.php
@@ -1,11 +1,35 @@
 <?php
+/**
+ * Gestion du formulaire de réinitialisation des messages de compagnon
+ * validés (vus) par des auteurs.
+ *
+ * Ce formulaire permet d'effacer pour soi ou pour tous les auteurs
+ * les messages qu'on a déjà vus. Du coup, ils seront de nouveaux
+ * affichés sur les différentes pages.
+ *
+ * @package SPIP\Compagnon\Formulaires
+ **/
 
-if (!defined('_ECRIRE_INC_VERSION')) return;
+if (!defined('_ECRIRE_INC_VERSION')) {
+	return;
+}
 
+/**
+ * Chargement du formulaire de réinitialisation des messages du compagnon
+ *
+ * @return array
+ *     Environnement du formulaire
+ **/
 function formulaires_reinitialiser_compagnon_charger() {
 	return array('qui' => 'moi');
 }
 
+/**
+ * Traitement du formulaire de réinitialisation des messages du compagnon
+ *
+ * @return array
+ *     Retours du traitement
+ **/
 function formulaires_reinitialiser_compagnon_traiter() {
 	$qui = _request('qui');
 	include_spip('inc/config');
@@ -17,10 +41,8 @@ function formulaires_reinitialiser_compagnon_traiter() {
 		effacer_config('compagnon');
 		ecrire_config('compagnon/config', $config);
 	}
-	
+
 	return array(
 		'message_ok' => _T('compagnon:reinitialisation_ok')
 	);
 }
-
-?>