RDoc

RDoc se skládá ze dvou hlavních částí.

Jednou z nich je rdoc , nástroj pro generování HTML dokumentaci. Druhým důvodem je ri , nástroj pro vytváření dokumentace pro rozhraní příkazového řádku Ruby.

Aby bylo možné správně používat RDoc, developer musí změnit způsob, jakým se přidává komentáře do svého zdrojového kódu.

RDoc používá specifický zdrojový kód komentáře strukturu, takže je lze snadno extrahovat a pomáhají naplnit Site Documentation.

RDoc poznámka struktura je velmi úspěšný, používá mnoho podobných generátor dokumentace vytvořené pro jiné programovací jazyky

Co je nového v této verzi:.

• RDoc nyní může produkovat překladové soubory pro použití s ​​gettext.

Co je nového ve verzi 4.2.0:

• RDoc nyní může produkovat překladové soubory pro použití s ​​gettext .

Co je nového ve verzi 4.1.0:.

• Lepší dostupnost HTML výstupu
• Vzhled RDoc byla aktualizována.

Co je nového ve verzi 4.0.0:.

• z přidané Markdown jako podporovaném formátu
• ri se nyní mohou zobrazovat stránky (README, atd.).
• Odstraněno globální stav z RDoc. RDoc :: Store drží stromu dokumentace a spojuje řidiče na analyzátory a generátoru.

Co je nového ve verzi 3.12:

• Drobná vylepšení:
• z přidané VÝVOJÁŘI dokument, který obsahuje přehled o tom, jak RDoc funguje a jak přidat nové funkce do RDoc.
• Lepší název pro výstup HTML zahrnout --title v názvu prvku.
• rdoc --pipe nyní chápe --markup.
• RDoc nyní podporuje IRC schéma hypertextové odkazy.
• Opravy chyb:
• Pevná titul na výstupu HTML pro stránky.
• Opraveno parsování non-členitého HEREDOC.
• Opraveno parsování% w [] a dalších% literály.
• Pevné náhradní šipku v HTML výstupu munging provozovatele lodi.
• Verbatim sekcí ERB, které odpovídají ruby ​​kódu whitelist jsou již syntaxe zvýrazněny.
• konce řádku na oknech jsou normalizovány bezprostředně po čtení binmode.
• RDoc lépe chápe směrnic pro komentáře. Směrnice Komentář lze nyní nalézt kdekoli v vícelinkovém komentáře.
• uklizené odkazy na metody, ukažte toto označení znovu.
• RDoc :: Analyzátoru :: C nyní mohou najít komentáře přímo nad rb_define_class_under.
• V rdoc, backspace a ANSI formátovačů, jsou nyní zobrazeny popisky a poznámky bez těl.
• V rdoc, backspace a ANSI formátovačů, mezery mezi štítek nebo poznámku a tlustého střeva je nyní odstraněny.

Co je nového ve verzi 3.11:

• Opravy chyb:
• Vyvarujte se rozebrat tagy soubory zahrnuté v drahokamy.

Co je nového ve verzi 3.9.2:

• Oprava chyby:
• uvolnil TIDYLINK regexp, aby jakýkoliv obsah v sekci spojení jako: & # x3c; tt & # x3e; {foo} [rdoc-ref: SomeClass] & # x3c; / tt & # x3e;
• V výstupních okruhů HTML jsou omezeny na & # x3c; tt & # x3e; & # x3c; h6 & # x3e; & # x3c; / tt & # x3e; znovu.

Co je nového ve verzi 3.9.1:

• Opravy chyb:
• Fix RDoc :: Markup parser pro záhlaví následuje netextového tokenu.
• Fix RDoc :: Markup :: ToHtmlCrossref # gen_url pro non - & # x3c; tt & # x3e, rdoc-ref & # x3c; / tt & # x3e; odkazy.
• Fix bug report URL, když rdoc dojde k chybě.

Co je nového ve verzi 3.8:

• Drobná vylepšení:
• RDoc :: Analyzátoru :: C nyní mohou objevovat metody na ENV a ARGF.
• RDoc :: Parser :: C nyní ví o rb_cSocket a rb_mDL.
• Opravy chyb:
• Aktualizace objekt v ri úložiště dat s novými daty nyní odstraňuje metody, zahrnuje konstanty a aliasů.

Co je nového ve verzi 3.7:

• Drobná vylepšení:
• Nová směrnice: kategorie: která umožňuje metody, které mají být seskupeny do úseků čistěji. Viz RDoc :: značkami podrobnosti.
• Dokument-class pro RDoc :: Parser :: C nyní podporuje Foo :: CONST stejně jako Konst.
• metoda ri výstup je nyní seznam oddělený čárkami při zobrazení interaktivně.
• RDoc :: ClassModule # sloučit nyní preferuje informace argumentu je přes receiveru (to teď chová jako Hash # sloučit! Namísto zpětné Hash # korespondence!).
• RDoc :: značkovací # převést nyní přijímá RDoc :: Markup :: instance dokumentu
• RDoc nyní vlastní kód pro generování RDoc a RI dat při drahokamy instalace
• Přidal RDoc :: RDoc :: resetovat
• Přidal RDoc :: CodeObject # file_name
• Opravy chyb:
• RI již dojde k chybě při pokusu o dokončení plain
• RDoc :: Analyzátoru :: Ruby již žere obsah kdy začne = / = konec dokumentace bloky jsou následovány doložitelný položky. Vydávat # 41 podle DNV.
• RDoc :: Markup :: Formatter a podtřídy nyní umožňují volitelnou + značky + parametr pro přidání vlastní značky. Příklad v RDoc :: Markup :: Formatter bude nyní pracovat.
• RDoc :: Analyzátoru :: C nyní mohou rozlišovat mezi metodami tříd a metod například v dokumentu metodou.
• RDoc nyní kóduje názvy souborů v kódování výstupu.
• generování ri údaje pro metodu aliasů již duplikuje třídu #full_name