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

[lhc/web/www.git] / www / plugins-dist / mots / puce_statut / mot.php

diff --git a/www/plugins-dist/mots/puce_statut/mot.php b/www/plugins-dist/mots/puce_statut/mot.php
index a39b42c..d323e5d 100644 (file)
--- a/www/plugins-dist/mots/puce_statut/mot.php
+++ b/www/plugins-dist/mots/puce_statut/mot.php
@@ -10,21 +10,37 @@
  *  Pour plus de details voir le fichier COPYING.txt ou l'aide en ligne.   *
 \***************************************************************************/
 
-if (!defined('_ECRIRE_INC_VERSION')) return;
+/**
+ * Puces d'actions rapides sur les mots clés
+ *
+ * @package SPIP\Mots\PucesStatut
+ **/
+
+if (!defined('_ECRIRE_INC_VERSION')) {
+       return;
+}
 
 
 /**
  * Afficher la puce statut d'un mot :
- * en fait juste une icone independante du statut
+ * en fait juste une icone indépendante du statut
  *
  * @param int $id
+ *     Identifiant du mot clé
  * @param string $statut
- * @param int $id_rubrique
+ *     Statut du mot (il n'en a pas)
+ * @param int $id_groupe
+ *     Identifiant du groupe de mot clé parent
  * @param string $type
+ *     Type d'objet
  * @param string $ajax
+ *     Indique s'il ne faut renvoyer que le coeur du menu car on est
+ *     dans une requete ajax suite à un post de changement rapide
+ * @param bool $menu_rapide
+ *     Indique si l'on peut changer le statut, ou si on l'affiche simplement
  * @return string
+ *     Code HTML de l'image de puce de statut à insérer
  */
-// https://code.spip.net/@puce_statut_mot_dist
-function puce_statut_mot_dist($id, $statut, $id_groupe, $type, $ajax='', $menu_rapide=_ACTIVER_PUCE_RAPIDE) {
-       return "<img src='" . chemin_image("mot-16.png") . "' width='16' height='16' alt=''  />";
+function puce_statut_mot_dist($id, $statut, $id_groupe, $type, $ajax = '', $menu_rapide = _ACTIVER_PUCE_RAPIDE) {
+       return "<img src='" . chemin_image('mot-16.png') . "' width='16' height='16' alt=''  />";
 }