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

[lhc/web/www.git] / www / ecrire / iterateur / pour.php

diff --git a/www/ecrire/iterateur/pour.php b/www/ecrire/iterateur/pour.php
index 98ce715..a528046 100644 (file)
--- a/www/ecrire/iterateur/pour.php
+++ b/www/ecrire/iterateur/pour.php
@@ -3,23 +3,37 @@
 /***************************************************************************\
  *  SPIP, Systeme de publication pour l'internet                           *
  *                                                                         *
- *  Copyright (c) 2001-2016                                                *
+ *  Copyright (c) 2001-2017                                                *
  *  Arnaud Martin, Antoine Pitrou, Philippe Riviere, Emmanuel Saint-James  *
  *                                                                         *
  *  Ce programme est un logiciel libre distribue sous licence GNU/GPL.     *
  *  Pour plus de details voir le fichier COPYING.txt ou l'aide en ligne.   *
 \***************************************************************************/
 
+/**
+ * Gestion de l'itérateur POUR
+ *
+ * @package SPIP\Core\Iterateur\POUR
+ **/
 
-if (!defined('_ECRIRE_INC_VERSION')) return;
+if (!defined('_ECRIRE_INC_VERSION')) {
+       return;
+}
 
 include_spip('iterateur/data');
 
 
-//
-// creer une boucle sur un iterateur POUR
-// annonce au compilo les "champs" disponibles
-//
+/**
+ * Créer une boucle sur un itérateur POUR
+ *
+ * Annonce au compilateur les "champs" disponibles,
+ * c'est à dire 'cle' et 'valeur'.
+ *
+ * @param Boucle $b
+ *     Description de la boucle
+ * @return Boucle
+ *     Description de la boucle complétée des champs
+ */
 function iterateur_POUR_dist($b) {
        $b->iterateur = 'DATA'; # designe la classe d'iterateur
        $b->show = array(
@@ -28,6 +42,6 @@ function iterateur_POUR_dist($b) {
                        'valeur' => 'STRING',
                )
        );
+
        return $b;
 }
-