Официальный пример rdoc можно найти здесь с его источником GitHub .
Документация на rdoc.rubyforge.org представляется более полной, чем версия на rdoc.sourceforge.net (которая, кстати, имеет дату изменения 2003 года).
Кроме того, есть отличный источник примеров: ядро Ruby и документация stdlib. Например, взгляните на один из методов класса из File
class :
File.atime (имя_файла) => время
Возвращает время последнего доступа к
именованный файл как объект времени).
File.atime("testfile") #=> Wed Apr 09 08:51:48 CDT 2003
Вы можете просмотреть исходный код, включая разметку RDoc, нажав на первую строку (на самой странице RDoc, а не в цитате, которую я включил в этот ответ). В этом случае метод был реализован на C, но форматирование RDoc такое же, как если бы оно было реализовано в 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
*
*/
Из этого вы можете видеть, что call-seq:
позволяет заменять имя метода и параметры текстом по вашему выбору, что очень полезно для методов класса. В нем также показано, как можно отобразить пример кода в моноширинном шрифте с помощью отступа, аналогично Markdown.