RDoc

RDoc terbuat dari dua bagian besar.

Salah satunya adalah rdoc , utilitas untuk menghasilkan dokumentasi HTML. Yang kedua adalah ri , alat untuk membuat dokumentasi untuk antarmuka baris perintah Ruby.

Untuk dapat benar menggunakan RDoc, pengembang harus mengubah cara ia menambahkan komentar ke kode sumber nya.

RDoc menggunakan sumber tertentu struktur kode komentar, sehingga mereka dengan mudah dapat diekstraksi dan membantu mengisi situs dokumentasi.

struktur komentar RDoc ini adalah sangat sukses, yang digunakan oleh banyak generator dokumentasi serupa dibuat untuk bahasa pemrograman lain

Apa yang baru dalam rilis ini:.

• RDoc sekarang dapat menghasilkan file terjemahan untuk digunakan dengan gettext.

Apa yang baru di versi 4.2.0:

• RDoc sekarang dapat menghasilkan file terjemahan untuk digunakan dengan gettext .

Apa yang baru di versi 4.1.0:.

• Peningkatan aksesibilitas output HTML
• Tampilan RDoc telah diperbarui.

Apa yang baru di versi 4.0.0:.

• Ditambahkan penurunan harga sebagai format yang didukung
• ri sekarang dapat menampilkan halaman (README, dll.).
• negara global Dihapus dari RDoc. RDoc :: Toko memegang pohon dokumentasi dan menghubungkan driver ke parser dan generator.

Apa yang baru di versi 3.12:

• Kecil perangkat tambahan:
• dokumen Ditambahkan pengembang yang berisi gambaran tentang cara kerja RDoc dan bagaimana untuk menambahkan fitur baru untuk RDoc.
• Peningkatan title untuk output HTML untuk memasukkan --title dalam elemen title.
• rdoc --pipe sekarang mengerti --markup.
• RDoc sekarang mendukung irc-skema hyperlink.
• Perbaikan bug:
• judul Tetap pada output HTML untuk halaman.
• parsing Tetap heredoc non-indentasi.
• parsing Tetap% w [] dan literal lainnya%.
• Tetap panah pengganti output HTML munging operator pesawat ruang angkasa.
• bagian Verbatim dengan ERB yang sesuai dengan kode ruby ​​daftar putih tidak lagi sintaks-disorot.
• ujung Line pada jendela normal segera setelah membaca dengan binmode.
• RDoc lebih baik memahami arahan untuk komentar. Komentar arahan sekarang dapat ditemukan di mana saja di komentar multi-line.
• Link Tidy untuk metode tunjukkan label lagi.
• RDoc :: Parser :: C sekarang dapat menemukan komentar langsung di atas rb_define_class_under.
• Dalam rdoc, backspace dan formatters ansi, label dan catatan tanpa badan sekarang ditampilkan.
• Dalam rdoc, backspace dan formatters ansi, spasi antara label atau catatan dan usus besar kini dilucuti.

Apa yang baru di versi 3.11:

• Perbaikan bug:
• Hindari parsing file TAGS termasuk dalam permata.

Apa yang baru di versi 3.9.2:

• Bug fix:
• melonggarkan TIDYLINK regexp untuk mengizinkan semua konten di bagian link seperti: & # x3c; tt & # x3e; {foo} [rdoc-ref: SomeClass] & # x3c; / tt & # x3e;
• Dalam pos keluaran HTML maksimal & # x3c; tt & # x3e; & # x3c; h6 & # x3e; & # x3c; / tt & # x3e; lagi.

Apa yang baru di versi 3.9.1:

• Perbaikan bug:
• RDoc Fix :: parser Markup untuk header diikuti dengan tanda non-teks.
• Fix RDoc :: Markup :: ToHtmlCrossref # gen_url untuk non - & # x3c; tt & # x3e; rdoc-ref & # x3c; / tt & # x3e; link.
• Fix laporan bug URL saat rdoc crash.

Apa yang baru di versi 3.8:

• Kecil perangkat tambahan:
• RDoc :: Parser :: C sekarang dapat menemukan metode pada ENV dan ARGF.
• RDoc :: Parser :: C sekarang tahu tentang rb_cSocket dan rb_mDL.
• Perbaikan bug:
• Memperbarui Obyek dalam menyimpan data ri dengan data baru sekarang menghapus metode, termasuk, konstanta dan alias.

Apa yang baru di versi 3.7:

• Kecil perangkat tambahan:
• New direktif: kategori: yang memungkinkan metode yang akan dikelompokkan menjadi beberapa bagian yang lebih bersih. Lihat RDoc :: Markup untuk rincian.
• Dokumen-kelas untuk RDoc :: Parser :: C sekarang mendukung Foo :: CONST serta CONST.
• Metode ri keluaran sekarang daftar dipisahkan koma ketika ditampilkan secara interaktif.
• RDoc :: ClassModule # menggabungkan sekarang lebih suka informasi argumen atas penerima (sekarang berperilaku seperti Hash # menggabungkan! Bukannya Hash # gabungan mundur!).
• RDoc :: Markup # mengkonversi sekarang menerima sebuah RDoc :: Markup :: Dokumen misalnya
• RDoc sekarang memiliki kode untuk menghasilkan RDoc dan data ri ketika permata menginstal
• Ditambahkan RDoc :: RDoc :: ulang
• Ditambahkan RDoc :: CodeObject # nama_file
• Perbaikan bug:
• ri tidak lagi crash ketika mencoba untuk menyelesaikan sebuah dataran
• RDoc :: Parser :: Ruby tidak lagi makan konten ketika = mulai block / = end dokumentasi diikuti oleh item terdokumentasi. Isu # 41 oleh mfn.
• RDoc :: Markup :: Formatter dan subclass sekarang memungkinkan + markup opsional + parameter untuk menambahkan markup kustom. Contoh di RDoc :: Markup :: Formatter sekarang akan bekerja.
• RDoc :: Parser :: C sekarang dapat membedakan antara metode kelas dan metode misalnya dalam Dokumen-metode.
• RDoc sekarang mengkodekan nama file dalam encoding output.
• generasi ri data untuk metode alias tidak lagi duplikat kelas di #full_name