Sencilla rdoc Pregunta sobre modificadores de documentación

Question

Tengo este método en una clase que estoy utilizando

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

y quiero en la documentación de los parámetros que aparecen como def binary_search(array, key) y no binary_search(a,x). He tratado de utilizar el modificador # :binary_search: array, key documentación sin éxito. Sé que una pequeña cosa, pero si alguien sabe cómo hacer que los parámetros diferentes en la documentación que en el código fuente real, ¿Me podría mostrar? Gracias.

Answer 1

Se supone que será capaz de utilizar la :call-seq: Directiva en el comentario cabecera del método de la siguiente manera:

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

No tengo este trabajo todavía. Estoy usando V1.0.1 RDoc y Ruby 1.8.7.

Answer 2

Tal vez intente # :args: thing_to_try este modo: (tener cuidado con los espacios en blanco)

# 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