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

StackOverflow https://stackoverflow.com/questions/3990533

  •  10-10-2019
  •  | 
  •  

Вопрос

Так что я новичок в использовании Doxygen, и я смог заставить его работать гладко. Я смог документировать свои классы и структуры, и он отлично генерирует файлы HTML. Проблема, с которой я сталкиваюсь, заключается в том, что он не будет проанализировать мой файл main.cpp. Все классы и структуры имеют свои собственные файлы .h и .cpp, и они обрабатывают нормальные. Как заставить доксиген сделать документацию для 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)
{
}
Это было полезно?

Решение

Я положил это на вершину main.cpp, и это сработало. Перейти к фигуре.

/**
@file main.cpp
*/

Другие советы

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

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

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

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

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

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

Вот!

Лицензировано под: CC-BY-SA с атрибуция
Не связан с StackOverflow
scroll top