2010-06-25 14 views
10

C++ no fue capaz de determinar cuál es el comportamiento de Doxygen es con respecto a la sección \mainpage, en dos casos:Doxygen: varios bloques MainPage en un proyecto

  1. Si especifica ninguna sección \mainpage, lo hace use otra página en su lugar y, de ser así, ¿cómo se selecciona?
  2. ¿Qué pasa si dos archivos ambas especificar una sección \mainpage?

Respuesta

9

El comando \mainpage especifica el contenido que sirve para personalizar la página de índice, por lo que si no tiene uno que es sólo una página en blanco con la cabecera Doxygen normal y pie de página.

creo que lo más seguro que decir acerca de tener múltiples \mainpage comandos es que es indefinido en el sentido clásico de producir resultados impredecibles, dependiendo de la versión y plataforma. Del mismo modo, he tenido resultados extraños cuando accidentalmente creé más de un comando \page con el mismo nombre de página.

seguir pensando

Impulsada por answering another Doxygen question, recuerde que usted puede conseguir Doxygen a obedecer las directivas del preprocesador para que pueda tener #if condicionales protegen las múltiples directivas MainPage y ejecutar diferentes archivos de configuración sobre la misma base de código, donde los archivos de configuración definen uno de varios valores de indicador.

He utilizado este generar los documentos desde diferentes perspectivas enfoque para publicar Macintosh y Windows-oriented versiones de la misma referencia.

+1

Además, comenzando con doxygen 1.8.3 la directiva "USE_MDFILE_AS_MAINPAGE" en el archivo de configuración de doxygen puede configurar qué archivo se utiliza como página principal, esto evita la necesidad de directivas de preprocesador. –

Cuestiones relacionadas