Pergunta

Eu tenho certeza que há alguma maneira de fazer isso com o \ defgroup, \ addgroup e \ @ {\ @} tags, mas depois de um par de horas de tentativa e erro (obviamente), eu estou pedindo SO .. ...

Eu tenho:

class C {
public:
    void foo () const;
};

e tenho algumas funções auxiliares não-associados que são realmente parte da interface do C, mas não estão na classe:

std::string
format (const C& c, const std::string &fmt);

Eu gostaria a função de formatação para aparecer na mesma página, como as funções de classe. É que simplesmente não é possível? É o melhor que posso fazer uma página de "módulo", que lista C como uma classe (com um link para comentários de C, eo formato como uma função?

Foi útil?

Solução

\ relaciona (ou \ memberof) parecem ser o que você está procurando.

Outras dicas

Criar um grupo e atribuir funções fora de sua classe nesse grupo irá funcionar, mas na própria documentação da classe, você não vai obter referências às suas funções a menos que você use comandos como @see ou @sa. Honestamente, porque uma função tem um parâmetro documentado não significa essa função é automaticamente parte da biblioteca, mas você pode ligar ambas as classes e funções em conjunto, utilizando @defgroup e @addgroup.

Licenciado em: CC-BY-SA com atribuição
Não afiliado a StackOverflow
scroll top