rdoc, darkfish, y la: llamada siguientes: Etiqueta

Question

Estoy en el proceso de documentación de un proyecto de rubí con rdoc, y descubrí el formateador rdoc darkfish. Me gusta mucho, pero la etiqueta de :call-seq: ya no funciona. En su lugar, se pone el :call-seq: cadena literal en la documentación, y presenta la secuencia de llamada a sí mismo como un bloque de código. No quiero que acaba de tomar toda la: llamada siguientes: bloques de mi código, ya que gran parte de mis necesidades de documentación que se refieren a los nombres de instancia y nombres de los parámetros indicados en el bloque :call-seq:. ¿Alguien mas ha tenido este problema? ¿Qué debo hacer, y es que hay alguna solución? Estoy bastante seguro de que la etiqueta :call-seq: estaba trabajando antes, cuando yo estaba usando el formateador predeterminado, pero no puedo estar seguro porque no puedo encontrar la manera de volver a generar el formato original (rdoc llamando sin argumentos excepto los archivos genera una salida darkfish ahora, incluso si elimino la carpeta doc!) ¿alguien sabe cómo solucionar este problema?

Answer 1

os recomiendo pasar de rdoc a patio . No es compatible con la edad en sí llamada-ss, pero en cambio tiene etiquetas y sobre todo la @ sobrecarga etiqueta reemplazará superiormente llamada-ss. Toda la documentación sobre rubydoc.info también se genera utilizando Yard.

Aquí está el ejemplo de @overload de la documentación Patio:

# @overload set(key, value)
#   Sets a value on key
#   @param [Symbol] key describe key param
#   @param [Object] value describe value param
# @overload set(value)
#   Sets a value on the default key `:foo`
#   @param [Object] value describe value param
def set(*args)
end