RDoc

RDoc се състои от две основни части.

Едно е rdoc , една програма за генериране на HTML документация. Вторият е ри , инструмент за създаване на документация за командния ред интерфейс Ruby.

За да можете правилно да използвате RDoc, разработчикът трябва да се промени начина, по който той добавя коментари, за да му изходен код.

RDoc използва специфичен източник коментари кодови структура, така че те могат лесно да бъдат извлечени и помогне пренесат мястото на документация.

коментар структура RDoc е изключително успешен, което се използва от много подобни генератори документация, създадени за други езици за програмиране

Какво ново в тази версия:.

• RDoc сега може да произвежда превод файлове за използване с gettext.

Какво ново във версия 4.2.0:

• RDoc сега може да произвежда превод файлове за използване с gettext .

Какво ново във версия 4.1.0:.

• Подобряване на достъпността на HTML изход
• Външният вид на RDoc е актуализиран.

Какво ново във версия 4.0.0:.

• Добавено Markdown като поддържан формат
• ри може сега показват страници (README и др.).
• Removed глобална държава от RDoc. RDoc :: Магазин държи дървото документация и свързва водачът на парсъри и генератора.

Какво ново във версия 3.12:

• малки подобрения:
• документ Добавено разработчиците, който съдържа преглед на начина RDoc работи и как да се добавят нови функции към RDoc.
• Подобрена заглавие за HTML изход за включване на --title в елемент от заглавието.
• rdoc --pipe сега разбира --markup.
• RDoc вече поддържа IRC-схема хипервръзки.
• Корекции на грешки:
• Фиксиран заглавието на HTML изход за страници.
• Фиксиран разбор на не-разчленена Heredoc.
• Фиксиран разбор на% тегло [] и други% литерали.
• Фиксиран стрелка подмяна в HTML изход munging оператора на космически кораб.
• Verbatim секции с ERB, които съответстват на рубин код белия списък на вече не са синтактични-подчертани.
• Договорени окончания на прозорците са нормализира веднага след като е прочел с binmode.
• RDoc по-добре разбира, директиви за коментари. директиви коментар вече могат да бъдат намерени навсякъде в коментарите мулти-лайн.
• Tidy връзки към методи показват етикета отново.

сега
• RDoc :: Parser :: C може да намерите коментари директно над rb_define_class_under.
• В rdoc, Backspace и ANSI форматиране, етикети и бележки, без тела сега са показани.
• В rdoc, Backspace и ANSI форматиране, празно пространство между етикет или бележка и дебелото черво се сега жилки.

Какво ново във версия 3.11:

• Корекции на грешки:
• Избягвайте разбор тагове файлове, включени в скъпоценни камъни.

Какво ново във версия 3.9.2:

• Bug Fix:
• разхлаби TIDYLINK рег.израз да позволи на всеки файл в раздела за връзка като: & # x3c; TT & # x3e; {Foo} [rdoc-REF: SomeClass] & # x3c; / TT & # x3e;
• В позиции HTML изход са с таван & # x3c; TT & # x3e; & # x3c; h6 & # x3e; & # x3c; / TT & # x3e; отново.

Какво ново във версия 3.9.1:

• Корекции на грешки:
• Fix RDoc :: Markup анализатор за глава, последвана от не-текст знак на.
• Fix RDoc :: Markup :: ToHtmlCrossref # gen_url за не - & # x3c; TT & # x3e; rdoc-лит & # x3c; / TT & # x3e; връзки.
• Fix доклад за грешка URL когато rdoc катастрофи.

Какво ново във версия 3.8:

• малки подобрения:
• RDoc :: Parser :: C вече могат да открият методи за ENV и ARGF.
• RDoc :: Parser :: C сега знае за rb_cSocket и rb_mDL.
• Корекции на грешки:
• Обновяване на обекта в ри магазин данни с нови данни вече премахва методи, включва, константи и псевдоними.

Какво ново във версия 3.7:

• малки подобрения:
• New директива: категория: който позволява методи да бъдат групирани в раздели по-чисто. Вижте RDoc :: Markup за подробности.
• Document-клас за RDoc :: Parser :: C вече поддържа Foo :: CONST както CONST.
• метод ри изход в момента е разделен със запетаи списък, когато показва интерактивно.
• RDoc :: ClassModule # слеят сега предпочита информация аргумента, над приемника (той сега се държи като Hash # сливат! Вместо назад Hash # сливат!).
• RDoc :: Markup # превръщат вече приема на RDoc :: Markup :: Документ например
• RDoc вече притежава кода за генериране RDoc и РИ данни, когато камъни инсталират
• Добавен RDoc :: RDoc :: изчисти
• Добавен RDoc :: CodeObject # име_файл
• Корекции на грешки:
• РИ вече не се срива, когато се опитват да завърши един обикновен
• RDoc :: Parser :: Ruby вече не яде съдържание, когато = започват / = край документация блокове са последвани от documentable т. Брой # 41 от НОН.
• RDoc :: Markup :: Formatter и подкласове сега позволяват по избор + маркиране + параметър за добавяне на потребителски код. Примерът в RDoc :: Markup :: Formatter сега ще работи.
• RDoc :: Parser :: C вече може да се прави разлика между методите на класа и методи например в Документ-метод.
• RDoc сега кодира имена на файлове в изходния кодиране.
• поколение ри данни за метод псевдоними вече не дублира класа в #full_name