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

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

diff --git a/www/plugins-dist/compagnon/compagnon_fonctions.php b/www/plugins-dist/compagnon/compagnon_fonctions.php
index 5b38de1..066db83 100644 (file)
--- a/www/plugins-dist/compagnon/compagnon_fonctions.php
+++ b/www/plugins-dist/compagnon/compagnon_fonctions.php
@@ -1,17 +1,26 @@
 <?php
 
-if (!defined('_ECRIRE_INC_VERSION')) return;
+/**
+ * Fonctions pour les squelettes
+ *
+ * @package SPIP\Compagnon\Fonctions
+ **/
+
+if (!defined('_ECRIRE_INC_VERSION')) {
+       return;
+}
 
 
 /**
- * Retourne un court texte de comprehension
- * aleatoirement parmi une liste.
+ * Retourne un court texte de compréhension
+ * aléatoirement parmi une liste.
  *
- * [(#VAL|ok_aleatoire)]
- * 
+ * @example
+ *     [(#VAL|ok_aleatoire)]
  *
- * @return string Texte.
-**/
+ * @return string
+ *     Le texte traduit.
+ **/
 function filtre_ok_aleatoire_dist() {
        $alea = array(
                'compagnon:ok',
@@ -20,7 +29,6 @@ function filtre_ok_aleatoire_dist() {
                'compagnon:ok_merci',
                'compagnon:ok_parfait',
        );
-       
+
        return _T($alea[array_rand($alea)]);
 }
-?>