Jak dokumentować funkcje, które są włączone w SFINAE z Doxygen?

Question

w bibliotece Zajmuję, często mają tego rodzaju kodu:

template<typename T = P, enable_if_c<has_V_field<T>> = detail::dummy> 
constexpr std::size_t v(){ 
    return T::V; 
} 

template<typename T = P, disable_if_c<has_V_field<T>> = detail::dummy> 
constexpr std::size_t v(){ 
    return 1; 
} 

dwóch funkcji zrobić to samo, ale są włączane w zależności od typu. Chciałbym udokumentować tylko jedną z nich, a co więcej, chciałbym, jeśli to możliwe, pokazać ją w Doxygen bez szablonu, jako constexpr std::size_t v(). Dla użytkownika szablony tutaj nie mają żadnej wartości.

Czy to możliwe w przypadku Doxygen?

Answer 1

Można użyć \fn: http://www.stack.nl/~dimitri/doxygen/manual/commands.html#cmdfn

Coś (niesprawdzone)

/*! \fn template<typename T> constexpr std::size_t v() 
* \brief A function. 
* \return 1 or T::V. 
*/ 

Answer 2

Można umieścić funkcję, którą chcesz zobaczyć w sekcji warunkowego tak:

#ifdef DOXYGEN_ONLY 

/*! documentation for v. */ 
constexpr std::size_t v(); 

#else // actual implementation with two variants selected via SFINAE 

template<typename T = P, enable_if_c<has_V_field<T>> = detail::dummy> 
constexpr std::size_t v(){ 
    return T::V; 
} 

template<typename T = P, disable_if_c<has_V_field<T>> = detail::dummy> 
constexpr std::size_t v(){ 
    return 1; 
} 

#endif 

, a następnie użyj następujących ustawień konfiguracji:

ENABLE_PREPROCESSING = YES 
PREDEFINED    = DOXYGEN_ONLY