nesdoc - Online sa Cloud

PROGRAMA:

NAME

nesdoc - bumuo ng dokumentasyon ng TinyOS

SINOPSIS

Paggamit ng TinyOS 1.x:
nesdoc [dokumentasyon-direktoryo] [ncc-options] mga file...

TinyOS 2.x: mangolekta ng dokumentasyon mula sa isang program:
nesdoc -o dokumentasyon-direktoryo [-preserba]
[-bago] [-tahimik] [-target=platform] [-topdir=direktoryo] [App]
[ncc-options] mga file...

TinyOS 2.x: bumuo ng nesdoc HTML na mga pahina:
nesdoc -o dokumentasyon-direktoryo -html
[-bago] [-tahimik] [-target=platform]

DESCRIPTION

nesdoc ay isang tool upang awtomatikong kunin ang dokumentasyon mula sa mga nesC file at application.
Mayroong dalawang pagpapatupad ng nesdoc: isang luma na ginagamit bilang default sa TinyOS
1.x na mga puno, at isang bagong ginamit sa mga puno ng TinyOS 2.x o kapag ang -bago ang pagpipilian ay tinukoy. Ito
ay hindi posibleng gamitin ang lumang pagpapatupad sa TinyOS 2.x.

Ang mga direktoryo ng dokumentasyon ay may subdirectory para sa bawat platform, at naglalaman ng mga HTML file
naglalarawan sa mga bahagi at interface sa TinyOS. Binubuo ng nesdoc ang mga file na ito sa pamamagitan ng
pag-iipon ng mga programa ng nesC at pagkuha ng impormasyon sa dokumentasyon.

Kapag tinawag, nesdoc bumubuo ng dokumentasyon para sa program na isasama
ncc ncc-options mga file...

Ang lumang nesdoc ay nagdaragdag ng HTML file para sa bawat bahagi, interface sa pinagsama-samang aplikasyon
sa direktoryo ng dokumentasyon, at nag-a-update ng ilang mga indeks. Ang lumang nesdoc ay hindi
sumusuporta sa mga generic na bahagi o interface.

Ang bagong nesdoc ay naghihiwalay sa pagbuo ng HTML sa dalawang yugto. Una, ang isang aplikasyon ay
pinagsama-sama at ang mga paglalarawan ng XML ng mga bahagi at interface nito ay idinagdag sa
direktoryo ng dokumentasyon. Kapag nakuha na ang mga paglalarawan ng XML para sa lahat ng bahagi ng
interes, ang mga HTML na pahina ay nabuo mula sa repositoryong ito sa pamamagitan ng pagpapatakbo nesdoc sa -html
pagpipilian.

Para sa higit pang mga detalye, tingnan ang hiwalay nesdoc dokumentasyon.

Opsyon

-target=platform
Tukuyin ang platform kung saan nabuo ang dokumentasyon.

-preserba
Bilang default, kapag nangongolekta ng impormasyon, ino-overwrite ng nesdoc ang umiiral nang XML
paglalarawan ng mga interface at mga bahagi upang matiyak na napapanahon ang mga ito.
Gayunpaman, ito ay mabagal kapag bumubuo ng dokumentasyon sa isang malaking bilang ng
mga aplikasyon. Kung pumasa ka sa -preserba opsyon, ang mga umiiral nang XML na paglalarawan ay hindi
pinalitan

-html Bumuo ng mga pahina ng HTML para sa lahat ng impormasyong nesdoc na nakolekta sa dokumentasyon-
direktoryo. -bago Pilitin ang paggamit ng bagong nesdoc kahit na gumagamit ng TinyOS 1.x
pinagmumulan ng puno.

-tahimik Huwag mag-print ng mga mensaheng nagbibigay-kaalaman.

-topdir=dir
Tukuyin ang mga path ng direktoryo na dapat alisin mula sa mga pangalan ng source file kapag
pagbuo ng "mga pangalan ng package" para sa mga file ng dokumentasyon. Ang direktoryo sa itaas TOSDIR
ay awtomatikong idinagdag, kaya ang pagpipiliang ito ay kailangan lamang para sa mga direktoryo sa labas ng
pangunahing pamamahagi ng TinyOS.

App Bumuo din ng isang graph para sa buong aplikasyon sa kasalukuyang direktoryo - ito ay
kapaki-pakinabang upang suriin ang mga kable ng isang partikular na application.

Gamitin ang nesdoc online gamit ang mga serbisyo ng onworks.net