RDoc

RDoc ay gawa sa dalawang pangunahing mga bahagi.

Ang isa ay rdoc , isang utility para sa pagbuo ng HTML babasahin. Ang ikalawang ay ri , isang kasangkapan para sa paglikha ng mga babasahin para sa Ruby command-line interface.

Upang magagawang upang maayos na gamitin RDoc, ang mga developer ay dapat baguhin ang paraan niya iyon dinaragdagan ng mga komento sa kanyang source code.

RDoc ay gumagamit ng isang tiyak na pinagmulan komento code istraktura, upang maaari nilang madaling ma-nahango at tulungan populate ang dokumentasyon site.

ni RDoc kumentaryo istraktura ay lubhang matagumpay, ginagamit sa pamamagitan ng maraming mga katulad na mga babasahin generators nilikha para sa iba pang mga wika programming

Ano ang bago sa ito release:.

• RDoc ay maaari na ngayong gumawa ng mga file translation para sa paggamit sa gettext.

Ano ang bago sa bersyon 4.2.0:

• RDoc ay maaari na ngayong gumawa ng mga file translation para sa paggamit sa gettext .

Ano ang bago sa bersyon 4.1.0:.

• Pinahusay accessibility ng HTML output
• Ang hitsura ng RDoc ay na-update.

Ano ang bago sa bersyon 4.0.0:.

• Added Markdown bilang suportadong format
• ri maaari na ngayong magpakita pahina (README, atbp.).
• Inalis global estado mula RDoc. RDoc :: Store humahawak sa puno dokumentasyon at nag-uugnay sa mga driver sa parsers at generator.

Ano ang bago sa bersyon 3.12:

• Minor pagpapahusay:
• Added DEVELOPERS dokumento na naglalaman ng isang pangkalahatang-ideya ng kung paano RDoc gumagana at kung paano upang magdagdag ng mga bagong tampok upang RDoc.
• Pinahusay na pamagat para sa HTML output upang isama --title sa elemento title.
• rdoc --pipe ngayon naiintindihan --markup.
• RDoc Sinusuportahan na ngayon ng irc-scheme hyperlinks.
• Pag-aayos ng Bug:
• Fixed pamagat sa HTML output para sa mga pahina.
• Fixed pag-parse ng mga di-yupi HEREDOC.
• Fixed pag-parse ng% w [] at iba pang% literals.
• Fixed arrow kapalit sa HTML output munging ang sasakyang pangalangaang operator.
• Verbatim seksyon na may ERB na tumutugma sa ruby ​​code whitelist ay hindi na syntax-highlight.
• Line endings sa mga bintana ay normalize kaagad pagkatapos ng pagbabasa sa binmode.
• RDoc mas mahusay nauunawaan direktiba para kay. Komento direktiba ay matatagpuan na ngayon sa kahit saan sa multi-line komento.
• Tidy link sa pamamaraan ipakita ang label muli.
• RDoc :: Parser :: C ay maaaring ngayon makahanap komento nang direkta sa itaas rb_define_class_under.
• Sa rdoc, backspace at ansi formatters, mga label at mga tala na walang katawan ay ipinapakita na ngayon.
• Sa rdoc, backspace at ansi formatters, whitespace sa pagitan label o tala at ang colon ay ngayon Nakuha.

Ano ang bago sa bersyon 3.11:

• Pag-aayos ng Bug:
• Iwasan parse TAGS file na kasama sa hiyas.

Ano ang bago sa bersyon 3.9.2:

• Bug fix:
• huso TIDYLINK regexp upang payagan ang anumang nilalaman sa seksyon ng link tulad ng: & # x3c; tt & # x3e; {foo} [rdoc-ref: SomeClass] & # x3c; / tt & # x3e;
• Sa HTML output headings ay nalimitahan sa & # x3c; tt & # x3e; & # x3c; h6 & # x3e; & # x3c; / tt & # x3e; muli.

Ano ang bago sa bersyon 3.9.1:

• Pag-aayos ng Bug:
• Fix RDoc :: Markup parser para sa isang header na sinusundan ng isang non-text token.
• Fix RDoc :: Markup :: ToHtmlCrossref # gen_url para sa mga di - & # x3c; tt & # x3e; rdoc-ref & # x3c; / tt & # x3e; links.
• Fix bug report URL kapag rdoc crashes.

Ano ang bago sa bersyon 3.8:

• Minor pagpapahusay:
• RDoc :: Parser :: C ay maaari na ngayong matuklasan pamamaraan sa ENV at ARGF.
• RDoc :: Parser :: C ngayon alam tungkol rb_cSocket at rb_mDL.
• Pag-aayos ng Bug:
• Pag-update ng Bagay sa isang ri store data na may bagong data ngayon nagtanggal pamamaraan, kabilang ang, constants at alias.

Ano ang bago sa bersyon 3.7:

• Minor pagpapahusay:
• Bagong direktiba: kategorya: na nagpapahintulot sa mga paraan upang maging naka-grupo sa mga seksyon ng mas maraming nang malinis. Tingnan RDoc :: Markup para sa mga detalye.
• Document-class para RDoc :: Parser :: C Sinusuportahan na ngayon ng Foo :: CONST pati na rin CONST.
• ri paraan output ay ngayon isang comma-separated na listahan kapag ipinakita interactively.
• RDoc :: ClassModule # sumanib ngayon prefers impormasyon ang argumento sa paglipas ng receiver (ito ngayon behaves tulad Hash # sumanib! Halip ng isang paurong Hash # merge!).
• RDoc :: Markup # convert ngayon tumatanggap ng isang RDoc :: Markup :: Document Halimbawa
• RDoc ngayon nagmamay-ari ng code para sa pagbuo ng RDoc at ri data kapag hiyas install
• Idinagdag RDoc :: RDoc :: reset
• Idinagdag RDoc :: CodeObject # FILE_NAME
• Pag-aayos ng Bug:
• Ri hindi na nagka-crash kapag sinusubukan upang makumpleto ang isang plain
• RDoc :: Parser :: Ruby hindi na kumakain nilalaman kapag = simulan / = end dokumentasyon bloke ay sinusundan ng isang documentable item. Issue # 41 sa pamamagitan ng MFN.
• RDoc :: Markup ::-format at subclasses ngayon payagan ang isang opsyonal + markup + parameter para sa pagdaragdag ng custom markup. Ang halimbawa sa RDoc :: Markup ::-format ay ngayon trabaho.
• RDoc :: Parser :: C ay maaari na ngayong makilala sa pagitan ng klase pamamaraan at mga pamamaraan halimbawa sa Document-method.
• RDoc ngayon encodes mga pangalan ng file sa output encoding.
• ri ng mga dato para paraan alias hindi na nauulit ang klase sa #full_name