RDoc

RDoc is gemaak van twee groot dele.

Die een is rdoc , 'n nut vir die opwekking van HTML dokumentasie. Die tweede is ri , 'n instrument vir die skep van dokumentasie vir die Ruby command-line interface.

Om in staat wees om behoorlik te gebruik RDoc, moet die ontwikkelaar die manier waarop hy voeg kommentaar by sy bron-kode verander.

RDoc gebruik 'n spesifieke bron-kode kommentaar struktuur, sodat hulle kan maklik verkry word en help vul die dokumentasie webwerf.

RDoc se kommentaar struktuur is uiters suksesvolle, wat gebruik word deur baie soortgelyke dokumentasie kragopwekkers geskep vir ander programmeertale

Wat is nuut in hierdie release:.

• RDoc kan nou produseer vertaling lêers vir gebruik met gettext.

Wat is nuut in weergawe 4.2.0:

• RDoc kan nou produseer vertaling lêers vir gebruik met gettext .

Wat is nuut in weergawe 4.1.0:.

• Verbeterde toeganklikheid van HTML uitvoer
• Die voorkoms van RDoc is opgedateer.

Wat is nuut in weergawe 4.0.0:.

• Toegevoegde Afprijzingsmanager as 'n ondersteunde formaat
• ri kan nou bladsye wys (README, ens.).
• Verwyder globale toestand van RDoc. RDoc :: Store hou die dokumentasie boom en verbind die bestuurder om die parsers en kragopwekker.

Wat is nuut in weergawe 3,12:

• Klein verbeterings:
• Toegevoegde ONTWIKKELAARS dokument wat 'n oorsig van hoe RDoc werk en hoe om nuwe funksies by te voeg aan RDoc bevat.
• Verbeterde titel vir HTML uitvoer om --title in die titel element insluit.
• rdoc --pipe verstaan ​​nou --markup.
• RDoc ondersteun nou IRC-skema hiperskakels.
• Bug fixes:
• Vaste titel op HTML uitvoer vir bladsye.
• Vaste ontleding van nie-ingekeep HEREDOC.
• Vaste ontleding van% w [] en ander% vasgekodeerde.
• Vaste pyl vervanging in HTML uitvoer munging die ruimtetuig operateur.
• Verbatim afdelings met ERB wat ooreenstem met die Ruby-kode witlys nie meer sintaksis-uitgelig.
• Line eindpunte op vensters word onmiddellik genormaliseer na die lees met binmode.
• RDoc beter verstaan ​​voorskrifte vir kommentaar. Kommentaar riglyne kan nou enige plek in 'n multi-line kommentaar gevind word nie.
• Tidy skakels na metodes te wys die etiket weer.
• RDoc :: Parser :: C kan nou kommentaar direk bokant rb_define_class_under.
• In rdoc, Backspace en ANSI formatters, byskrifte en notas sonder liggame is nou getoon.
• In rdoc, Backspace en ANSI formatters, witspasie tussen etiket of noot en die kolon is nou gestroop.

Wat is nuut in weergawe 3,11:

• Bug fixes:
• Vermy die ontleding van TAGS lêers in juwele.

Wat is nuut in weergawe 3.9.2:

• bugfix:
• losgemaak TIDYLINK regexp om enige inhoud in die skakel gedeelte soos toelaat: & # x3c; tt & # x3e; {cat} [rdoc-ref: SomeClass] & # x3c; / tt & # x3e;
• In HTML uitvoer opskrifte beperk tot & # x3c; tt & # x3e; & # x3c; H6 & # x3e; & # x3c; / tt & # x3e; weer.

Wat is nuut in weergawe 3.9.1:

• Bug fixes:
• Fix RDoc :: Markup parser vir 'n kop gevolg deur 'n nie-teks teken.
• Fix RDoc :: Markup :: ToHtmlCrossref # gen_url vir nie - & # x3c; tt & # x3e; rdoc-ref & # x3c; / tt & # x3e; skakels.
• Fix fout raporteer URL wanneer rdoc ineenstort.

Wat is nuut in weergawe 3.8:

• Klein verbeterings:
• RDoc :: Parser :: C kan nou ontdek metodes op ENV en ARGF.
• RDoc :: Parser :: C weet nou oor rb_cSocket en rb_mDL.
• Bug fixes:
• Opdatering voorwerp in 'n ri data stoor met 'n nuwe data nou verwyder metodes, sluit, konstantes en aliasse.

Wat is nuut in weergawe 3.7:

• Klein verbeterings:
• New aanwysing: kategorie: waarmee metodes meer skoon te gegroepeer in afdelings. Sien RDoc :: Markup vir meer inligting.
• Document-klas vir RDoc :: Parser :: C ondersteun nou Foo :: CONST asook CONST.
• ri metode uitset is nou 'n komme geskeide lys wanneer interaktief vertoon.
• RDoc :: ClassModule # saamsmelt nou verkies inligting die argument se oor die ontvanger se (nou optree soos Hash # saamsmelt! In plaas van 'n agteruit Hash # saamsmelt!).
• RDoc :: Markup # omskep nou aanvaar 'n RDoc :: Markup :: Document byvoorbeeld
• RDoc besit nou die kode vir die opwekking van RDoc en ri data wanneer juwele installeer
• Bygevoeg RDoc :: RDoc :: herstel
• Bygevoeg RDoc :: CodeObject # FILE_NAME
• Bug fixes:
• ri nie meer ineenstortings tydens 'n poging om 'n vlakte voltooi
• RDoc :: Parser :: Ruby nie meer eet inhoud toe = begin / = einde dokumentasie blokke word gevolg deur 'n documentable item. Reik # 41 deur MFN.
• RDoc :: Markup :: Formatter en subklasse nou toelaat dat 'n opsionele + opmaak + parameter vir die toevoeging van persoonlike opmaak. Die voorbeeld in RDoc :: Markup :: Formatter sal nou werk.
• RDoc :: Parser :: C kan nou onderskei tussen klas metodes en byvoorbeeld metodes in Document-metode.
• RDoc kodeer nou lêername in die uitvoer kodering.
• ri Gegewens opgestel vir metode aliasse dupliseer nie meer die klas in #full_name