doxygen: включить документацию по псевдониму удобства в разделе под документацией класса - PullRequest
6 голосов
/ 20 января 2020

Я определил следующую структуру признаков типа со связанной документацией:

/*!
 * @brief Get the type at a given index Idx from a template parameter pack TPack. 
 *
 * Provides a member type holding the type at a given index Idx in a template
 * parameter pack TPack. 
 * <br> The index must be less than the template parameter pack dimension, otherwise
 * a compilation error will be triggered.
 *
 * @ingroup my_group
 */
template <unsigned int Idx, class... TPack>
struct TypeAt;

и затем предоставил вспомогательный псевдоним (определенный в том же файле и в том же пространстве имен) как:

/*!
 * @ingroup my_group 
 */
template<unsigned int Idx, class... TPack>
using TypeAtT = typename TypeAt<Idx, TPack...>::type;

Документация псевдонима отображается на странице документации namespace . Вместо этого я хотел бы включить его на странице документации TypeAt class в именованном разделе, как это делает документация std::remove_cv на cppreference.com для удобства. псевдоним std::remove_cv_t

Этот ответ предлагает использовать команду @relates; однако, насколько я понял, он не позволяет настраивать заголовок только для одного файла.

Другое предложение - использовать группировку doxygen, но, глядя на примеры, представленные на этой странице не похоже, что дает желаемый результат.

Может кто-нибудь подсказать мне, возможно ли сделать то, что я пытаюсь достичь, и как?

Для полноты, я использование doxygen 1.8.13 в Ubuntu 18.04.

Заранее большое спасибо.

...