Сделайте правильную документацию doxygen требованием к сборке - PullRequest
Новая
       8

Сделайте правильную документацию doxygen требованием к сборке

0 голосов
/ 08 мая 2018

Я использую Doxygen для документирования проекта C ++, который становится все больше и больше, и мне было интересно, как я могу сделать Doxygen требованием к сборке для проекта. Другими словами, я хотел бы, чтобы мой процесс сборки завершился сбоем и остановился, если какой-либо класс / метод / и т. Д. не было успешно задокументировано для Doxygen. Я использую make для строительства.

Например, я бы хотел, чтобы этот сбой (т.е. не сборка): 

/**
 * @bbrief Oops, tag does not exist, warning is issued and hence build fails.
 */
void f()
{
    // Do something...
}


/**
 * @brief Main function for program X
 *
 * @return End of execution status.
 *
 * ...
 *
 */
int main()
{
    f();

    return 0;
}

но это для сборки: 

/**
 * @brief Okay, this is fine.
 *
 */
void f()
{
    // Do something...
}


/**
 * @brief Main function for program X
 *
 * @return End of execution status.
 *
 * ...
 *
 */
int main()
{
    f();

    return 0;
}

Я пытался найти в Интернете такую ​​функцию, но пока ничего не нашел.

1 Ответ

0 голосов
/ 08 мая 2018

В большинстве случаев документация генерируется, но из-за предупреждений она неполная. Я вижу несколько возможностей:

  • Для этой цели присутствует параметр конфигурации WARN_AS_ERROR (см .: http://www.doxygen.nl/manual/config.html#cfg_warn_as_error).. Возможный недостаток заключается в том, что процесс останавливается непосредственно при появлении предупреждения.
  • поймать предупреждения в файле и посчитать их / посмотреть, если файл пусто и на основании этого решите, была ли сборка успешной или нет.
...