¿Existe una referencia buena y sólida para la sintaxis RDoc adecuada?

Estoy buscando una referencia buena y sólida para la sintaxis RDoc adecuada. Recomendaciones? Parece que no puedo encontrar nada que muestre claramente:

1. Cómo documentar los métodos de clase y sus parámetros
2. Cómo documentar lo que hace una clase o método de clase.

Se puede encontrar un ejemplo oficial de rdoc aquí , con su fuente GitHub .

La documentación de rdoc.rubyforge.org parece ser más completa que la versión de rdoc.sourceforge.net (que por cierto tiene una fecha de modificación de 2003).

Además, hay una gran fuente de ejemplos: el núcleo de Ruby y la documentación stdlib. Por ejemplo, eche un vistazo a uno de los métodos de Fileclase de la clase :

File.atime (file_name) => hora

Devuelve la última hora de acceso para el archivo nombrado como un objeto Time).

File.atime("testfile") #=> Wed Apr 09 08:51:48 CDT 2003

Puede ver el código fuente original, incluido el marcado RDoc, haciendo clic en la primera línea (en la página RDoc real, no en la cita que incluí en esta respuesta). En este caso, el método se implementó en C, pero el formato RDoc es el mismo que si estuviera implementado en Ruby:

/*
 *  call-seq:
 *     File.atime(file_name)  =>  time
 *  
 *  Returns the last access time for the named file as a Time object).
 *     
 *     File.atime("testfile")   #=> Wed Apr 09 08:51:48 CDT 2003
 *     
 */

A partir de esto, puede ver que le call-seq:permite reemplazar el nombre del método y los parámetros con el texto de su elección, que es muy útil para los métodos de clase. También muestra cómo puede mostrar código de ejemplo en una fuente monoespaciada al sangrarlo, similar a Markdown.

Dado que RubyForge se ha retirado , aquí hay un nuevo enlace:

http://ruby-doc.org/stdlib-2.5.1/libdoc/rdoc/rdoc/RDoc/Markup.html