tutorial smart remix español curso aprender c++ include doxygen code-documentation

c++ - smart - ¿Cómo puedo forzar a Doxygen a mostrar la ruta completa de inclusión?



solidity ide (1)

Tomado directamente de los consejos en DoxyWizard:

STRIP_FROM_INC_PATH

La etiqueta STRIP_FROM_INC_PATH se puede utilizar para quitar una parte definida por el usuario de la ruta mencionada en la documentació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.

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

Que quiero decir:

Tengo una clase foo::bar::bee definida en bee.hpp en la siguiente estructura de directorios:

foo foo/bar foo/bar/bee.hpp

Doxygen, cuando documenta foo::bar::bee class dice que necesitas 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á establecido en el valor predeterminado YES
  • No deseo proporcionar el encabezado de inclusión explícitamente para cada clase, porque hay muchos de ellos. Quiero que Doxygen haga esto automáticamente.

Gracias.

Responder

Conjunto:

STRIP_FROM_INC_PATH = relative/path/to/include/directory