ruby - 如何使 rdoc 链接到具有等号的方法

Question

我有一个文件

module Adapter
  ##
  # :method: avatar

  ##
  # :method: avatar=(value)
end

在另一个文件中，我想链接到这些方法:

# Adapter#avatar         # this generates a valid link to another page
# Adapter#avatar=        # this is shown as raw text

如何告诉 rdoc 它应该生成第二个链接？

更新:已确认如果编写器是使用 def avatar=(value) 静态定义的； end，链接生成好了。动态编写器虽然显然有问题。

更新 2:好的，这与链接无关。这是关于生成编写器方法的正确名称:

module Adapter
  ##
  # :method: avatar=(value)
end

生成的文档带有 avatar=(value)() 名称，和

module Adapter
  def avatar=(value); end
end

生成链接的正确 avatar=(value) 文档。

Answer 1

您应该使用 :call-seq: 声明您的参数，并且不要在 :method: 行中包含您的参数列表。以下对我有用，所有链接都有效:

module Adapter
  ##
  # :method: avatar

  ##
  # :method: avatar=
  #
  # :call-seq: avatar=(value)
end

# See Adapter#avatar  
# See Adapter#avatar=
#
class Linked
end

:method: 声明方法的name，:call-seq: 声明它接受的参数签名。

(顺便说一句，我找到了一些关于 RDoc 语法的非常有用的文档 here)。