Documenter préprocesseur dans Doxygen

Est-il possible de document préprocesseur dans Doxygen? Je m'attendais à être en mesure de faire exactement comme une variable ou une fonction, cependant la Doxygen sortie semble avoir "perdu" la documentation pour la définir, et ne contient pas de le définir elle-même.

J'ai essayé les

/**My Preprocessor Macro.*/
#define TEST_DEFINE(x) (x*x)

et

/**@def TEST_DEFINE

   My Preprocessor Macro.
*/
#define TEST_DEFINE(x) (x*x)

J'ai aussi essayé de les mettre à l'intérieur d'un groupe (essayé defgroup, addtogroup et de l'endogroupe), et non simplement à la "portée" mais qui n'avait aucun effet, soit (même si d'autres éléments dans le groupe ont été documentés comme prévu).

J'ai regardé à travers les différents Doxygen options, mais ne pouvait pas voir tout ce qui pourrait permettre (ou prévenir) la documentation de définit.

InformationsquelleAutor Fire Lancer | 2010-03-01
  1. 31

    Oui, c'est possible. Le La documentation Doxygen dit:

    Pour documenter des objets globaux (fonctions, les typedefs, enum, macros, etc),
    vous devez documenter le fichier dans lequel elles sont définies. En d'autres termes,
    il faut au moins un

    /*! \file */

    ou un

    /** @file */

    ligne dans ce fichier.

    Vous pouvez utiliser @defgroup, @addtogroup, et @ingroup de mettre relative des éléments dans le même module, même si elles apparaissent dans des fichiers distincts (voir la documentation ici pour plus de détails). Voici un exemple minimal qui fonctionne pour moi (Doxygen 1.6.3):

    Doxyfile:

    # Empty file.

    Test.h:

    /** @file */

/**My Preprocessor Macro.*/ 
#define TEST_DEFINE(x) (x*x) 

/**
 * @defgroup TEST_GROUP Test Group
 *
 * @{
 */

/** Test AAA documentation. */
#define TEST_AAA (1)
/** Test BBB documentation. */
#define TEST_BBB (2)
/** Test CCC documentation. */
#define TEST_CCC (3)
/** @} */

    Foo.h:

    /** @file */

/**
 * @addtogroup TEST_GROUP
 *
 * @{
 */

/** @brief My Class. */     
class Foo {
    public:
        void method();
};

/** @} */

    Bar.h:

    /** @file */

/**
 * @ingroup TEST_GROUP
 * My Function.
 */
void Bar();

    Dans ce cas, le TEST_DEFINE documentation apparaît dans la Test.h entrée dans la Fichiers dans l'onglet HTML de la sortie et de la TEST_AAA etc. définitions apparaissent sous Groupe de Test dans le Modules onglet avec classe Foo et de la fonction Bar.

    Une chose à noter est que si vous mettez le nom du fichier après le @file de commande, e.g:

    /** @file Test.h */

    alors ce doit correspondre au nom du fichier. Si ce n'est pas, de la documentation pour les éléments dans le dossier ne sera pas généré.

    Une solution alternative, si vous ne voulez pas ajouter de @file commandes, est de EXTRACT_ALL = YES dans votre Doxyfile.

    J'espère que cela aide!

    • Est-ce à dire il n'y a aucun moyen de les mettre dans un groupe/module? C'est ce que j'essaye vraiment de le faire de sorte qu'ils sont avec les fonctions / classes / etc ils sont liés à (y, répartis sur plusieurs fichiers).
    • Salut Incendie Lancer, j'ai ajouté quelques détails sur le groupement de ma réponse
    • Ok, je l'ai eu à travailler dans un addtogroup ou defgroup bloc. l'endogroupe semble perdre le définir quelque part (defgroup est dans une .rpc avec le groupe principal docs, et tout, sauf le définit dans l'en-tête est de se mettre dans le groupe amende)...je suppose que doit être une sorte de bug sur Doxygens partie?
    • Curieux. J'ai essayé le programme d'installation vous décrivez et il fonctionne bien pour moi. Sans voir ton code c'est difficile de savoir quoi penser.
    InformationsquelleAutor ChrisN
  2. 4

    Dans mon "C" des fichiers, j'utilise un format de commentaire et #define ligne comme ceci:

    /** @brief Number of milli-seconds to wait*/
#define kTimeoutMSec (2)

    Mes documents html ne finissent contenant de la documentation-je préciser. (Je dois @fichier au début du fichier et EXTRACT_ALL=OUI)

    InformationsquelleAutor Jim Chargin
  3. 3

    Essayez de définir EXTRACT_ALL option, je l'ai mis dans mon projet et il permet de générer la documentation pour #définit. Il pourrait y avoir une façon plus élégante de le faire sans l'aide de EXTRACT_ALL alors assurez-vous de vérifier les documents

    http://www.doxygen.nl/config.html#cfg_extract_all

    InformationsquelleAutor Sam Post
  4. 2

    Ajoutant à la réponse à la question précédente, il est également nécessaire d'avoir ENABLE_PREPROCESSING=YES sur le Doxyfile.

    InformationsquelleAutor AmiguelS