Подтвердить что ты не робот

Документация параметров функции doxygen (//! <vs @param)

Если я использую документацию "после элемента" для параметров функции, например, используйте //!< после каждого параметра вместо @param в заголовке, раздел "Параметры" всегда помещается после "Возврат" в сгенерированном выходной файл.

Можно ли определить порядок, чтобы "Параметры" были помещены перед "Возврат"?

/**
 *****************************************************************************************
 *  @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
    );

Ответ 1

Я только что попробовал свой код с Doxygen 1.7.5.1 и подтвердил, что с вашим кодом список параметров на выходе появляется после описания Return.

Это позор, так как стиль //!< намного приятнее, чем переопределять имена всех параметров с помощью @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
    );

Я просмотрел базу данных ошибок Doxygen Bugzilla, чтобы узнать, была ли она относительно недавней ошибкой (так как тогда вы можете попробовать вернуться к более старой установке).

Я считаю, что вы нашли Doxygen Bug 316311: "Документация по параметрам после обратной документации с использованием встроенных комментариев", о которой сообщалось в сентябре 2005 года, и не имеет были исправлены.

Итак, к сожалению, я боюсь, что ответ на ваш вопрос можно определить порядок, чтобы "Параметры" были помещены перед "Возвращением"? почти наверняка нет.

Edit

Я только что добавил примечание к Doxygen Bug 316311, попросив его изменить на Status = CONFIRMED.