2010-08-22 8 views
0

J'ai le prototype de fonction suivante:lien Doxygen à la fonction const

bool key_pressed(enum key key) const; 

Je documenté à l'aide doxygen. Maintenant, j'ai une version surchargée de cette fonction qui fait la même chose, donc je voulais copier le commentaire doxygen comme ceci:

/// @copydoc key_pressed(enum key) const 
bool key_pressed(char key) const; 

Cela ne fonctionne pas, je reçois l'avertissement suivant de doxygen:

Warning: target key_pressed(enum key) const of \copydoc command not found 

Si je supprime le const de key_pressed (clé d'enum) et de la ligne @copydoc, cela fonctionne. Ai-je spécifié correctement le modificateur dans ma commande copydoc?

Répondre

2
/// @copydoc key_pressed(enum key) const 

Cela ne devrait-il pas être (enum key key)? Pas que je conseillerais d'utiliser le même nom pour le paramètre d'entrée que le nom enum ...

+0

Cela fait l'affaire! Bizarre, car la documentation de Doxygen indique que les noms de paramètres peuvent être omis pour l'autolinking! À propos de nommer le même - je ne peux pas vraiment trouver des alternatives utiles. Éviter cela est le grand avantage de la notation de chameau IMO. – halifar

Questions connexes