Problème lecture code Doxygen

Bonjour,

Je viens d'installer Doxygen et je dois avouer qu'il fonctionne très bien mais voilà je rencontre un petit problème.

Mes page PHP sont composées comme ceci :

Code:

---

1 2 3 4 5 6 7 8 9 10 11 12

switch($task) { .... }   /** * Commentaire */ function maFonction($param1, $param2) { .... }

---

Dans la doc (HTML) générée j'ai le résultat suivant :

Citation:

---

switch ($task) maFonction( $ param1, $ param2 )

---

Auriez vous une idée du pourquoi et surtout comment je peu avoir une documentation plus propre.

Merci par avance

Pour avoir une documentation propre, il vaut mieux être descriptif dans ton code PHP vu que Doxygen ne le supporte par complêtement.

Tu peux t'y prendre comme suit:

Code:

---

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18

/**  * @brief Description brève  *  * Description complête  * sur plusieurs lignes...  *  * @param integer $a Explication du paramètre  * @param string $b Explication du paramètre  * @throws InvalidArgumentException Explication de l'exception (si besoin)  * @return type  */ function ma_fonction ($a,$b) {   if (empty($b)) throw new InvalidArgumentException("Valeur invalide");   // ... }

---

Voici le genre de doc que tu peux produire: http://bdelespierre.github.com/php-axiom/index.html
(Tu trouvera des exemples par ici: https://github.com/bdelespierre/php-...ibraries/axiom)

Merci pour cette réponse mais j'utilise aussi @author, @param et autres.
J'ai juste oublié de la préciser :P
Ce qui me gène c'est le faite que dans la doc j'ai le switch() sur la même ligne que ma fonction :?

c'est vrai que doxygen comprends mal les définitions de structures au coté de blocs de codes...

D'après la FAQ, le meilleur moyen d'y arriver est d'utiliser des commandes conditionnelles:

Code:

---

1 2 3 4 5

//! @cond INGORE   /* ici le code à ignorer */   //! @endcond

---

A voir si ça fonctionne, j'ai pas testé...

Voir: http://www.stack.nl/~dimitri/doxygen/faq.html

Cela fonctionne très bien ^^
Un grand merci à toi.

Par contre je vais être ch... mais il n'y a pas moyen pour que je puisse quand mettre du commentaire pour le switch() et qu'il s'affiche correctement dans la doc ?

Mmmh si éventuellement, mais ça n'a strictement aucun intérêt. L'objet de Doxygen est de générer une documentation des structures et des fonctions d'une application, pas de décrire son fonctionnement interne.

Merci pour ces informations ^^