Función privada Doxygen

¿Hay alguna manera de que doxygen muestre la documentación para funciones privadas individuales? Quiero que Doxygen no muestre la documentación para la gran mayoría de las funciones privadas, pero muéstrela para algunas funciones privadas selectas. Mi motivación es que estas funciones privadas de C++ se proporcionan a Python como extensiones y quiero que su documentación se muestre en Doxygen. Sin embargo, no quiero que sean públicos porque solo las clases los necesitan; Definitivamente pertenecen al sector privado.Función privada Doxygen

Gracias

Fuente

2012-08-27 duffsterlp

ver esto http://stackoverflow.com/questions/562763/doxygen-hiding-private-protected-method-and-tips – PiotrNycz

Esto no responde mi pregunta. Eso determina cómo habilitar o deshabilitar todas las funciones privadas, que no es lo que quería hacer. Estoy esperando algún tipo de condicional. Intenté apagar documentos privados y habilitar los documentos internos, pero eso no funcionó. – duffsterlp

ver mi respuesta sobre condicionales. Requiere solo algunas ediciones por clase. – PiotrNycz

Hay un par de maneras de lograr esto.

Simplemente no puede documentar aquellas funciones que no quiere que sean visibles. Por defecto, Doxygen no mostrará ningún miembro que no hayas documentado. Por lo tanto, puede indicarle que muestre partes privadas y no se mostrarán los miembros privados no documentados.

Fuente

2012-08-27 18:55:07

para asegurarse de agregar 'HIDE_UNDOC_MEMBERS = YES' en el archivo de configuración ... – PiotrNycz

Definitivamente sería factible, sin embargo muchas funciones privadas ya tienen documentación doxygen, y no voy a des-doxgenarlas. – duffsterlp

La sección entre los comandos \ cond y \ endcond se puede incluir al agregar su etiqueta de sección a la opción de configuración ENABLED_SECTIONS. Si se omite la etiqueta de sección, la sección se excluirá del procesamiento incondicional.

/** An interface */ 
class Intf 
{ 
    public: 
    /** A method */ 
    virtual void func() = 0; 

    /// @cond COND1 

    /** A method used for testing */ 
    virtual void test() = 0; 

    /// @endcond 
};

Ver cond help

no ver secciones COND1: simplemente no lo agregue a la opción de configuración ENABLED_SECTIONS.

Fuente

2012-08-27 19:44:08 PiotrNycz

Para campos privados, esto solo funciona si EXTRACT_PRIVATE está habilitado. – tenpn

Respuesta

Cuestiones relacionadas