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