RDoc: Alterar nome de 'Atttributes:' seção em ri-documentação
-
11-07-2019 - |
Pergunta
Eu estou usando alguns meta-programação para gerar um monte de métodos em Ruby assim:
class EmotionalObject
def self.mood( name, *details )
define_method(name) do
# ...
end
end
mood :happy, #...
mood :sad, #...
mood :ebuillent, #...
#...
end
Eu sei que eu posso passar rdoc
'-A humor' para obtê-lo a reconhecer o meu humor
código de geração como atributos, o que é útil, desde então, pelo menos,
ser reconhecido.
No entanto, eles são realmente mais como métodos regulares do que atributos, de modo
Eu não quero que eles listados sob os 'atributos:' seção quando eu olho
a documentação usando ri
. Eu não tenho quaisquer atributos regulares,
Então, há alguma maneira simples eu posso apenas alterar o título desta seção para ser 'Moods:'
ou algo assim, então meus usuários são pelo menos o suficiente curioso tipo ri EmotionalObject#happy
.
Solução
É codificado para os modelos RDoc, mas você pode fazer um novo modelo para uso duplicando o modelo padrão "html" e mudar o nome do cabeçalho com a mão.
Veja a fonte modelo RDoc aqui: http://github.com/juretta/ruby/blob/master/lib/rdoc/generator/html/html.rb#L601 .
Outras dicas
Parece que algo em torno de rdoc 2.4.1 eles removeram --accessor
e substituiu-o com o uso de comentários ##
em cada meta-método. Enquanto isso permite que você para tirá-los da seção atributos, também obriga a comentar cada um individualmente.