Простой RDoc Вопрос модификаторов документации

Question

У меня есть этот метод в классе я использую

def binary_search(a,x) 
    # ... 
end 

и я хочу в документации параметры появляются в def binary_search(array, key) и не binary_search(a,x). Я попытался использовать модификатор документации # :binary_search: array, key без каких-либо успехов. Я знаю это немного, но если кто-то знает, как сделать, чтобы параметры были разными в документации, чем в исходном коде, можете ли вы показать мне? Благодарю.

Answer 1

Вы должны быть в состоянии использовать :call-seq: директиву в заголовке комментария метод следующим образом:

## 
# Pass array and key. 
# 
# :call-seq: 
# binary_search(array, key) 
def binary_search(a, x) 
    # ... 
end 

Я не получил эту работу еще. Я использую RDoc V1.0.1 и Ruby 1.8.7.

Answer 2

Может попробовать # :args: thing_to_try так как: (быть осторожным пробельных)

# rdoc-2.5.8/lib/rdoc/parser/ruby.rb:48 
# The parser extracts the arguments from the method definition. You can 
# override this with a custom argument definition using the :args: directive: 

    ## 
    # This method tries over and over until it is tired 

    def go_go_go(thing_to_try, tries = 10) # :args: thing_to_try 
    puts thing_to_try 
    go_go_go thing_to_try, tries - 1 
    end