documenter des fichiers txt dans Doxygen

Question

J'utilise Doxygen pour documenter un projet Python. L'application utilise de petits fichiers txt, contenant par ex. informations de config, journaux etc. Pour des raisons évidentes, aucune information Doxygen ne peut être incluse directement dans ces fichiers (problèmes d'analyse, ces fichiers peuvent ne pas exister) - J'ai besoin d'écrire ce document dans d'autres fichiers (contenant du code).

Le problème est que je ne peux pas Dox 2 fichiers dans un seul fichier de code (ou tout au moins - std doxyconf ne permet pas - pas doc pour que les fichiers mineurs ou inexistants est généré)

-vous savoir, comment le surmonter? Quel réglage spécifique dans conf devrait être fait? Ou devrais-je plutôt créer un fichier .py (même répertoire que le fichier en question) qui ne contiendrait que des commentaires (documentation)?

Merci d'avance.

Modifier. Ok, essayez de le rendre plus clair. Dire que je suis mon code dans les fichiers suivants:

(...)/project/functions.py 
(...)/project/interface.py 
(...)/project/data/js/functions.js 

si en cours d'exécution, l'application génère des répertoires:

(...)/project/data/gallery/gallery1 
(...)/project/data/gallery/gallery2 
(...)/project/data/gallery/gallery3 

à gallery1, nous avons 3 et jpgs 3xmls, en gallery2 - 1 jpg, gallery3- 5xJPG & 5xXML. Tout cela - téléchargé par l'utilisateur. Comme galeries 1, 2 & 3 ont un peu différent usage, après avoir créé ces dirs, nous créons également un fichier:

(...)/project/data/gallery/types.info 

Ce fichier contient des informations au format:

gallery1#galleryType1 
gallery2#galleryType2 
gallery3#galleryType1 

Remarque. Si l'application est inactive (l'utilisateur ne fait rien), il n'y a pas de galeries et pas de fichier types.info ... Maintenant, je veux créer une entrée doxygen à propos de ces pauvres types.info, afin qu'elles soient visibles dans onglet des fichiers. Le @verbinclude ne fonctionne pas :( J'ai ajouté tag @package, et ce pourrait être une solution de contournement, mais ce serait vraiment bien si j'avais ce fichier documenté dans l'onglet Fichiers de la page doc ... Plus clair? :)

Answer 1

vous pourriez être en mesure d'y arriver avec l'attribut @file dans un bloc de documentation, quelque chose comme:

/** 
* @file project/data/gallery/types.info 
* Documentation for types.info in project/data/gallery/. 
*/ 

pour que cela fonctionne, vous aurez également besoin d'ajouter types.info comme entrée doxygen valide nom du fichier (vérifiez les attributs INPUT et FILE_PATTERNS de configuration doxygen l'incluera), et le fichier Il doit exister (mais il peut être vide).

La principale mise en garde que j'ai trouvé avec cette approche est qu'il ne semble pas fonctionner avec style python commentaires doxygen:

## @file project/data/gallery/types.info 
# Documentation for types.info in project/data/gallery/. 

Vous aurez besoin d'avoir le fichier source qui peut contenir des commentaires de style C/C++ , et ce fichier apparaîtra également sous l'onglet des fichiers.