2017-08-17 5 views
0

Utilisation de Doxygen pour générer de la documentation. Obtenir des erreurs "Attention: ignorer les balises inconnues", et je ne vois pas pourquoi.Avertissement Doxygen: ignorer la balise inconnue

exemple minimal, complet et Vérifiable:

/** This is a test */ 
#include <iostream> 

/** \fn foo */ 
int foo() { 
    return 0; 
} 

int main() { 
    std::cout << "hello world" << std::endl; 
    return 0; 
} 

Erreurs:

[53]: doxygen .\myTest.cpp 
Warning: ignoring unknown tag `This' at line 1, file .\myTest.cpp 
Warning: ignoring unknown tag `is' at line 1, file .\myTest.cpp 
Warning: ignoring unknown tag `a' at line 1, file .\myTest.cpp 
Warning: ignoring unknown tag `test' at line 1, file .\myTest.cpp 
Warning: ignoring unknown tag `fn' at line 4, file .\myTest.cpp 
Warning: ignoring unknown tag `foo' at line 4, file .\myTest.cpp 
Warning: ignoring unknown tag `int' at line 5, file .\myTest.cpp 
Warning: ignoring unknown tag `foo' at line 5, file .\myTest.cpp 
Warning: ignoring unknown tag `return' at line 6, file .\myTest.cpp 
Warning: ignoring unknown tag `0' at line 6, file .\myTest.cpp 
Warning: ignoring unknown tag `int' at line 9, file .\myTest.cpp 
Warning: ignoring unknown tag `main' at line 9, file .\myTest.cpp 
Warning: ignoring unknown tag `std' at line 10, file .\myTest.cpp 
Warning: ignoring unknown tag `cout' at line 10, file .\myTest.cpp 
Warning: ignoring unknown tag `hello' at line 10, file .\myTest.cpp 
Warning: ignoring unknown tag `world' at line 10, file .\myTest.cpp 
Warning: ignoring unknown tag `std' at line 10, file .\myTest.cpp 
Warning: ignoring unknown tag `endl' at line 10, file .\myTest.cpp 
Warning: ignoring unknown tag `return' at line 11, file .\myTest.cpp 
Warning: ignoring unknown tag `0' at line 11, file .\myTest.cpp 
Searching for include files... 
Searching for example files... 
Searching for images... 
Searching for dot files... 
Searching for files to exclude 
Searching for files to process... 
...other stuff... 

Thx, Cordialement, Keith: ^)

Répondre

2

vous passez votre fichier dans doxygen comme si c'était le fichier de configuration, et pas un cpp. C'est pourquoi il vous donne une erreur sur chaque mot.

Pour générer la documentation que vous pouvez saisir:

doxygen <config-file>

voir https://www.stack.nl/~dimitri/doxygen/manual/starting.html#step2

Au lieu de cela, générer un fichier de configuration à côté de votre source:

doxygen -g myconfig.conf 

Et puis exécutez doxygen :

doxygen myconfig.conf 

qui sera par défaut à la construction de la documentation à partir des fichiers dans votre répertoire courant, en raison du défaut de INPUT =.