Changeset 75315 in spip-zone


Ignore:
Timestamp:
Sep 8, 2013, 6:10:55 PM (6 years ago)
Author:
eric@…
Message:

Correction du PHPDoc de la balise.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • _plugins_/boussole/trunk/boussole_fonctions.php

    r75313 r75315  
    99
    1010
    11 /**
    12  * Balise retournant les informations sur une boussole.
     11// ----------------------- Balises propres à Boussole ---------------------------------
     12
     13/**
     14 * Compilation de la balise `#BOUSSOLE_INFOS` retournant les informations générales sur une
     15 * boussole.
    1316 *
    1417 * La balise #BOUSSOLE_INFOS renvoie :
    1518 *
    16  * - le tableau des infos contenues dans la meta boussole_infos_alias si l'alias est fourni,
    17  * - la liste de tous les tableaux d'infos des meta boussole_infos_xxxx sinon.
     19 * - le tableau des infos contenues dans la meta boussole_infos_xxx si l'alias "xxx" est fourni,
     20 * - la liste de tous les tableaux d'infos des meta boussole_infos_* sinon.
    1821 *
    1922 * @balise
    2023 * @uses calcul_boussole_infos()
    2124 *
    22  * @param string $p
    23  *              alias de la boussole ou vide
    24  * @return array
    25  *              tableau des informations demandees (une boussole ou toutes les boussoles)
     25 * @example
     26 *              #BOUSSOLE_INFOS{spip}|table_valeur{logo} renvoie l'url du logo de la boussole "spip"
     27 *
     28 * @param champ $p
     29 *              Pile transmise en entrée à la balise
     30 * @return champ
     31 *              Pile fournie en entrée et complétée par le code à générer
    2632 */
    2733function balise_BOUSSOLE_INFOS($p) {
     
    4551 *
    4652 * @return array
     53 *              Tableau de la ou des boussoles installées.
    4754 *              Si l'alias de la boussole est erroné, la fonction retourne un tableau vide
    4855 */
     
    7582
    7683
    77 // ----------------------- Filtres propres a Boussole ---------------------------------
     84// ----------------------- Filtres propres à Boussole ---------------------------------
    7885
    7986/**
Note: See TracChangeset for help on using the changeset viewer.