RDoc:在ri-documentation中更改“Atttributes:”部分的名称

时间:2008-11-28 18:11:08

标签: ruby metaprogramming rdoc ri

我正在使用一些元编程在ruby中生成一堆方法,如下所示:

class EmotionalObject
  def self.mood( name, *details )
    define_method(name) do
      # ...
    end
  end

  mood :happy, #...
  mood :sad, #...
  mood :ebuillent, #...
  #...
 end

我知道我可以通过rdoc' - 一种情绪'来让它识别我的心情 生成代码作为属性,这是很方便的,从那以后他们至少 得到认可。

然而,它们更像是常规方法而不是属性,所以 当我看时,我不希望它们列在“属性:”部分下面 在使用ri的文档中。我没有任何常规属性, 那么有什么简单的方法我可以将这一部分的标题改为'心情:' 或类似的东西,所以我的用户至少好奇地键入ri EmotionalObject#happy

2 个答案:

答案 0 :(得分:1)

它已硬编码到RDoc模板中,但您可以通过复制默认的“html”模板并手动更改标题名称来创建新模板。

请在此处查看RDoc模板源:http://github.com/juretta/ruby/blob/master/lib/rdoc/generator/html/html.rb#L601

答案 1 :(得分:1)

似乎在rdoc 2.4.1附近,他们删除了--accessor并将其替换为对每个元方法使用##条评论。虽然这允许您将它们从属性部分中取出,但它也会强制您单独评论每个部分。

http://rdoc.rubyforge.org/RDoc/Parser/Ruby.html