[SPIP][PLUGINS] v3.0-->v3.2

[lhc/web/www.git] / www / plugins-dist / compagnon / formulaires / reinitialiser_compagnon.php

diff --git a/www/plugins-dist/compagnon/formulaires/reinitialiser_compagnon.php b/www/plugins-dist/compagnon/formulaires/reinitialiser_compagnon.php
index b732884..6082374 100644 (file)
--- 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')
        );
 }
-
-?>