Funzione privata Doxygen

Question

C'è un modo per far visualizzare a doxygen la documentazione per le singole funzioni private? Voglio che doxygen non mostri la documentazione per la maggior parte delle funzioni private, ma la mostri per alcune funzioni private selezionate. La mia motivazione è che queste funzioni private di C++ sono fornite a Python come estensioni e voglio che la loro documentazione venga mostrata in Doxygen. Tuttavia, non voglio che siano pubblici perché sono necessari solo dalle classi stesse; sicuramente appartengono al settore privato.

Grazie

Answer 1

Ci sono un paio di modi per raggiungere questo obiettivo.

Si potrebbe semplicemente non documentare quelle funzioni che non si desidera visualizzare. Per impostazione predefinita, Doxygen non mostrerà alcun membro che non hai documentato. Quindi, puoi semplicemente dirgli di mostrare i privati ​​e qualsiasi membro privato non documentato non verrà mostrato.

Answer 2

La sezione tra i comandi \ cond e \ endcond può essere inclusa aggiungendo l'etichetta di sezione all'opzione di configurazione ENABLED_SECTIONS. Se l'etichetta della sezione viene omessa, la sezione sarà esclusa dall'elaborazione incondizionata.

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

    /// @cond COND1 

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

    /// @endcond 
}; 

Vedi cond help

non vedere sezioni COND1: basta non inserirlo opzione di configurazione ENABLED_SECTIONS a.