RDoc

RDoc során két fő részből áll.

Egy rdoc , egy segédprogram generáló HTML dokumentációt. A második az ri , egy eszköz létrehozására dokumentáció a Ruby parancssori felületet.

Ahhoz, hogy megfelelően használja RDoc, a fejlesztő meg kell változtatni, ahogy hozzáteszi észrevételeket a forráskódot.

RDoc használ egy adott forráskód kommentek szerkezet, így könnyen kinyerhető, és segít feltölti a dokumentációban található.

RDoc megjegyzése szerkezete rendkívül sikeres, hogy sokan használják, hasonló dokumentáció generátorok létrehozott más programozási nyelveket.

Mi az új ebben a kiadásban:

• RDoc is gyárt fordítási fájl használható gettext.

Mi az új 4.2.0:

• RDoc is gyárt fordítási fájl használható gettext .

Mi az új verzió 4.1.0:

• Továbbfejlesztett elérhetőségének HTML kimenetet.
• A megjelenés RDoc frissült.

Mi az új verzió 4.0.0:

• Added Markdown a támogatott formátum.
• ri most mutatni oldalak (README, stb.).
• Visszavonta a globális állam RDoc. RDoc :: Store tartja a dokumentációt fa, és csatlakozik a vezető az elemzők, és a generátort.

Mi az új verzió 3,12:

• Kisebb fejlesztések:
• Added DEVELOPERS dokumentum, amely tartalmaz egy áttekintést arról, hogy RDoc működik és hogyan, hogy új funkciókat RDoc.
• Továbbfejlesztett címet HTML kimenetet tartalmazza --title a title elem.
• rdoc --pipe most már érti --markup.
• RDoc már támogatja irc-rendszer hivatkozásokat.
• Bug javítások:
• Fix cím HTML kimenet lapok.
• Fix elemzésekor nem tagolt heredoc.
• Fix elemzésekor% w [] és a többi% literálok.
• Fix nyíl csere HTML kimenet munging az űrhajó operátor.
• Verbatim szakaszok ERB, amelyek megfelelnek a rubin kód whitelist már nem szintaxis-kiemelve.
• sorvégződések ablakokra normalizált olvasása után azonnal a binmode.
• RDoc jobban megérti irányelvek megjegyzéseket. Megjegyzés irányelvek már sehol többsoros megjegyzéseket.
• Tidy linkeket módszerekkel mutassuk meg a címkét újra.
• RDoc :: Parser :: C most meg észrevételeit közvetlenül felette rb_define_class_under.
• rdoc, backspace és ANSI formázóknál, címkék és megjegyzések nélkül szervek most látható.
• rdoc, backspace és ANSI formázóknál, szóközök között címke vagy feljegyzés, a vastagbelet most megfosztották.

Mi az új verzió 3.11:

• Bug javítások:
• Kerülje elemzés CÍMKÉK fájlokat tartalmazza drágaköveket.

Mi az új verzió 3.9.2:

• Hibajavítás:
• lazított TIDYLINK regexp hogy bármilyen tartalmat a link fejezetben, mint például: & # X3c; tt & # x3e {foo} [rdoc-ref: SomeClass] & # X3c; / tt & # x3e;
• A HTML kimenet fejezetek felső határa & # X3c; tt & # x3e; & # X3c; h6 & # x3e; & # X3c; / tt & # x3e; újra.

Mi az új verzió 3.9.1:

• Bug javítások:
• Fix RDoc :: Markup elemző egy fejlécet, majd egy nem-szöveges azonosító.
• Fix RDoc :: Markup :: ToHtmlCrossref # gen_url nem - & # X3c; tt & # x3e; rdoc-ref & # X3c; / tt & # x3e; linkek.
• Fix hibajelentést URL amikor rdoc összeomlik.

Mi az új verzió 3.8:

• Kisebb fejlesztések:
• RDoc :: Parser :: C már felfedezni módszerek ENV és argF.
• RDoc :: Parser :: C őt ismeri rb_cSocket és rb_mDL.
• Bug javítások:
• frissítése objektum egy ri adattár az új adatok eltávolítja módszereket tartalmazza, állandók és alias.

Mi az új verzió 3.7:

• Kisebb fejlesztések:
• Új irányelv: kategória: amely lehetővé teszi a módszerek kell csoportosítani szakaszok tisztábban. Lásd RDoc :: Markup részletekért.
• Dokumentum-osztály RDoc :: Parser :: C most már támogatja a Foo :: CONST valamint const.
• ri módszer kimenet most egy vesszővel elválasztott lista, amikor megjelenik interaktívan.
• RDoc :: ClassModule # egyesíti őt preferálja érvelés információt át a vevő (most úgy viselkedik, mint a Hash # egyesíteni! Helyett visszafelé Hash # merge!).
• RDoc :: Markup # átalakítani most elfogad RDoc :: Markup :: dokumentum például
• RDoc birtokolja kód generálására RDoc és ri adatokat, ha drágaköveket install
• Added RDoc :: RDoc :: visszaállítása
• Added RDoc :: CodeObject # fájlnév
• Bug javítások:
• ri nem omlik össze, amikor megpróbálja befejezni egy sima
• RDoc :: Parser :: Ruby már nem eszik a tartalmat, ha = kezdődik / = végén dokumentáció blokk követi egy dokumentálható elemet. Kérdés # 41 által MFN.
• RDoc :: Markup :: formázó és alosztályok most már lehetővé teszi egy opcionális + jelölés + paraméter hozzáadása az egyéni jelölést. A példa RDoc :: Markup :: formázó fog működni.
• RDoc :: Parser :: C most megkülönböztetni osztály módszerek és metódusai a dokumentum-módszer.
• RDoc most kódolja fájlneveket a kimeneti kódolás.
• ri adatok generációs módszer álnevek nem ismétli az osztály #full_name