Documentation des paramètres de la fonction doxygen (//! & lt; vs @param)

Si j'utilise "après le" membre de la documentation pour les paramètres de la fonction, par exemple, l'utilisation //!< après chaque paramètre, au lieu de @param dans l'en-tête, la section "Paramètres" est toujours placé après le "Retour" dans le fichier de sortie généré.

Est possible de définir l'ordre de sorte que "Paramètres" sera placé avant le "Retour"?

/**
 *****************************************************************************************
 *  @brief      Test API
 *
 *  @usage      This API can be called at any time
 *
 *  @return     0 if successful; or 1 if failed
 ****************************************************************************************/

int TestAPI(
    int argument1,       //!< first argument
    int argument2        //!< second argument
    );

source d'informationauteur user313031

  1. 16

    J'ai juste essayé votre code avec Doxygen 1.7.5.1, et confirmé qu'avec votre code, la liste des paramètres de la sortie vient après la description du Retour.

    C'est une honte, comme le //!< style est beaucoup plus agréable que d'avoir à les re-citer les noms de tous les paramètres avec @param:

    /**
 *****************************************************************************************
 *  @brief      Test API
 *
 *  @usage      This API can be called at any time
 * 
 *  @param      argument1 first argument
 *  @param      argument2 second argument
 *
 *  @return     0 if successful; or 1 if failed
 ****************************************************************************************/

int TestAPI2(
    int argument1,
    int argument2
    );

    J'ai eu un coup d'oeil dans le Doxygen base de données de bogues Bugzillapour voir si elle était un phénomène relativement récent bug (comme, alors vous pourriez essayer de revenir à une ancienne installation).

    Je crois que vous avez trouvé Doxygen Bug 316311: paramètre de la documentation après le retour de la documentation en utilisant les commentaires en ligne", qui a été signalé en septembre 2005, et n'a pas été fixée.

    Donc, malheureusement, je crains que la réponse à votre question Est possible de définir l'ordre de sorte que "Paramètres" sera placé avant le "Retour"? est presque certainement Pas.

    Modifier

    Je viens d'ajouter une note à Doxygen Bug 316311en demandant qu'il soit changé de Statut=CONFIRMÉE.