JF Messian
2007-09-07 16:20:49 UTC
Bonjour à tous,
Je suis en train de découvrir Doxygen pour documenter un projet réalisé
en PHP.
Il y a certaines choses qui restent un peu obscures...
Concernant la documentation de fonctions, ça semble ok. Par exemple, si
j'ai le code suivant :
/**
* Fonction permettant de ....
* @param a entier a
* @param b entier b
* @return Une chaine de caractère
*/
function toto () {
}
Doxygen me liste bien la fonction de la façon suivante :
toto
(
)
Fonction permettant de ....
Parameters:
a
entier a
b
entier b
Returns:
Une chaine de caractre
Bon c'est un début... mais je voudrais aussi DOCUMENTER tous les scripts
que j'ai réalisés et là... ça ne fonctionne pas...
Par exemple si j'ai une page avec :
/**
* ce script affiche 'toto''
*/
echo "toto" ;
rien ne se passe...enfin presque rien...
Doxygen reconnaît bien mes commentaires puisqu'il m''affiche comme
source :
00001 <?
00006 echo "toto" ;
00007 ?
Par contre aucun commentaire n'est généré !
J'ai dû loupé quelque chose... mais quoi ?
Toute aide sera la bienvenue !
MERCI...
Je suis en train de découvrir Doxygen pour documenter un projet réalisé
en PHP.
Il y a certaines choses qui restent un peu obscures...
Concernant la documentation de fonctions, ça semble ok. Par exemple, si
j'ai le code suivant :
/**
* Fonction permettant de ....
* @param a entier a
* @param b entier b
* @return Une chaine de caractère
*/
function toto () {
}
Doxygen me liste bien la fonction de la façon suivante :
toto
(
)
Fonction permettant de ....
Parameters:
a
entier a
b
entier b
Returns:
Une chaine de caractre
Bon c'est un début... mais je voudrais aussi DOCUMENTER tous les scripts
que j'ai réalisés et là... ça ne fonctionne pas...
Par exemple si j'ai une page avec :
/**
* ce script affiche 'toto''
*/
echo "toto" ;
rien ne se passe...enfin presque rien...
Doxygen reconnaît bien mes commentaires puisqu'il m''affiche comme
source :
00001 <?
00006 echo "toto" ;
00007 ?
Par contre aucun commentaire n'est généré !
J'ai dû loupé quelque chose... mais quoi ?
Toute aide sera la bienvenue !
MERCI...
--
Un moyen de garde pour vos enfants ?
http://www.easynounou.com
Un moyen de garde pour vos enfants ?
http://www.easynounou.com