Как создать отчет Doxygen на основе * .dox и использовать только ссылки из исходного кода - PullRequest
Новая
       14

Как создать отчет Doxygen на основе * .dox и использовать только ссылки из исходного кода

1 голос
/ 06 марта 2020

У нас есть требование настроить генерацию отчета о кислороде только на основе файла .dox. Так что ненужных изменений в файле исходного кода можно избежать, просто обновляя комментарии doxygen. Я надеюсь, что это может быть сделано в соответствии с нашими ожиданиями при генерации отчетов о кислороде. Нам нужна поддержка относительно того же.

На данный момент мы добавили исходные файлы и другие расширения, которые необходимо проанализировать для генерации отчета, в теге FILE_PATTERNS, как показано ниже: 

FILE_PATTERNS          = *.cpp  \
                         *.hpp  \
                         *.c    \
                         *.h    \
                         *.dox

Мы ожидаем, что комментарии doxygen будут полностью проанализированы из файла .dox и будет сгенерирован отчет.

Поведение: Мы наблюдали, что главная страница была из комментариев файла .dox, тогда как ссылки на API, define, variable определяет et c берутся из файлов исходного кода и .dox файлов (т.е. комментарии doxygen из файлов исходного кода). Также иногда это происходит только из исходного кода, а не из .dox. Это проблема конфигурации или какая-то другая? Исходный файл Arithmeti c. c содержит следующий код 

/**
* @brief square of number
* @param[in] value1
* @return int result
* @description square of value
*/
int square(int x)
{
}

входной файл .dox: 

/*! \fn int square(int x)
\brief Square of value
\param value1 for addition
\return square of given value.
*/

, если мы генерируем отчет о кислороде с использованием вышеуказанного исходного кода и. файл dox, тогда отчет doxygen будет содержать описание функции как из исходного файла, так и из файла .dox, но наше требование - взять описание из файла .dox.

...