RDoc

RDoc складається з двох основних частин.

Одним з них є RDoc , утиліта для генерації HTML-документації. По-друге, ри , інструмент для створення документації для інтерфейсу командного рядка Ruby.

Для того, щоб мати можливість правильно використовувати RDoc, розробник повинен змінити спосіб, яким він додає коментарі до його вихідного коду.

RDoc використовує конкретний вихідний код коментарі структуру, тому вони можуть бути легко вилучені і допомогти заповнити сайт документації.

коментар структура RDoc є надзвичайно успішним, використовується багатьма аналогічними документації генераторів, створених для інших мов програмування

Що нового в цьому випуску :.

• RDoc тепер може створювати файли перекладу для використання з Gettext.

Що нового у версії 4.2.0:

• RDoc тепер може створювати файли перекладу для використання з Gettext .

Що нового у версії 4.1.0 :.

• Підвищення доступності виведення HTML
• Зовнішній вигляд RDoc був оновлений.

Що нового у версії 4.0.0 :.

• Додана уцінки як підтримуваного формату
• ри тепер може показувати сторінки (README, і т.д.).
• Вилучені глобальнестан з RDoc. RDoc :: Магазин тримає дерево документації і з'єднує водія до парсером і генератора.

Що нового у версії 3.12:

• Незначні поліпшення:
• долучення DEVELOPERS документ, в якому міститься огляд того, як RDoc працює і як додавати нові функції RDoc.
• Поліпшення назву для виведення HTML, щоб включити --title в назві елемента.
• RDoc --pipe тепер розуміє --markup.
• RDoc тепер підтримує ІРЦ-схему гіперпосилань.
• Виправлення помилок:
• Виправлено назву на HTML-виводу для сторінок.
• Виправлена ​​розбір без відступу Heredoc.
• Виправлена ​​парсинг% мас [] та інші% літерали.
• Виправлена ​​заміна стрілка на виході HTML munging оператор космічного корабля.

немає
• Стенографічний секції з Єврорадіо, які відповідають рубін коду білий список більше не підсвіченого.
• Лінія закінчень на вікнах нормалізуються відразу після читання з binmode.
• RDoc краще розуміє директиви для коментарів. Коментар директиви тепер можна знайти в будь-якому місці в багаторядкові коментарі.
• Tidy посилання на методи показати етикетку ще раз.

Тепер
• RDoc :: Parser :: C можна знайти коментарі безпосередньо над rb_define_class_under.
• В RDoc, Backspace і AnSi форматування, етикетки і замітки без тіла тепер відображаються.
• В RDoc, Backspace і AnSi форматування, вільне місце між етикеткою або записки і товстої кишки тепер роздягнули.

Що нового у версії 3.11:

• Виправлення помилок:
• Уникайте розбору ТЕГИ файлів, включених в дорогоцінні камені.

Що нового у версії 3.9.2:

• Виправлена ​​помилка:
• ослаблені TIDYLINK регулярний вираз, щоб будь-який зміст в розділі посилання, як: & # x3c; тт & # x3e; {Foo} [RDoc-посилань: SomeClass] & # x3c; / тт & # x3e;
• У вихідних заголовків HTML увінчані на & # x3c; тт & # x3e; & # x3c; h6 & # x3e; & # x3c; / тт & # x3e; ще раз.

Що нового у версії 3.9.1:

• Виправлення помилок:
• Виправлена ​​помилка RDoc :: Markup аналізатор для заголовка, за яким слід нетекстового лексеми.
• Виправлена ​​помилка RDoc :: Markup :: ToHtmlCrossref # gen_url для ні - & # x3c; тт & # x3e; RDoc-вих & # x3c; / тт & # x3e; посилання.
• повідомлення про помилку Fix URL, коли відбувається збій RDoc.

Що нового у версії 3.8:

• Незначні поліпшення:
• RDoc :: Parser :: C тепер може виявити методи ENV і ФГДД.
• RDoc :: Parser :: C тепер знає про rb_cSocket і rb_mDL.
• Виправлення помилок:
• Оновлення об'єкта в з.п. сховище даних з новими даними тепер знімає методи, включає в себе, константи і псевдоніми.

Що нового у версії 3.7:

• Незначні поліпшення:
• Нова директива: категорія: яка дозволяє методи бути згруповані в розділи більш акуратно. Див RDoc :: Розмітка для деталей.
• Document-клас для RDoc :: Parser :: C тепер підтримує Foo :: CONST, а також Уст.
• Вихід метод Р.І. тепер розділений комами список, коли відображається в інтерактивному режимі.
• RDoc :: ClassModule # зливатися прямо зараз воліє інформацію аргументу протягом приймача (тепер він веде себе як Hash # зливатися! Замість зворотної Hash # злиття!).
• RDoc :: Розмітка # перетворити тепер приймає RDoc :: розмітці :: екземпляр документа
• RDoc тепер має код для генерації RDoc Р.І. даних, коли дорогоцінні камені установки
• Додана RDoc :: RDoc :: скидання
• Додана RDoc :: CodeObject # file_name
• Виправлення помилок:

немає
• Р.І. більше не падає при спробі завершити рівнину
• RDoc :: Parser :: Рубі більше не їсть, коли зміст = почати / = кінцевий блоки документації супроводжуються пункту зафіксованих. Випуск № 41 від режиму найбільшого сприяння.
• RDoc :: Markup :: Formatter і підкласи тепер дозволяють необов'язкову + розмітку + параметр для додавання користувальницької розмітки. Приклад в RDoc :: Markup :: Formatter тепер буде працювати.
• RDoc :: Тепер Parser :: C може розрізняти методи класу і методи, наприклад, в документі-методу.
• RDoc Тепер кодує імена файлів в кодуванні виведення.

немає <літій> покоління Р.І. дані для методу псевдонімами більше не дублює клас в #full_name