RDoc

RDoc on tehty kahteen osaan.

Yksi on rdoc , apuohjelma tuottaa HTML dokumentointi. Toinen on ri , työkalu luoda dokumentaatiota Ruby komentorivikäyttöliittymässä.

Jotta voit kunnolla käyttää RDoc, kehittäjä on muuttaa tapaa hän lisää kommentteja hänen lähdekoodia.

RDoc käyttää tiettyä lähdekoodia kommentteja rakenne, jotta ne voidaan helposti uuttaa ja auttaa kansoittavat dokumentaatiosivustossa.

RDoc kommentti rakenne on erittäin onnistunut, käyttävät monia samanlaisia ​​dokumentaatio generaattorit luotu muita ohjelmointikieliä.

Mikä on uusi tässä julkaisussa:

• RDoc voi nyt tuottaa käännöstiedostot käytettäväksi gettext.

Mikä on uusi versiossa 4.2.0:

• RDoc voi nyt tuottaa käännöstiedostot käytettäväksi gettext .

Mikä on uusi versiossa 4.1.0:

• Parannettu saatavuuden HTML.
• Ulkoasua RDoc on päivitetty.

Mikä on uusi versiossa 4.0.0:

• Lisätty Markdown kuin tuetussa muodossa.
• ri voidaan nyt näyttää sivut (README jne.).
• Poistettu maailmanlaajuinen tilaan RDoc. RDoc :: Store pitää asiakirjat puun ja yhdistää kuljettaja on jäsentimet ja generaattori.

Mikä on uusi versiossa 3.12:

• Minor parannuksia:
• Lisätty DEVELOPERS asiakirja, joka sisältää yleiskuvan siitä, miten RDoc toimii ja miten lisätä uusia ominaisuuksia RDoc.
• Parannettu otsikko HTML sisällyttää --title otsikossa elementti.
• rdoc --pipe nyt ymmärtää --markup.
• RDoc tukee nyt irc-järjestelmän hyperlinkkejä.
• Vikakorjauksia:
• Kiinteät otsikko HTML-sivuja.
• Kiinteä jäsennys loveamattomien HEREDOC.
• Kiinteä jäsennys% w [] ja muut% literals.
• Kiinteät nuoli korvaavan HTML lähtö munging avaruusalus operaattori.
• Verbatim jaksoon ERB jotka vastaavat Ruby koodin whitelist enää syntaksin korostettu.
• rivinloput ikkunoissa normalisoidaan heti lukemisen jälkeen kanssa binmode.
• RDoc paremmin ymmärtää direktiivien kommentteja. Kommentti direktiivien löytyvät nyt kaikkialla monirivistä kommentteja.
• Tidy linkkejä menetelmiä näytä etikettiä uudelleen.
• RDoc :: Parser :: C voi nyt löytää kommentteja suoraan yläpuolella rb_define_class_under.
• rdoc, askelpalautin ja ansi muotoilijat, etikettejä ja muistiinpanot elimet ovat nyt osoittaneet.
• rdoc, askelpalautin ja ansi muotoilijat, välilyönnillä välillä etiketti tai merkintä ja paksu- on nyt poistettu.

Mikä on uusi versiossa 3.11:

• Vikakorjauksia:
• Vältä jäsennys TAGS tiedostoja mukana helmiä.

Mikä on uusi versiossa 3.9.2:

• Virhekorjaus:
• löysätä TIDYLINK regexp sallimaan mitään sisältöä linkin jaksossa, kuten: & # X3C; tt & # x3e; {foo} [rdoc-viite: jokinLuokka] & # X3C; / tt & # x3e;
• HTML otsikot rajattu & # X3C; tt & # x3e; & # X3C; h6 & # x3e; & # X3C; / tt & # x3e; uudelleen.

Mikä on uusi versiossa 3.9.1:

• Vikakorjauksia:
• Korjaa RDoc :: Markup jäsennin otsikon, jota seuraa ei-tekstiä merkki.
• Korjaa RDoc :: Markup :: ToHtmlCrossref # gen_url ei - & # X3C; tt & # x3e; rdoc-ref & # X3C; / tt & # x3e; linkkejä.
• Korjaa vikailmoituksen URL kun rdoc kaatuu.

Mikä on uusi versiossa 3.8:

• Minor parannuksia:
• RDoc :: Parser :: C voi nyt löytää menetelmiä ENV ja argF.
• RDoc :: Parser :: C nyt tietää rb_cSocket ja rb_mDL.
• Vikakorjauksia:
• päivittäminen Object käytettäessä ri tietovarastoon uusilla tiedoilla nyt poistaa menetelmillä, kuuluvat, vakioita ja aliaksia.

Mikä on uusi versiossa 3.7:

• Minor parannuksia:
• Uusi direktiivi: luokka: mikä mahdollistaa menetelmiä ryhmiteltävä lohkoiksi puhtaammin. Katso RDoc :: Markup yksityiskohtia.
• Document-luokan RDoc :: Parser :: C tukee nyt Foo :: CONST sekä CONST.
• ri menetelmä lähtö on nyt pilkuilla eroteltu luettelo, kun näyttöön vuorovaikutteisesti.
• RDoc :: ClassModule # sulautuvat nyt parempana argumentin informaatiota vastaanottimen (se nyt käyttäytyy kuin Hash # yhdistää! Sijasta taaksepäin Hash # yhdistämisen!).
• RDoc :: Markup # muuntaa nyt hyväksyy RDoc :: Markup :: Document esimerkiksi
• RDoc omistaa nyt koodin synnyttämiseksi RDoc ja ri tiedot, kun helmiä asentaa
• lisätyt RDoc :: RDoc :: reset
• lisätyt RDoc :: CodeObject # file_name
• Vikakorjauksia:
• ri ei enää kaatuu yritettäessä suorittaa tavallinen
• RDoc :: Parser :: Ruby ei enää syö sisältöä kun = alkavat / = loppua asiakirjat lohkoja seuraa dokumentoitavissa erä. Issue # 41 MFN.
• RDoc :: Markup :: Formatter ja alaluokkien mahdollistavat nyt valinnaista + markup + parametri lisäämällä mukautettuja markup. Esimerkkiä RDoc :: Markup :: Formatter nyt toimii.
• RDoc :: Parser :: C voidaan nyt erottaa luokan menetelmiä ja esimerkiksi menetelmiä Document-menetelmällä.
• RDoc koodaa nyt tiedostonimet lähdön koodausta.
• ri tietojen tuottamista varten menetelmän aliaksia enää päällekkäinen luokan #full_name