rdoc - Online sa Cloud

PROGRAMA:

NAME

rdoc2.3 - Bumuo ng dokumentasyon mula sa mga file ng script ng Ruby

SINOPSIS

rdoc2.3 [mga opsyon] [mga pangalan...]

DESCRIPTION

Ang mga file ay na-parse, at ang impormasyong naglalaman ng mga ito ay nakolekta, bago ang anumang output ay
ginawa. Ito ay nagpapahintulot sa mga cross reference sa pagitan ng lahat ng mga file na malutas. Kung ang pangalan ay a
direktoryo, ito ay binabagtas. Kung walang tinukoy na mga pangalan, lahat ng Ruby file sa kasalukuyang
ang direktoryo (at mga subdirektoryo) ay pinoproseso.

Magagamit na mga format ng output: chm, html, ri, xml

Para sa impormasyon kung saan napupunta ang output, gamitin ang:
rdoc --help-output

Opsyon

--accessor, -A accessorname[,..]
pinaghihiwalay ng kuwit na listahan ng mga karagdagang pamamaraan ng klase na dapat tratuhin tulad ng
'attr_reader' at mga kaibigan. Maaaring ulitin ang pagpipilian. Maaaring mayroon ang bawat accessorname
Ang '=text' ay idinagdag, kung saan lumalabas ang tekstong iyon kung saan lumalabas ang r/w/rw
normal na mga accessor.

--lahat, -a
isama ang lahat ng mga pamamaraan (hindi lamang pampubliko) sa output.

--charset, -c charset
tumutukoy sa HTML character-set

--debug, -D
nagpapakita ng marami sa mga panloob na bagay

--diagram, -d
bumuo ng mga diagram na nagpapakita ng mga module at klase. Kailangan mo ng tuldok V1.8.6 o mas bago para magamit
ang --diagram na opsyon nang tama. Magagamit ang tuldok mula sa
<URL:http://www.research.att.com/sw/tools/graphviz/>.

--ibukod, -x huwaran
huwag magproseso ng mga file o direktoryo na tumutugma sa pattern. Ang mga file na tahasang ibinigay sa
command line ay hindi kailanman ibubukod.

--extension, -E bago = luma
ituring ang mga file na nagtatapos sa .new na parang nagtapos sila sa .old. Gamit ang '-E cgi=rb' will
maging sanhi ng pag-parse ng xxx.cgi bilang isang Ruby file

--mga filebox, -F
Ang mga klase ay inilalagay sa mga kahon na kumakatawan sa mga file, kung saan naninirahan ang mga klase.
Ang mga klase na ibinahagi sa pagitan ng higit sa isang file ay ipinapakita na may listahan ng mga file na nagbabahagi
sila. Tahimik na itinatapon kung ang --diagram ay hindi binigyan ng Eksperimento.

--fmt, -f formatname
itakda ang output formatter (tingnan sa ibaba).

--tulong, -h
paggamit ng pag-print.

--help-output, -O
ipaliwanag ang iba't ibang mga opsyon sa output.

--image-format, -I gif|png|jpg|jpeg
nagtatakda ng format ng imahe ng output para sa mga diagram. Maaaring png, gif, jpeg, jpg. Kung ang pagpipiliang ito
ay tinanggal, png ay ginagamit. Nangangailangan ng --diagram.

--isama, -i dir[,dir...]
itakda (o idagdag sa) ang listahan ng mga direktoryo na hahanapin kapag nagbibigay-kasiyahan :include:
mga kahilingan. Maaaring gamitin nang higit sa isang beses.

--inline-source, -S
ipakita ang method source code inline, sa halip na sa pamamagitan ng popup link.

--line-numbers, -N
isama ang mga numero ng linya sa source code

--pangunahin, -m pangalan
pangalan ang magiging unang pahina na ipapakita.

--pagsamahin, -M
kapag lumilikha ng ri output, pagsamahin ang mga naprosesong klase sa mga dating nadokumentong klase
ng pangalan ng pangalan.

--isang-file, -1
ilagay ang lahat ng output sa isang solong file.

--op, -o dir
itakda ang direktoryo ng output.

--opname, -n pangalan
itakda ang pangalan ng output. Walang epekto para sa HTML.

--malibog, -p
Kapag nagdodokumento ng isang file na naglalaman ng isang module o klase na tinukoy din sa iba
file, ipakita ang lahat ng bagay para sa module/klase na iyon sa bawat pahina ng mga file. Bilang default, lamang
ipakita ang mga bagay na tinukoy sa partikular na file na iyon.

--tahimik, -q
huwag magpakita ng pag-unlad habang nag-parse kami.

--ri, -r
bumuo ng output para sa paggamit ng 'ri.' Ang mga file ay naka-imbak sa '.rdoc' na direktoryo
sa ilalim ng iyong home directory maliban kung na-override ng isang kasunod na --op parameter, kaya hindi
kailangan ang mga espesyal na pribilehiyo.

--ri-site, -R
bumuo ng output para sa paggamit ng 'ri.' Ang mga file ay naka-imbak sa isang direktoryo sa buong site,
ginagawa silang naa-access ng iba, kaya kailangan ng mga espesyal na pribilehiyo.

--ri-system, -Y
bumuo ng output para sa paggamit ng 'ri.' Ang mga file ay naka-imbak sa isang system-level na direktoryo,
ginagawa silang naa-access ng iba, kaya kailangan ng mga espesyal na pribilehiyo. Ang pagpipiliang ito ay
nilalayong gamitin sa panahon ng pag-install ng Ruby.

--show-hash, -H
ang isang pangalan ng form na #name sa isang komento ay isang posibleng hyperlink sa isang paraan ng halimbawa
pangalan. Kapag ipinakita, ang '#' ay aalisin maliban kung ang opsyon na ito ay tinukoy.

--estilo, -s stylesheet-url
tumutukoy sa URL ng isang hiwalay na stylesheet.

--tab-width, -w n
itakda ang lapad ng mga character ng tab (default 8).

--template, -T Pangalan ng Template
itakda ang template na ginamit kapag bumubuo ng output.

--pamagat, -t teksto
itakda ang teksto bilang pamagat para sa output.

--bersyon, -v
ipakita ang bersyon ng RDoc.

--webcvs, -W url
tumukoy ng URL para sa pag-link sa isang web frontend sa CVS. Kung ang URL ay naglalaman ng isang naglalaman ng a
'%s', ang filename ay idaragdag dito.

Hulyo 2014 RDOC2.3(1)

Gumamit ng rdoc online gamit ang mga serbisyo ng onworks.net