2010-03-11 12 views
10

¿Cómo puedo obligar a Doxygen a mostrar la ruta completa de inclusión?¿Cómo puedo obligar a Doxygen a mostrar la ruta completa de inclusión?

¿Qué quiero decir:

tengo una clase foo::bar::bee definido en bee.hpp en siguiente estructura de directorios:

foo 
foo/bar 
foo/bar/bee.hpp 

Doxygen, cuando se documenta foo::bar::bee clase dice que es necesario incluir <bee.hpp>, pero para mi software necesito <foo/bar/bee.hpp>

¿Cómo puedo hacer que Doxygen haga esto? ¿Hay alguna opción para proporcionar "Incluir indicadores" como "-I" para que doxygen sepa dónde está la base?

Notas:

  • FULL_PATH_NAMES ya está definido como predeterminado YES
  • no quiero proporcionar incluir un encabezado de forma explícita para cada clase, porque no demasiados de ellos. Quiero que Doxygen haga esto automáticamente.

Gracias.

respuesta

Set:

STRIP_FROM_INC_PATH = relative/path/to/include/directory 

Respuesta

12

toman directamente de los consejos en doxywizard:

STRIP_FROM_INC_PATH

La etiqueta STRIP_FROM_INC_PATH se puede utilizar para quitar el usuario de una parte definida del camino mencionado en la documenta ción de una clase, que le dice al lector qué archivo de encabezado incluir para usar una clase. Si se deja en blanco, solo se utiliza el nombre del archivo de encabezado que contiene la definición de clase. De lo contrario, uno debe especificar las rutas de inclusión que normalmente se pasan al compilador usando el indicador -I.

+0

Gracias ... me siento estúpida. Leí esta parte de la documentación y no la entendí. – Artyom

+1

Bueno, el nombre de la opción sugiere un comportamiento diferente, así que no te rindas :) –

Cuestiones relacionadas