naturaldocs - Online sa Cloud

PROGRAMA:

NAME

NaturalDocs - isang extensible, multi-language documentation generator

SINOPSIS

naturaldocs -i [-i ...] -o
format> [-o ...] -p
direktoryo> [mga opsyon]

DESCRIPTION

Ang manu-manong pahinang ito ay nagdodokumento ng maikling .B naturaldocs na utos. Tandaan na naturaldocs ay isang
wrapper script na sa Debian invokes ang real NaturalDocs perl na programa. Kaya, ang tunay,
Ang orihinal na pangalan ng programa ay NaturalDocs ngunit sa mga Debian system ay ginagamit mo ito bilang
naturaldocs.

Natural Docs ay isang open-source, extensible, multi-language documentation generator. Ikaw
idokumento ang iyong code sa natural na syntax na parang simpleng Ingles. Natural Docs noon
ini-scan ang iyong code at bumuo ng mataas na kalidad na dokumentasyon ng HTML mula dito.

Opsyon

Isang buod ng mga opsyon, kinuha mula sa tulong na inilimbag ng -h switch ay kasama sa ibaba.
Para sa kumpletong paglalarawan kung paano gumagana ang NaturalDocs, tingnan ang mga text file sa
/usr/share/doc/naturaldocs na direktoryo.

Kailangan parameter:

-ako, --input, --pinagmulan DIR
Tinutukoy ang isang input (pinagmulan) na direktoryo. Kailangan.
Maaaring tukuyin ng maraming beses.

-o, --output FMT DIR
Tinutukoy ang isang format ng output at direktoryo. Kailangan.
Maaaring tukuyin ng maraming beses, ngunit isang beses lamang sa bawat direktoryo. Posibleng output
ang mga format ay HTML at FramedHTML.

-p, --proyekto DIR
Tinutukoy ang direktoryo ng proyekto. Kailangan.
Kailangang mayroong natatanging direktoryo ng proyekto para sa bawat direktoryo ng pinagmulan.

Opsyonal parameter:

-oo, --estilo Estilo [ESTYO ...]
Tinutukoy ang istilo ng CSS kapag bumubuo ng HTML na output. Kung marami ang mga istilo
tinukoy, lahat sila ay isasama sa ibinigay na order.

-img, --larawan DIR
Tinutukoy ang isang direktoryo ng imahe. Maaaring tukuyin ng maraming beses. Magsimula sa * sa
tukuyin ang isang kamag-anak na direktoryo, tulad ng sa -img */images.

-gawin, --dokumento-lamang
Tinutukoy lamang ang mga nakadokumentong aspeto ng code na dapat isama sa output.

-t, --haba ng tab LEN
Tinutukoy ang bilang ng mga space na tab na dapat palawakin. Ito lang ang kailangan
itakda kung gumagamit ka ng mga tab sa halimbawang code at text diagram. Default sa 4.

-xi, --exclude-input, --exclude-source
Hindi kasama ang isang input (source) na direktoryo mula sa dokumentasyon. Awtomatikong ginagawa para sa
ang mga direktoryo ng proyekto at output. Maaaring tukuyin ng maraming beses.

-nag, --walang-auto-grupo
Ganap na i-off ang auto-grouping.

-madalas, --lamang-file-titles
Gagamitin lamang ng mga source file ang pangalan ng file bilang pamagat.

-r, --muling itayo
Binubuo muli ang lahat ng output at data file mula sa simula. Hindi nakakaapekto sa menu file.

-ro, --rebuild-output
Binubuo muli ang lahat ng mga output file mula sa simula.

-q, --tahimik
Pinipigilan ang lahat ng di-error na output.

-?, -h, - Tumulong
Ipinapakita ang syntax reference.

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