Doxygen не будет обрабатывать main.cpp - PullRequest
Новая
       32

Doxygen не будет обрабатывать main.cpp

6 голосов
/ 21 октября 2010

Итак, я новичок в использовании Doxygen, и я смог заставить его работать без сбоев.Я смог документировать свои классы и структуры, и он прекрасно генерирует HTML-файлы.Проблема, с которой я сталкиваюсь, заключается в том, что она не анализирует мой файл main.cpp.Все классы и структуры имеют свои собственные файлы .h и .cpp, и они обрабатываются нормально.Как заставить Doxygen сделать документацию для main.cpp?У него нет файла .h, так как именно здесь начинается и заканчивается программа.Я бы даже не знал, что положить в файл .h для main.Я использую Doxywizard в Windows.

Редактировать:

Я помещаю это в основную, и она генерирует главную страницу: 

/**
@mainpage

This is a test application.

@author Alex
@date 10/21/2010
@version 1.0
*/

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

/**
@brief Error handler for the PDF writer.

It does nothing. It just has to exist.
*/
void error_handler (HPDF_STATUS   error_no,
                    HPDF_STATUS   detail_no,
                    void         *user_data)
{
}

Ответы [ 3 ]

6 голосов
/ 22 октября 2010

Я положил это вверху main.cpp, и это сработало. Пойди разберись. 

/**
@file main.cpp
*/
2 голосов
/ 22 октября 2010

Если INPUT и FILE_PATTERNS пустые, он должен искать файлы * .cpp (и многие другие шаблоны) в текущем каталоге.(Это из руководства doxygen .)

Поскольку у вас пусто, я ожидаю, что одна из двух вещей происходит, если вы не получаете документацию main.cpp:

  1. main.cpp отсутствует в текущем каталоге.Чтобы исключить это, убедитесь, что вы запускаете doxygen из того же каталога, что и и ваш файл конфигурации и main.cpp.
  2. В документации main.cpp есть синтаксическая ошибка.Это может быть сложно обнаружить, так как doxygen обычно не прерывается при обнаружении ошибки - вместо этого он просто пропускает.Если это проблема, то построчно просматривайте вывод doxygen, когда вы генерируете свои документы.

Если ни одна из этих идей не решит вашу проблему, нам может потребоваться дополнительная информация.Вывод ls -R, вывод прогона кислорода и т. Д. Удачи!

1 голос
/ 13 апреля 2011

Я провел некоторые исследования по этому вопросу ... Из руководства по кислороду :

Важно: Документация по глобальным функциям, переменным, typedefs, и перечисления будут включены только в вывод, если файл, в котором они находятся также задокументировано.

Вот, пожалуйста!

...