online - Excluir algunas clases de la documentación de doxygen.

doxygen php

Question

Estoy creando un proyecto basado en Qt, y muchas clases de Qt se encuentran en la documentación de destino.

¿Cómo puedo decirle a Doxygen que deshabilite la generación de documentación para algunas clases? Para Q. *?

Answer 1

No es la mejor manera, pero se puede marcar una parte de la documentación (clase, miembros, ...) con el private . Esto evita que el fragmento de código se incluya en la documentación de salida. (Utilizo esto para ocultar que los constructores / operadores de copiar / mover no aparezcan en la documentación de la API).

/*!
* /brief This is included.
*/
class API
{
public:
/*!
* /brief So is this.
*/
API() noexcept;
/// /private
~API() noexcept; /* But this not, though technically public. */
private:
int m_version; /* This is not either. */
}

Sin embargo, se debe tener en cuenta que esta es una extensión de Doxygen para PHP, que de acuerdo con la documentation no deben utilizarse.

Para los archivos PHP hay una serie de comandos adicionales, que se pueden usar dentro de las clases para que los miembros sean públicos, privados o protegidos, aunque el lenguaje en sí no sea compatible con esta noción.

La otra opción es usar la solución provista, pero requiere al menos dos líneas.

Aunque no es la respuesta correcta para la pregunta detallada, podría ser útil para los lectores del título de la pregunta (como yo). ¡También funciona para la clase!

Answer 2

Si /internal etiqueta /internal no funciona, puede probar las etiquetas /cond ... /endcond para marcar una parte del código que se ocultará de Doxygen.

EDITAR

Si desea excluir archivos específicos, puede usar la variable EXCLUDE_PATTERNS en el archivo de configuración de Doxyfile .

Answer 3

Trabajando bajo el supuesto de que lo que tienes es algo como esto: (La pregunta no está muy clara a este respecto)

/**
* Some documentation for class X
*/
class X: public osg::Drawable {
...
}

Y su problema es que desea incluir documentación para la clase X , pero no para la clase osg::Drawable , la técnica adecuada es utilizar EXCLUDE_SYMBOLS . Por ejemplo, en el caso de uso anterior.

EXCLUDE_SYMBOLS = osg::Drawable

Si quieres ser un poco más riguroso, puedes usar

EXCLUDE_SYMBOLS = osg::Drawable /
Drawable

Los comodines también están permitidos, así que esto también funcionará.

EXCLUDE_SYMBOLS = osg::*