Come posso nascondere una funzione particolare (in C++) in doxygen?

Question

Ho una classe che ha funzioni may e voglio nascondere una funzione particolare. Ad esempio

class Test 
{ 

    /** 
    * About Function1 
    * 
    * @param[in] arg1 About arg1 
    * @param[in] arg2 About arg2 
    */   
    public void Function1(int arg1,char arg2); 

    // Presume same documentation for this function also 
    public void Function2(int,char); 

    // Presume same documentation for this function also 
    public void Function3(int,char); 

    // Presume same documentation for this function also 
    public void Function4(int,char); 
} 

Supponiamo di voler nascondere say Function2 come farei quello.

Ora nello scenario attuale vengono visualizzate tutte le quattro funzioni insieme alle relative documentazioni.

ora, ho il seguente set di attributi nel mio file di regole .doxygen:

EXTRACT_ALL = YES

Potete prego suggerire qualcosa con cui posso nascondere dire Function2?

Grazie in anticipo.

Answer 1

fare qualcosa di simile:

#ifndef DOXYGEN_SHOULD_SKIP_THIS 

/* code that must be skipped by Doxygen */ 
/* in your case a method/function */ 

#endif /* DOXYGEN_SHOULD_SKIP_THIS */ 

E nel file di configurazione, messo PREDEFINED = DOXYGEN_SHOULD_SKIP_THIS Assicurarsi che ENABLE_PREPROCESSING è impostato su YES.

In breve, stai solo sfruttando il concetto del preprocessore per lavorare per te!

Answer 2

Penso di aver usato una volta lo EXTRACT_SYMBOLS per ottenere qualcosa del genere.

Il tag EXCLUDE_SYMBOLS può essere utilizzato per specificare uno o più nomi di simboli (namespace, classi, funzioni, ecc) che devono essere esclusi dal uscita. Il nome del simbolo può essere un nome completo, una parola o se viene utilizzata la wildcard * *, una sottostringa. Esempi: ANamespace, Aclass, Aclass :: ANamespace, ANamespace :: * Test

Purtroppo non posso ricordare tutto, né trovare la voce config.

EXCLUDE_SYMBOLS = Test::Function2* 

Answer 3

Se avete EXTRACT_PRIVATE = NO nel file di configurazione, quindi è possibile contrassegnare qualsiasi membro da privato a Doxygen e non genererà documentazione per il membro: domanda

/// @private 
public void Function2(int, char); 

Bonus: se si voleva utilizzare la stessa documentazione per tutti e quattro i membri è possibile utilizzare uno di questi approcci:

/** 
* About Function1,2,3,4... 
*/ 
/// @{ 
public void Function1(int arg1, char arg2); 
public void Function2(int arg1, char arg2); 
public void Function3(int arg1, char arg2); 
public void Function4(int arg1, char arg2); 
/// @} 

/** 
* About Function1,2,3,4... 
*/ 
public void Function1(int arg1, char arg2); 
/// @copydoc Function1 
public void Function2(int arg1, char arg2); 
/// @copydoc Function1 
public void Function3(int arg1, char arg2); 
/// @copydoc Function1 
public void Function4(int arg1, char arg2); 

quella che utilizza @{ ... @} richiede l'uso di DISTRIBUTE_GROUP_DOC = YES nel file di configurazione.

Answer 4

Usa cond o interno

/*! \cond PRIVATE */ 
//only documented if cond is enabled 
// ... 
/*! \endcond */