Doxygen no procesará main.cpp

Question

Así que estoy familiarizado con el uso Doxygen y yo era capaz de conseguir que funcione sin problemas. Yo era capaz de documentar mis clases y las estructuras y genera los archivos HTML a la perfección. El problema que estoy corriendo en es que no va a analizar mi archivo main.cpp. Todas las clases y las estructuras tienen sus propios archivos .cpp y .h y procesan bien. ¿Cómo llego Doxygen para hacer la documentación de main.cpp? No tiene un archivo .h ya que es donde el programa se inicia y termina. Ni siquiera sabría qué poner en el archivo .h para las principales. 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 procesado:

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

Pongo esto en la parte superior de main.cpp y funcionó. Ir figura.

/**
@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 de .)

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 el directorio actual. Para descartar esta posibilidad, que doxygen asegurarse de que está funcionando desde el mismo directorio que ambos a 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, como doxygen generalmente no abortar cuando se encuentra un error - en vez de eso sólo se salta por delante. Si este es el problema, peine por la salida de doxygen cuando se genera la línea de documentos por línea.

Si ninguna de estas ideas a resolver su problema, puede ser que necesite más información. Salida del ls -R, producto de la fase doxygen, etc. Buena suerte!

Answer 3

He hecho un poco de investigación sobre este ... Desde el doxygen manual de :

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

Hay que ir!