RDoc: modifica il nome della sezione "Attributi:" nella documentazione ri
-
11-07-2019 - |
Domanda
Sto usando una meta-programmazione per generare un sacco di metodi in ruby ??in questo modo:
class EmotionalObject
def self.mood( name, *details )
define_method(name) do
# ...
end
end
mood :happy, #...
mood :sad, #...
mood :ebuillent, #...
#...
end
So che posso passare rdoc
'-A mood' per farlo riconoscere al mio umore
codice di generazione come attributi, che è utile, almeno da allora
essere riconosciuto.
Tuttavia, sono davvero più simili ai metodi regolari che agli attributi, quindi
Non li voglio elencati nella sezione "Attributi:" quando guardo
nella documentazione utilizzando ri
. Non ho attributi regolari,
quindi c'è un modo semplice per cambiare il titolo di questa sezione in "Moods:"
o qualcosa del genere, quindi i miei utenti sono almeno abbastanza curiosi di digitare ri EmotionalObject # happy
.
Soluzione
È codificato nei modelli RDoc, ma puoi creare un nuovo modello da utilizzare duplicando il valore predefinito " html " modello e modifica manuale del nome dell'intestazione.
Vedi qui l'origine del modello RDoc: http://github.com/juretta/ruby/blob/master/lib/rdoc/generator/html/html.rb#L601 .
Altri suggerimenti
Sembra che da qualche parte intorno a rdoc 2.4.1 siano stati rimossi --accessor
e sostituiti con i commenti ##
su ciascun meta-metodo. Sebbene ciò ti consenta di eliminarli dalla sezione degli attributi, ti obbliga anche a commentarli singolarmente.