Pergunta

Esta questão já tem uma resposta aqui:

Eu gostaria de adicionar um comando personalizado a minha documentação doxygen. Basicamente, para cada função C Eu estou escrevendo doc para, eu preciso escrever que as variáveis ??globais são "tocados" em modo de escrita modo de leitura ou. É como a lista "Consulte também", apenas com uma legenda diferente.

No meu arquivo eu gostaria de escrever algo como isto:

/*
 * \read-globals   #var1, #var2
 *
 * \write-globals  #var3
 */

Eu tentei com um alias como esta:

read-globals = \par <b>Globals read</b>\n

Ele funciona, mas temo que da folha de estilo independente:. Se amanhã eu vou querer mudança css, então este comando personalizado irá gerar saída que parece diferente de seealso, autor e todas as outras secções

Basicamente, eu só quero para copiar o formato de outros comandos padrão.

Outra opção é usar o comando \ xrefitem, que trabalha muito, mas exige a introdução de uma seção como segundo parâmetro que é totalmente inútil no meu caso (talvez ele possa ser escondido de alguma forma?).

Existe um "caminho certo" para alcançar meu objetivo?

Foi útil?

Solução

Você pode combinar \xrefitem e ALIASES se você quer esconder o segundo parâmetro. Aqui está um exemplo de uso I para requisitos:

ALIASES += "req=\xrefitem req \"Requirement\" \"Requirements\" "

Então em código documentado:

/// \req #42 The system shall work in any situation

(da minha resposta a essa pergunta: etiquetas personalizadas com o Doxygen )

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