Doxygen no procesará main.cpp

Question

Soy nuevo en el uso de Doxygen y pude hacer que funcione sin problemas. Pude documentar mis clases y estructuras y genera los archivos HTML perfectamente. El problema al que me estoy enfrentando es que no analizará mi archivo main.cpp. Todas las clases y estructuras tienen sus propios archivos .h y .cpp y procesan bien. ¿Cómo obtengo Doxygen para hacer la documentación para main.cpp? No tiene un archivo .h ya que aquí es donde el programa comienza y termina. Ni siquiera sabría qué poner en el archivo .h para main. Estoy usando Doxywizard en Windows.

Editar:

pongo esto en el principal y genera una página principal:

/** 
@mainpage 

This is a test application. 

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

Pero luego más abajo en el archivo donde los prototipos de las funciones son tengo esto y que no consigue Analizada :

/** 
@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

Puse esto en la parte superior de main.cpp y funcionó. Imagínate.

/** 
@file main.cpp 
*/ 

Answer 2

Si INPUT y FILE_PATTERNS están vacíos, se debe buscar archivos * .cpp (y muchos otros patrones) en el directorio actual. (Esto de la Doxygen manual.)

Desde la suya están vacías, espero que una de dos cosas está sucediendo si no está recibiendo la documentación main.cpp:

1. main.cpp no ​​está en la corriente directorio. Para descartar esto, asegúrese de estar ejecutando Doxygen desde el mismo directorio que ambos su archivo de configuración y main.cpp.
2. Hay un error de sintaxis en la documentación de main.cpp. Estos pueden ser difíciles de detectar, ya que Doxygen generalmente no aborta cuando encuentra un error, sino que simplemente se salta. Si este es el problema, analice la salida de Doxygen cuando genere sus documentos línea por línea.

Si ninguna de estas ideas soluciona su problema, es posible que necesitemos más información. Salida de ls -R, salida de la ejecución de Doxygen, etc. ¡Buena suerte!

Answer 3

Hice algunas investigaciones en este ... Desde el doxygen manual:

Importante: La documentación de las funciones globales, variables, typedefs, y enumeraciones sólo serán incluidos en el salida si el archivo en el que se encuentran está documentado también.

¡Ya lo tiene!