RDoc

RDOC bestaat uit twee grote delen.

Een daarvan is rdoc , een hulpprogramma voor het genereren van HTML-documentatie. De tweede is ri , een tool voor het maken van documentatie voor de Ruby command-line interface.

Om goed te kunnen gebruiken RDOC, moet de ontwikkelaar de manier waarop hij voegt opmerkingen naar zijn source code te wijzigen.

RDOC maakt gebruik van een specifieke bron code opmerkingen structuur, zodat ze gemakkelijk kunnen worden gewonnen en helpen bevolken de documentatie website.

RDOC de opmerking structuur is zeer succesvol is, wordt gebruikt door vele soortgelijke documentatiegenerator gemaakt voor andere programmeertalen

Wat is nieuw in deze release:.

• RDOC kunnen produceren nu vertaling bestanden voor gebruik met gettext.

Wat is nieuw in versie 4.2.0:

• RDOC kunnen produceren nu vertaling bestanden voor gebruik met gettext .

Wat is nieuw in versie 4.1.0:.

• Een betere toegankelijkheid van de HTML-uitvoer
• Het uiterlijk van RDOC is bijgewerkt.

Wat is nieuw in versie 4.0.0:.

• Toegevoegd Markdown als een ondersteund formaat
• ri kunt nu pagina's weer te geven (README, enz.).
• Removed globale toestand van RDOC. RDOC :: Store houdt de documentatie boom en verbindt de bestuurder de parsers en generator.

Wat is nieuw in versie 3.12:

• Minor verbeteringen:
• Toegevoegd DEVELOPERS document dat een overzicht van hoe RDOC werkt en hoe om nieuwe functies toe te voegen aan RDOC bevat.
• Een betere titel voor HTML uitvoer naar --title in de titel element op te nemen.
• rdoc --pipe begrijpt nu --markup.
• RDOC ondersteunt nu irc-regeling hyperlinks.
• Bug fixes:
• Vaste titel op HTML-uitvoer voor pagina's.
• Vaste parsing van niet-ingesprongen heredoc.
• Vaste parsing van% w [] en andere% letterlijke.
• Fixed pijl vervanging in HTML-uitvoer munging het ruimteschip operator.
• Verbatim secties met ERB die overeenkomen met de ruby ​​code whitelist niet langer syntax-gemarkeerd.
• Line uitgangen op de ramen worden onmiddellijk genormaliseerd na het lezen met binmode.
• RDOC beter begrijpt richtlijnen voor commentaar. Comment richtlijnen kunnen nu overal in multi-line commentaar te vinden.
• Tidy links naar methoden etiket tonen opnieuw.
• RDOC :: Parser :: C kunnen nu commentaar direct boven rb_define_class_under.
• In RDOC, backspace en ansi formatters, labels en notities zonder lichamen worden nu getoond.
• In RDOC, backspace en ansi formatters, witruimte tussen label of een nota en de dikke darm is nu gestript.

Wat is nieuw in versie 3.11:

• Bug fixes:
• Vermijd het ontleden TAGS bestanden opgenomen in edelstenen.

Wat is nieuw in versie 3.9.2:

• Bug fix:
• Losdraaien TIDYLINK regexp om alle content in de link sectie zoals toestaan: & # X3c; tt & # x3e; {foo} [rdoc-ref: SomeClass] & # X3c; / tt & # x3e;
• In HTML-uitvoer koppen worden afgetopt op & # X3c; tt & # x3e; & # X3c; h6 & # x3e; & # X3c; / tt & # x3e; opnieuw.

Wat is nieuw in versie 3.9.1:

• Bug fixes:
• Fix RDOC :: Markup parser voor een kop, gevolgd door een niet-tekst token.
• Fix RDOC :: Markup :: ToHtmlCrossref # gen_url voor niet - & # X3c; tt & # x3e; rdoc-ref & # X3c; / tt & # x3e; koppelingen.
• Fix bug report URL wanneer rdoc crasht.

Wat is nieuw in versie 3.8:

• Minor verbeteringen:
• RDOC :: Parser :: C kunnen nu ontdekken methoden op ENV en ARGF.
• RDOC :: Parser :: C weet nu over rb_cSocket en rb_mDL.
• Bug fixes:
• Het bijwerken van het object in een ri data winkel met nieuwe gegevens nu verwijdert methoden, omvat, constanten en aliassen.

Wat is nieuw in versie 3.7:

• Minor verbeteringen:
• Nieuwe richtlijn: categorie: die het mogelijk maakt methoden schoner te worden gegroepeerd in secties. Zie RDOC :: Markup voor meer informatie.
• Document-klasse voor RDOC :: Parser :: C ondersteunt nu Foo :: CONST evenals CONST.
• ri methode uitgang is nu een door komma's gescheiden lijst wanneer interactief weergegeven.
• RDOC :: klassemodule # fuseren nu de voorkeur aan informatie over het argument in de loop van de ontvanger (het nu gedraagt ​​zich als Hash # fuseren! In plaats van achteruit Hash # merge!).
• RDOC :: Markup # zetten nu accepteert een RDOC :: Markup :: Document bijvoorbeeld
• RDOC is nu eigenaar van de code voor het genereren van RDOC en ri gegevens wanneer edelstenen te installeren
• Toegevoegd RDOC :: RDOC :: reset
• Toegevoegd RDOC :: CodeObject # file_name
• Bug fixes:
• RI Geen meer crasht bij een poging om een ​​duidelijke voltooien
• RDOC :: Parser :: Ruby niet meer eet inhoud wanneer = begin / einde = documentatie blokken worden gevolgd door een documenteerbare punt. Kwestie # 41 door MFN.
• RDOC :: Markup :: Formatter en subklassen nu toe dat een optionele + markup + parameter voor het toevoegen van aangepaste opmaak. Het voorbeeld in RDOC :: Markup :: Formatter zal nu moeten werken.
• RDOC :: Parser :: C kan nu onderscheid maken tussen de klasse methoden en bijvoorbeeld methoden in Document-methode.
• RDOC codeert nu bestandsnamen in de uitvoer codering.
• ri data genereren voor methode aliassen dupliceert niet meer de klas in #full_name