RDoc

RDoc este format din două părți majore.

Unul este rdoc , un utilitar pentru generarea documentației HTML. A doua este ri , un instrument pentru crearea documentației pentru Ruby interfața linie de comandă.

Pentru a putea utiliza în mod corespunzător RDoc, dezvoltatorul trebuie să schimbe modul în care el adaugă comentarii la codul său sursă.

RDoc utilizează o sursă specifică structura comentarii de cod, astfel încât acestea să poată fi extras cu ușurință și de a ajuta popula site-ul de documentare.

RDoc Comentariul Structura este extrem de succes, fiind utilizat de mai multe generatoare de documentare similare create pentru alte limbaje de programare

Ce este nou în această versiune:.

• RDoc poate produce acum fișiere de traducere pentru a fi utilizate cu gettext.

Ce este nou în versiunea 4.2.0:

• RDoc poate produce acum fișiere de traducere pentru a fi utilizate cu gettext .

Ce este nou în versiunea 4.1.0:.

• O mai bună accesibilitate a HTML de ieșire
• Aspectul RDoc a fost actualizat.

Ce este nou în versiunea 4.0.0:.

• Adăugat Markdown ca un format acceptat
• ri pot afișa acum pagini (README, etc.).
• stare globală Eliminat din RDoc. RDoc :: Magazinul detine arborele de documentare și se conectează șoferul la analizatorilor și a generatorului.

Ce este nou în versiunea 3.12:

• Îmbunătățiri minore:
• Document Adăugat DEZVOLTATORII care conține o prezentare generală a modului în care funcționează RDoc și modul în care să adauge noi caracteristici la RDoc.
• Titlul îmbunătățit pentru HTML de ieșire pentru a include --title în elementul din titlu.
• rdoc --pipe înțelege acum --markup.
• RDoc suportă acum irc-sistem de hyperlink-uri.
• Bug stabilește:
• din titlu fix pe ieșire HTML pentru pagini.
• parsarea fixă ​​de HEREDOC non-dantelat.
• parsarea fix de% w [] și alte literali%.
• Fixed săgeata de înlocuire în HTML de ieșire munging operatorul nava spatiala.
• secțiunile Verbatim cu ERB care se potrivesc cu codul de rubin nu lista albă mai sunt sintaxa evidențiate.
• terminații de linie pe ferestrele sunt normalizate, imediat după ce a citit cu binmode.
• RDoc înțelege mai bine directivele pentru comentarii. Comentariu directivele pot fi găsite acum oriunde în comentarii cu mai multe linii.
• legături Tidy la metodele arată din nou eticheta.
• RDoc :: parser :: C pot găsi acum comentariile direct deasupra rb_define_class_under.
• În rdoc, backspace și modelatoare ansi, etichete și note fără corpuri sunt afișate acum.
• În rdoc, backspace și modelatoare ansi, între etichetă sau spații albe notă și colonului este acum indepartat.

Ce este nou în versiunea 3.11:

• Bug stabilește:
• Evitați fișiere parsare TAGS incluse în pietre.

Ce este nou în versiunea 3.9.2:

• Bug fix:
• slabite TIDYLINK regexp pentru a permite oricărui conținut în secțiunea link-ul cum ar fi: & # x3c, tt & # x3e; {foo} [rdoc-ref: SomeClass] & # x3c; / tt & # x3e;
• În pozițiile HTML de ieșire sunt limitate la & # x3c; tt & # x3e; & # x3c; h6 & # x3e; & # x3c; / tt & # x3e; din nou.

Ce este nou în versiunea 3.9.1:

• Bug stabilește:
• RDoc Fix :: analizator de marcare pentru un antet urmat de un simbol de bază non-text.
• Fix RDoc :: Markup :: ToHtmlCrossref # gen_url pentru non - & # x3c; tt & # x3e; rdoc-ref & # x3c; / tt & # x3e; link-uri.
• Fix raport de eroare pentru URL-ul atunci când se blochează rdoc.

Ce este nou în versiunea 3.8:

• Îmbunătățiri minore:
• RDoc :: parser :: C pot descoperi acum metode pe ENV și ARGF.
• RDoc :: parser :: C stie acum despre rb_cSocket și rb_mDL.
• Bug stabilește:
• Actualizarea obiectului într-un magazin de date ri cu date noi acum metode, include Îndepărtează, constante și aliasuri.

Ce este nou în versiunea 3.7:

• Îmbunătățiri minore:
• Noua directivă: categorie: care permite metode să fie grupate în secțiuni mai curat. A se vedea, RDoc :: marcare pentru detalii.
• Document de clasă pentru RDoc :: parser :: C suportă acum Foo :: CONST precum și CONST.
• de ieșire metoda RI este acum o listă separată prin virgulă, atunci când sunt afișate în mod interactiv.
• RDoc :: ClassModule # îmbinați acum preferă informații argumentul asupra receptorului (acum se comportă ca Diez # îmbinați! În loc de o înapoi Hash # îmbinare!).
• RDoc :: markup # converti acum accepta un RDoc :: Markup :: exemplu Document
• RDoc deține acum codul pentru generarea RDoc și datele RI atunci când instalați pietre
• Adăugat RDoc :: RDoc :: reset
• Adăugat # RDoc :: CodeObject file_name
• Bug stabilește:
• ri nu se mai blochează atunci când încearcă să completeze un simplu
• RDoc :: parser :: Ruby nu mai mănâncă conținut atunci când = a începe blocuri / = documentație de capăt sunt urmate de un element documentabil. Numărul # 41 de NMF.
• RDoc :: Markup :: formatorului și subclase permit acum un + marcare opțional + parametru pentru adăugarea de marcare personalizat. Exemplul din RDoc :: Markup :: formatorului va lucra acum.
• RDoc :: parser :: C pot distinge acum între metodele de clasă și metode de exemplu, în documentul-metodă.
• RDoc acum codifică nume de fișiere în codificarea de ieșire.
• generarea de date ri pentru alias-uri metodă nu mai dublează clasa în #full_name