Doxygen nicht verarbeiten main.cpp

Question

So ich mit Doxygen bin neu und ich war in der Lage, es zu bekommen reibungslos zu funktionieren. Ich konnte meine Klassen und Strukturen dokumentieren und erzeugt die HTML-Dateien perfekt. Das Problem, das ich in renne ist es nicht meine main.cpp-Datei analysieren. Alle Klassen und Strukturen haben ihre eigenen .h und CPP-Dateien und sie verarbeiten in Ordnung. Wie erhalte ich Doxygen in der Dokumentation zu main.cpp machen? Es verfügt nicht über eine .h-Datei, wie das ist, wo das Programm beginnt und endet. Ich würde nicht einmal wissen, was für die wichtigsten in der H-Datei zu setzen. Ich verwende doxywizard in Windows.

Edit:

Ich habe dies in Haupt- und es erzeugt eine Haupt-Seite:

/**
@mainpage

This is a test application.

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

Aber dann weiter unten in der Datei, in der die Funktionsprototypen sind ich habe dies und es nicht analysiert bekommt:

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

Answer 1

Ich habe dies an der Spitze der main.cpp und es funktionierte. So ist das.

/**
@file main.cpp
*/

Answer 2

Wenn INPUT und FILE_PATTERNS leer sind, sollte es für * CPP-Dateien (und viele andere Muster) im aktuellen Verzeichnis suchen. (Diese aus dem doxygen Handbuch .)

Da Ihr leer sind, erwarte ich eine von zwei Dinge vor sich geht, wenn Sie nicht main.cpp Dokumentation bekommen:

1. main.cpp ist nicht im aktuellen Verzeichnis. Um dies zu ausschließen, stellen Sie sicher, dass Sie laufen doxygen aus dem gleichen Verzeichnis wie beide Ihre Konfigurationsdatei und main.cpp.
2. Es ist ein Syntaxfehler in ihrer main.cpp Dokumentation. Diese können schwierig zu erkennen, wie doxygen ist grundsätzlich nicht der Abbruch, wenn es ein Fehler auftritt - anstatt es einfach weiter springt. Wenn dies das Problem, Kamm durch doxygen der Ausgang, wenn Sie Ihre Dokumente Zeile für Zeile zu erzeugen.

Wenn keine dieser Ideen lösen Ihr Problem, wir könnten mehr Informationen benötigen. Ausgabe von ls -R, Ausgabe des doxygen Lauf usw. Viel Glück!

Answer 3

Ich habe einige Forschung auf diesem ... Von dem doxygen Handbuch :

Wichtig: Die Dokumentation der globalen Funktionen, Variablen, typedefs, und Aufzählungen wird nur in die aufgenommen werden ausgegeben, wenn die Datei, die sie in sind, ist dokumentiert auch.

Dort gehen Sie!