Changeset 75128 in spip-zone

Timestamp:

Aug 30, 2013, 4:24:41 PM (8 years ago)

Author:

eric@…

Message:

Encore un peu de nettoyage PHPDoc

Location:

_plugins_/boussole/trunk

Files:

• boussole_pipelines.php (modified) (1 diff)
• inc/informer_plugin.php (modified) (1 diff)
• inc/serveur.php (modified) (10 diffs)
• inc/simplexml_to_array.php (modified) (1 diff)

_plugins_/boussole/trunk/boussole_pipelines.php

@@ -9 +9 @@
  *
  * @param object $flux
- * @return $flux
+ * @return object
  */
 function boussole_affiche_milieu($flux){

_plugins_/boussole/trunk/inc/informer_plugin.php

@@ -9 +9 @@
  * de lire les informations à jour
  *
- * @package     BOUSSOLE\Outils
+ * @package     SPIP\BOUSSOLE\Outils
  *
  * @param $prefixe

_plugins_/boussole/trunk/inc/serveur.php

@@ -4 +4 @@
 
 if (!defined('_BOUSSOLE_PATTERN_SHA'))
+        /** Pattern pour insérer le sha du XML calculé à posteriori dans le cache */
         define('_BOUSSOLE_PATTERN_SHA', '%sha_contenu%');
 
@@ -11 +12 @@
  * de ces boussoles.
  *
- * @package BOUSSOLE\Serveur
+ * @package BOUSSOLE\Serveur\Cache
  * @api
  *
@@ -51 +52 @@
  * Ce cache est renvoyé sur l'action serveur_informer_boussole
  *
- * @package     BOUSSOLE\Serveur
+ * @package     SPIP\BOUSSOLE\Serveur\Cache
  * @api
  *
@@ -97 +98 @@
  * Ce cache est renvoyé sur l'action serveur_lister_boussoles
  *
- * @package     BOUSSOLE\Serveur
+ * @package     SPIP\BOUSSOLE\Serveur\Cache
  * @api
  *
@@ -162 +163 @@
  * Teste la validite du fichier xml de la boussole en fonction de la DTD boussole.dtd
  *
- * @package     BOUSSOLE\Serveur
+ * @package     SPIP\BOUSSOLE\Outils\XML
  * @api
  *
  * @param string $url
+ *              url absolue du fichier xml de description de la boussole
  * @param array &$erreur
+ *              tableau des erreurs collectees suite a la validation xml
  *
  * @return boolean
  */
-
-// $url => url absolue du fichier xml de description de la boussole
-// $erreur      => tableau des erreurs collectees suite a la validation xml
 function boussole_valider_xml($url, &$erreur) {
         include_spip('inc/distant');
@@ -197 +197 @@
  * Lecture du xml non traduit (donc issu d'un plugin) et génération du xml traduit et incluant les logos
 
- * @package     BOUSSOLE\Serveur
+ * @package     SPIP\BOUSSOLE\Serveur\Cache
  *
  * @param string        $fichier_xml
@@ -290 +290 @@
  * Lecture du xml traduit (donc non issu d'un plugin) et génération du xml complet incluant les logos
  *
- * @package     BOUSSOLE\Serveur
+ * @package     SPIP\BOUSSOLE\Serveur\Cache
  *
  * @param string        $fichier_xml
@@ -424 +424 @@
  * Insertion d'un balise ouvrante, fermante ou vide
  *
- * @package     BOUSSOLE\Outils
+ * @package     SPIP\BOUSSOLE\Outils\XML
  *
  * @param string        $type
@@ -455 +455 @@
  * Insertion d'une balise complète <nom>, <slogan> ou <description> incluant les traductions en <multi>
  *
- * @package     BOUSSOLE\Outils
+ * @package     SPIP\BOUSSOLE\Outils\XML
  *
  * @param string        $alias
@@ -523 +523 @@
  * Contruction de la chaine de tabulations correspondant au décalage souhaité
  *
- * @package     BOUSSOLE\Outils
+ * @package     SPIP\BOUSSOLE\Outils\XML
  *
  * @param int   $decalage

_plugins_/boussole/trunk/inc/simplexml_to_array.php

@@ -7 +7 @@
  * Transforme un texte XML en tableau PHP
  *
- * @package BOUSSOLE\Outils
+ * @package SPIP\BOUSSOLE\Outils\XML
  *
  * @param string|object $u