RDoc: Ändern Namen 'Atttributes:' Abschnitt in ri-Dokumentation
-
11-07-2019 - |
Frage
Ich verwende einige Meta-Programmierung eine Reihe von Methoden in Ruby zu erzeugen, etwa so:
class EmotionalObject
def self.mood( name, *details )
define_method(name) do
# ...
end
end
mood :happy, #...
mood :sad, #...
mood :ebuillent, #...
#...
end
Ich weiß, dass ich rdoc
‚-A Stimmung‘ passieren kann, um es meine Stimmung zu erkennen
Generierungscode als Attribute, die praktisch ist, sie seither zumindest
erhalten anerkannt.
Allerdings sind sie wirklich mehr wie normale Methoden als Attribute, so
Ich will sie nicht unter den aufgelisteten ‚Attribute:‘ Abschnitt, wenn ich sehe
bei der Dokumentation mit ri
. Ich habe keine regelmäßigen Attribute,
so gibt es eine einfache Art und Weise kann ich nur den Titel dieses Abschnitts ändern zu sein ‚Moods:‘
oder so ähnlich, so dass meine Benutzer sind zumindest neugierig genug ri EmotionalObject#happy
zu geben.
Lösung
Es ist in die RDoc Vorlagen fest einprogrammiert, aber Sie können eine neue Vorlage durch Duplizieren der default „html“ Vorlage und die Änderung der Überschrift Namen von Hand zu bedienen.
Andere Tipps
Es scheint, dass irgendwo um rdoc 2.4.1 sie entfernt --accessor
und ersetzte sie durch ##
Kommentare zu jeder Meta-Methode. Während dies ermöglicht es Ihnen, um sie aus dem Attribute Abschnitt zu bekommen, es zwingt auch Sie diese einzeln Stellung zu nehmen.