Ma question est liée à la façon de commenter Typedef dans la classe de modèles avec Doxygen. Je vais donner un exemple pour illustrer ma question: Après avoir utilisé Doxygen pour traiter les codes ci-dessus, je peux obtenir une page HTML pour afficher la définition de la base de classe. Toutefois, pour la coordonnée de la classe Typedef, elle n'apparaîtra pas dans la même page avec la base. En fait, tous les types TYPEDEF sont répertoriés dans la page d'espace de noms fondamentales avec toutes les classes de cet espace de noms. Je me demandais s'il est possible de montrer une classe de coordonnées dans la page HTML de base. Ce faisant, le lien entre la base et la coordonnée deviendra beaucoup plus proche. Merci!
6 Réponses :
dans le manuel J'ai lu les éléments suivants:
Répétez cela, car il est souvent négligé: documenter les objets globaux (fonctions, Typefs, Enum, macros, etc.), vous devez documenter le fichier dans lequel ils sont définis. En d'autres termes, il doit au moins être un
/ *! \ fichier * / ou un
/ ** @file * / ligne dans ce fichier.
Vous pouvez également utiliser / SA Commande Pour placer manuellement une référence dans la page de la base '
Les autres réponses fonctionneront, mais si votre Définition d'un fichier Typedef est si étroitement attaché à la classe de la base que vous souhaitez apparaître dans la même page DOXYGEN, vous pouvez vouloir Pour envisager de définir un nouvel espace de noms (dans fondamental ) qui n'inclut pas base et votre Typedef. puis, DOXYGEN générera une page pour cet espace de noms qui inclura la base et votre typedef.
Documentation fera la même chose, mais cela peut être une disposition plus logique pour votre code.
Le typeDEF fait partie d'un espace de noms, vous devez donc documenter l'espace de noms pour qu'il apparaisse, c'est-à-dire: Vous pouvez utiliser Vous pouvez modifier ce titre en par exemple Membres associés En créant un fichier de mise en page à l'aide de @ concerne mais cela mettra l'élément sous fonctions associées de la classe de base: DOXYGEN -L , puis modifiant les deux occurrences de l'élément associé associé dans l'élément généré doxygenlayout. XML comme suit:
Il y a deux autres solutions à ce problème. Vous pouvez définir des groupes à l'aide de mots-clés @defgroup et regroupez la classe et et le type Typedef dans un module. L'autre solution utilise @Relates