2010-06-25 8 views
5

Estoy empezando con Doxygen, y he realizado una búsqueda considerable de esto, así que discúlpeme si hay una respuesta obvia.Configurar Doxygen para ocultar ciertos nombres o palabras clave

Estoy trabajando en un proyecto incrustado donde las funciones se pueden etiquetar como debug o nodebug antes del tipo de devolución. En la mayoría de nuestras bibliotecas, utilizamos una macro condicional para establecer libname_debug en debug o nodebug en la parte superior del archivo, y luego cada función tiene el prefijo libname_debug.

Para fines de documentación, me gustaría que Doxygen deje libname_debug fuera de la documentación de la función. Agrupa la lista de funciones y hace que sea más difícil ver los tipos de devolución de cada función.

¿Es posible etiquetar el archivo de alguna forma para que Doxygen lo deje? Por el momento, estoy envolviendo cada caso en cond @/@ endcond:

/** @cond */ libname_debug /** @endcond */ 

Pero eso es un dolor y añade marcado adicional a la fuente.

Respuesta

2

Puede definir macros en el archivo de configuración doxygen. Algo como esto

PREDEFINED += libname_debug 
+0

Gracias, que fue el punto de partida que necesitaba. Tuve que actualizar la fuente para no definir libname_debug si ya estaba definido, agregarlo a la lista PREDEFINIDO, y luego activar MACRO_EXPANSION y EXPAND_ONLY_PREDEF. Tenía la esperanza de que el patrón '* _debug' en EXCLUDE_SYMBOLS funcionara, pero ese no era el caso. – tomlogic

5

También hay un doxygen page explicando cómo manejar este tipo de situtations. Le permitiría MACRO_EXPANSION (que por defecto es NO), informe doxygen sólo a expandir algunos macros (EXPAND_ONLY_PREDEF) y añada su símbolo como macro con una expansión vacío:

ENABLE_PREPROCESSING = YES 
MACRO_EXPANSION  = YES 
EXPAND_ONLY_PREDEF  = YES 
PREDEFINED    = libname_debug= 
+0

+1 por ser claro. ¿Pero qué pasa con este último "igual" en 'libname_debug ='? ¿Es esto correcto? Gracias. –

+0

'libname_debug =' es correcto, significa que la macro 'libname_debug' se expande con" una expansión vacía ". Por favor, eche un vistazo a la página doxgen vinculada. –

Cuestiones relacionadas