[doxygen] bloc \fn ignoré

Version imprimable

1 pièce(s) jointe(s)

Bonjour,

J'utilise doxygen depuis quelques années et j'ai toujours eu en sortie ce que j'attends. Malheureusement cette fois j'ai un problème.
Je n'arrive pas à retrouver dans l'HTML produit les commentaires que j'ai placé dans le code.

Par exemple dans mon .c j'ai placé :
Code:

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 /*! * \fn LOGS_Core_CreatePbSC * \brief TBD * * \param *allocator[in,out] TBD * \param *ack TBD * \param *lslogs TBD * \param *entryevent TBD * \param *getlogstatusvaluesresp TBD * \param *logentrylst TBD * \param *logentry TBD * * \return YBLogMsgSC * TBD * * \callergraph * \callgraph * */
dans mon html j'obtiens :
Pièce jointe 186554

Je ne trouve plus trace de mes informations (TBD, YBLogMsgSC, etc ...)

J'utilise sans soucis cet outil depuis des années mais de façon simple (config quasiment par défaut). Je ne suis pas un expert.

J'ai aussi essayé de mettre le bloc de commentaire doxygen avec des @, puis dans le .h, puis dans les 2. Toujours avec le même échec.

Bref je patoge !

Votre aide m'aidera à ne pas me noyer complètement.

Merci,

Cordialement

31/08/2015, 12h50
10_GOTO_10

Citation:

\fn (function declaration)
Indicates that a comment block contains documentation for a function (either global or as a member of a class). This command is only needed if a comment block is not placed in front (or behind) the function declaration or definition.
If your comment block is in front of the function declaration or definition this command can (and to avoid redundancy should) be omitted.

A full function declaration including arguments should be specified after the \fn command on a single line, since the argument ends at the end of the line!

Il manque peut-être les arguments de la fonction ?
31/08/2015, 13h22
sybe30

Gagné.

C’était bien cela.

Le type de retour ne semble pas utile mais mes arguments oui.
Effectivement comme je trouvais la syntaxe :

Code:

* @fn LOGS_Core_ValueSet(tLOGS_value* value, eGLOB_DataType type_61850, eLOG_GenType type_gen, ST_UCHAR *buf)

J'avais voulu éclaircir tout ça en supprimant les arguments (sachant qu'ils sont trois lignes en dessous) comme cela :

Code:

@fn LOGS_Core_ValueSet

Et bien dommage pour moi c’était une mauvaise idée.

Merci.

Très cordialement