RDoc

RDOC er lavet af to hoveddele.

Den ene er RDOC , et værktøj til at generere HTML dokumentation. Den anden er ri , et værktøj til at skabe dokumentation for Ruby kommandolinje.

For at være i stand til korrekt at bruge RDOC, skal bygherren ændre den måde, tilføjer han kommentarer til sin kildekode.

RDOC bruger en bestemt kildekode kommentarer struktur, så de let kan udvindes og hjælpe befolke dokumentation webstedet.

RDOC kommentar struktur er en stor succes, der bruges af mange lignende dokumentation generatorer skabt til andre programmeringssprog

Hvad er nyt i denne udgivelse:.

• RDOC kan nu producere oversættelse filer til brug med gettext.

Hvad er nyt i version 4.2.0:

• RDOC kan nu producere oversættelse filer til brug med gettext .

Hvad er nyt i version 4.1.0:.

• Forbedret adgang til HTML-output
• Udseendet af RDOC er blevet opdateret.

Hvad er nyt i version 4.0.0:.

• Tilføjet Markdown som et understøttet format
• ri kan nu vise sider (README osv.).
• Fjernet global tilstand fra RDOC. RDOC :: Store holder dokumentation træet og forbinder føreren til parsere og generator.

Hvad er nyt i version 3.12:

• Mindre forbedringer:
• Tilføjet udviklere dokument, der indeholder en oversigt over, hvordan RDOC fungerer, og hvordan at tilføje nye funktioner til RDOC.
• Forbedret titel til HTML-output til også at omfatte --title i titlen element.
• RDOC --pipe nu forstår --markup.
• RDOC understøtter nu irc-ordning hyperlinks.
• Fejlrettelser:
• Fast titel på HTML-output for sider.
• Fast parsing af ikke-indrykket HEREDOC.
• Fast parsing af% w [] og andre% konstanter.
• Fast pil udskiftning i HTML-output munging rumskibet operatør.
• Verbatim sektioner med ERB, der matcher rubin kode whitelist ikke længere syntaks-fremhævet.
• Linjeslut på vinduer normaliseres umiddelbart efter at have læst med binmode.
• RDOC bedre forstår direktiver for kommentarer. Kommentar direktiver kan nu findes overalt i flere linjer kommentarer.
• Tidy links til metoder vis etiketten igen.
• RDOC :: Parser :: C kan nu finde kommentarer direkte over rb_define_class_under.
• I RDOC, backspace og ANSI formatere, etiketter og noter uden organer vises nu.
• I RDOC, backspace og ANSI formatere, blanke mellem etiket eller note og tyktarmen er nu strippet.

Hvad er nyt i version 3.11:

• Fejlrettelser:
• Undgå parsing TAGS filer inkluderet i ædelstene.

Hvad er nyt i version 3.9.2:

• Bug fix:
• Løsnet TIDYLINK regexp at tillade nogen indhold i linket afsnittet som: & # X3C; tt & # x3e; {foo} [RDOC-ref: SomeClass] & # X3C; / tt & # x3e;
• I HTML output overskrifter loft på & # X3C; tt & # x3e; & # X3C; h6 & # x3e; & # X3C; / tt & # x3e; igen.

Hvad er nyt i version 3.9.1:

• Fejlrettelser:
• Fix RDOC :: Markup parser for en header efterfulgt af en ikke-tekst token.
• Fix RDOC :: Markup :: ToHtmlCrossref # gen_url for ikke - & # X3C; tt & # x3e; RDOC-ref & # X3C; / tt & # x3e; links.
• Fix fejlrapport URL når RDOC nedbrud.

Hvad er nyt i version 3.8:

• Mindre forbedringer:
• RDOC :: Parser :: C kan nu finde metoder på ENV og argF-.
• RDOC :: Parser :: C kender nu om rb_cSocket og rb_mDL.
• Fejlrettelser:
• Opdatering af objekt i en ri datalager med nye data nu fjerner metoder, omfatter, konstanter og aliaser.

Hvad er nyt i version 3.7:

• Mindre forbedringer:
• Nyt direktiv: kategori: som gør det muligt metoder, der skal grupperes i sektioner mere rent. Se RDOC :: Markup for detaljer.
• Dokument-klasse for RDOC :: Parser :: C understøtter nu Foo :: CONST samt CONST.
• ri metode output er nu en kommasepareret liste, når der vises interaktivt.
• RDOC :: ClassModule # fusionere nu foretrækker det argument oplysninger over modtagerens (det nu opfører sig som Hash # fusionere! Stedet for en baglæns Hash # fusionere!).
• RDOC :: Markup # konvertere nu accepterer en RDOC :: Markup :: Dokument eksempel
• RDOC ejer nu koden til generering RDOC og ri data, når perler installere
• Tilføjet RDOC :: RDOC :: reset
• Tilføjet RDOC :: CodeObject # filnavn
• Fejlrettelser:
• ri ikke længere går ned, når du forsøger at fuldføre en almindelig
• RDOC :: Parser :: Ruby ikke længere spiser indhold, når = begynder / = ende dokumentation blokke efterfulgt af en dokumenterbar element. Issue # 41 af MFN.
• RDOC :: Markup :: formaterings og underklasser nu tillade en valgfri + markup + parameter for at tilføje brugerdefinerede markup. Eksemplet i RDOC :: Markup :: Formatter vil nu arbejde.
• RDOC :: Parser :: C kan nu skelne mellem klasse metoder og instansmetoder i dokument-metoden.
• RDOC nu koder filnavne i output-kodning.
• generation ri data for metode aliaser ikke længere duplikerer klasse i #full_name