J'ai Comment puis-je garder Doxygen de mettre ces une question quelque peu liée sur Doxygen et mettre "quelque_conset" et "une explication" mais pas "1234" dans la sortie? #define des valeurs dans les en-têtes que je souhaite certainement Doxygen à documenter, mais j'ai d'autres personnes dans #define s dans la documentation qu'elle crée? J'ai essayé de le marquer avec @Internal mais cela ne semblait pas aider. #define , Comment puis-je obtenir:
7 Réponses :
Vous pouvez exclure toute partie du code de DOXYGEN analyse avec edit: Certaines questions connexes:
\ COND ... \ endcond Tags.
Je suppose que cela aborde le numéro de fichier #define in .c (je peux entourer ces lignes avec contrôle conditionnel). Cela semble bruyant et non naturel, cependant. Et n'est pas du tout d'adresse cacher des valeurs pour # définir les constantes. (Peut-être que je n'aurais pas dû demander à une question complexe, mais j'espérais qu'il y avait des éléments spécifiques spécifiques à la définition qui pourraient résoudre les deux problèmes.)
Je ne sais pas comment révéler une constante de définition sans révéler sa valeur.
J'ai Cond / Endcond Travailler, mais j'aimerais vraiment savoir pourquoi interne n'a pas fonctionné. Mon Doxygen Fu est définitivement faible. :-(
Malheureusement, je partage votre malentendu de @Internal. De nombreux aspects de Doxygen sont toujours obscurs pour moi. La courbe d'apprentissage est lente mais valable.
Cela semblera toujours toujours bruyant et non naturel, mais pour répondre à votre autre question, essayez:
/** An explanation */ #define SOME_CONSTANT /** @cond */ 1234 /** @endcond */
Vous pouvez définir max_initializer_lines = 0 dans votre fichier doxyfile pour masquer les valeurs de vos définies.
Il n'est pas nécessaire d'utiliser le concernant la première question, vous pouvez définir \ COND et \ endcond . Vous pouvez masquer l'initialiseur en utilisant simplement la commande \ hideinitializer : hide_undoc_member = oui et Seules les macros ayant un bloc de documentation Doxygen seront affichées dans la sortie.
Vous voulez seulement documenter ce qui est déclaré dans les fichiers Ce que j'aime faire dans ce cas, et je crois que Doxygen était plus conçu pour être utilisé de cette façon est:
Cela indiquera uniquement ce qui est contenu dans vos fichiers .h . Je suppose que vous déclarez toutes les fonctions statiques et variables comme statique dans vos fichiers .c . Tous les restants sont déclarés dans .h Les fichiers correspondants également. Ce sont vos membres "public".
DOXYFILE , définissez extray_all = No et ajoutez le répertoire dans lequel vos fichiers .h doivent entrée
/ ** \ Fichier * / à tous vos fichiers .h (mais pas vos fichiers .c ).
.h . Vous pouvez toujours ajouter le répertoire contenant votre fichier .c sur entrée à votre doxyfile , et ils seront numérisés pour une documentation supplémentaire pour votre "public "Membres ...
J'ai résolu ce problème en déplaçant ma documentation du fichier .C au fichier .h. Puis exécutez Doxygen uniquement sur le fichier .h.
Ensuite, les éléments que je veux documenter (les éléments «public») sont intrinsèquement ce que Doxygen prend en charge.
Parce que j'ai déjà été prudent de mettre des éléments «public» dans le fichier .h et les éléments «privés» dans le fichier .c que cela fonctionne très bien.
Cette technique est venue à l'esprit quand j'ai remarqué que Doxygen tirait dans la notice. Il m'a frappé que si je devais également déplacer le sous-ensemble d'inclure que le module appelant devait utiliser mon module, cette liste serait également documentée.
Cette technique a un avantage supplémentaire: je peux mettre la documentation dans une fenêtre de terminal et la source dans une fenêtre de terminal différente lors de la mise à jour de la documentation.
Parfois, vous avez peut-être une définition que vous souhaitez documenter, mais que vous voulez que Doxygen le traite différemment (ou même l'ignorer complètement pour éviter d'analyser les erreurs). Pour cela, vous pouvez définir le #define dans Doxygen différemment de votre code source.
Exemple:
Certains compilateurs permettent une liaison variable à des segments spécifiques, c'est-à-dire.: P> => doxygen analyse la pièce "segment_myvar_in_memory" comme nom de variable qui n'est pas souhaité.
Nous pourrions utiliser une définition pour cela: P> #define __link_to_segment(name)