RDoc

RDoc består av to hoveddeler.

En er rdoc , et verktøy for å generere HTML-dokumentasjon. Den andre er ri , et verktøy for å lage dokumentasjon for Ruby kommandolinje-grensesnitt.

For å kunne riktig bruk RDoc, må utvikleren endre måten han legger kommentarer til sin kildekoden.

RDoc bruker en bestemt kildekoden kommentarer struktur, slik at de lett kan trekkes ut og hjelpe fylle dokumentasjonen nettstedet.

RDoc kommentar struktur er svært vellykket, blir brukt av mange lignende dokumentasjon generatorer som er opprettet for andre programmeringsspråk

Hva er nytt i denne utgaven.

• RDoc kan nå produsere oversettelsesfiler for bruk med gettext.

Hva er nytt i versjon 4.2.0:

• RDoc kan nå produsere oversettelsesfiler for bruk med gettext .

Hva er nytt i versjon 4.1.0.

• Bedre tilgjengelighet av HTML-utgang
• Utseendet RDoc er oppdatert.

Hva er nytt i versjon 4.0.0.

• Lagd Markdown som et format som støttes
• ri kan nå vise sider (README, osv.).
• Fjernet global tilstand fra RDoc. RDoc :: Butikk holder dokumentasjon treet og kobler føreren til parsere og generator.

Hva er nytt i versjon 3.12:

• Mindre forbedringer:
• Lagd utviklere dokument som inneholder en oversikt over hvordan RDoc fungerer og hvordan legge til nye funksjoner til RDoc.
• Forbedret tittel for HTML-utgang for å inkludere --title i tittelen element.
• rdoc --pipe forstår nå --markup.
• RDoc støtter nå irc-ordningen hyperkoblinger.
• Feilrettinger:
• Fast tittel på HTML-utgang for sider.
• Fast analyseringen av ikke-innrykket HEREDOC.
• Fast analyseringen av% w [] og andre% litteraler.
• Fast pil erstatning i HTML-utgang munging romskipet operatør.
• Verbatim seksjoner med ERB som samsvarer med rubin kode hviteliste er ikke lenger syntaks-merket.
• Linje avslutninger på vinduene er normalisert umiddelbart etter å ha lest med binmode.
• RDoc bedre forstår direktiver for kommentarer. Kommentar direktivene kan nå bli funnet overalt i flere linjer kommentarer.
• Tidy linker til metoder vis etiketten på nytt.
• RDoc :: parser :: C kan nå finne kommentarer direkte over rb_define_class_under.
• I rdoc, tilbake og ansi formatters, etiketter og notater uten kropper er nå vist.
• I rdoc, tilbake og ansi formatters, mellomrom mellom etikett eller notat og tykktarmen er nå strippet.

Hva er nytt i versjon 3.11:

• Feilrettinger:
• Unngå parsing Søkeord Filer inkludert i edelstener.

Hva er nytt i versjon 3.9.2:

• Bug fix:
• løsnet TIDYLINK regexp å tillate noe innhold i linken delen som: & # X3c; tt & # x3e; {foo} [rdoc-ref: SomeClass] & # X3c; / tt & # x3e;
• I HTML-utgang overskrifter er begrenset oppad til & # X3c; tt & # x3e; & # X3c; h6 & # x3e; & # X3c; / tt & # x3e; på nytt.

Hva er nytt i versjon 3.9.1:

• Feilrettinger:
• Fix RDoc :: Markup parser for en header etterfulgt av en ikke-tekstlig token.
• Fix RDoc :: Markup :: ToHtmlCrossref # gen_url for ikke - & # X3c; tt & # x3e; rdoc-ref & # X3c; / tt & # x3e; lenker.
• Fix feilrapport URL når rdoc krasjer.

Hva er nytt i versjon 3.8:

• Mindre forbedringer:
• RDoc :: parser :: C kan nå finne metoder på ENV og argF.
• RDoc :: parser :: C vet nå om rb_cSocket og rb_mDL.
• Feilrettinger:
• Oppdatering objekt i en ri datalager med nye data nå fjerner metoder, inkluderer, konstanter og aliaser.

Hva er nytt i versjon 3.7:

• Mindre forbedringer:
• Ny direktiv Kategori: som gjør at metoder for å bli gruppert i seksjoner mer renslig. Se RDoc :: Markup for detaljer.
• Dokument-klassen for RDoc :: parser :: C støtter nå Foo :: CONST samt CONST.
• ri metode produksjonen er nå en kommaseparert liste når den vises interaktivt.
• RDoc :: ClassModule # fusjonere nå foretrekker argumentet informasjon over mottakerens (det nå oppfører seg som Hash # flette! I stedet for en baklengs Hash # flettingen!).
• RDoc :: Markup # konvertere nå godtar en RDoc :: Markup :: Dokument eksempel
• RDoc nå eier koden for å generere RDoc og ri data når gems installere
• Lagt RDoc :: RDoc :: null
• Lagt RDoc :: CodeObject # filnavn
• Feilrettinger:
• RI krasjer ikke lenger når du forsøker å fullføre en vanlig
• RDoc :: parser :: Ruby ikke lenger spiser innhold når = begin / = end dokumentasjon blokkene blir etterfulgt av en dokumenterbar element. Issue # 41 av MFN.
• RDoc :: Markup :: Atter og underklasser nå tillate en valgfri + markering + parameter for å legge til egendefinert markup. Eksemplet i RDoc :: Markup :: Atter vil nå arbeide.
• RDoc :: parser :: C kan nå skille mellom klassen metoder og instansmetoder i Dokument-metoden.
• RDoc koder nå filnavn i produksjon koding.
• ri datagenerering for metode aliaser ikke lenger dupliserer klassen i #full_name