mdassembler - Dalam Talian di Awan

JADUAL:

NAMA

mdassembler - Susun dokumentasi untuk digunakan dalam pelayar monodoc

SINOPSIS

mdassembler PILIHAN* DIRS+

DESCRIPTION

mdassembler telah usang oleh mdoc(1). Lihat mdoc-assemble(1) halaman manusia.

mdassembler adalah program yang mencipta .pokok and . Zip fail untuk digunakan dalam monodoc
pelayar dokumentasi.

. .pokok and . Zip fail disalin ke dalam monodoc sumber direktori, dan tinggal dengan a
.sumber fail yang digunakan oleh monodoc untuk menentukan di mana dokumentasi sepatutnya
dipaparkan. The .sumber fail /monodoc/source/@basefile atribut menentukan nama fail
awalan untuk fail dokumentasi. Ini mestilah awalan yang sama seperti yang digunakan dengan --keluar
parameter.

PILIHAN

--ecma Dokumentasi yang terdapat dalam DIRS berada dalam format dokumentasi Mono ECMA. Lihat
yang Mono ECMA dokumentasi format seksyen di bawah.

--ecmaspec
Dokumentasi yang terdapat dalam DIRS terdapat dalam dokumentasi Spesifikasi ECMA
format. Lihat Mono ECMA spesifikasi dokumentasi format seksyen di bawah.

--kesilapan
Dokumentasi yang terdapat dalam DIRS berada dalam format "ralat". Lihat ralat
dokumentasi format seksyen di bawah.

- membantu Tunjukkan maklumat hujah program.

--lelaki Dokumentasi yang terdapat dalam DIRS adalah dalam format halaman manusia. Lihat Lelaki Page
dokumentasi format seksyen di bawah.

-o, --keluar PERMULAAN
Tentukan awalan fail output. mdassembler mencipta fail PREFIX.zip and
PREFIX.pokok .

--mudah
Dokumentasi yang terdapat dalam DIRS adalah dalam format "mudah". Lihat Mudah
dokumentasi format seksyen di bawah.

--xhtml, --hb
Dokumentasi yang terdapat dalam DIRS adalah dalam format XHTML. Lihat XHTML
dokumentasi format seksyen di bawah.

FORMATS

Format dokumentasi berikut disokong:

Mono ECMA dokumentasi format
Format dokumentasi XML dengan satu fail bagi setiap jenis.

Melihat mdoc(5) halaman manual untuk maklumat lanjut.

Mono ECMA spesifikasi dokumentasi format
Ini bukan format yang anda cari.

Ini ialah format yang digunakan untuk mewakili standard ECMA-334 (C#) dalam monodoc. Bukan
digunakan untuk memaparkan dokumentasi perpustakaan kelas; untuk dokumentasi perpustakaan kelas, gunakan
--ecma format.

ralat dokumentasi format
Digunakan untuk membentangkan mesej ralat terperinci, dan digunakan dalam monodoc"Ralat Pengkompil C#
Rujukan" pokok. DIRS bukan direktori, tetapi sebaliknya fail konfigurasi, yang mengandungi
XML:


../../mcs/errors
cs????*.cs
2
4
CS{0:0###}


/ErrorProviderConfig/FilesPath menentukan tempat untuk mencari fail,
/ErrorProviderConfig/Match menentukan corak nama fail untuk dicari dalam
/ErrorProviderConfig/FilesPath, /ErrorProviderConfig/ErrorNumSubstringStart and
/ErrorProviderConfig/ErrorNumSubstringLength mengawal bahagian mana nama fail digunakan
sebagai nombor ralat, dan /ErrorProviderConfig/FriendlyFormatString mengawal bagaimana
pemformatan/paparan nod dalam monodoc pokok.

Untuk setiap fail yang ditemui, ia ditukar kepada HTML dengan pewarnaan sintaks C# digunakan.

Mudah dokumentasi format
Menukar fail teks kepada HTML dengan menterjemah setiap baris baharu kepada HTML elemen.

Lelaki Page dokumentasi format
Menukar halaman manual kepada HTML untuk paparan.

XHTML dokumentasi format
Menyalin fail XHTML apa adanya.

CONTOH

Untuk memasang dokumentasi anda untuk digunakan dengan monodoc:

Buat a AWAL.sumber fail
dengan kandungan:






di mana FORMAT ialah format dokumentasi yang terkandung dalam PREFIX.pokok fail,
contohnya ecma, Atau mudah. PERMULAAN is yang nama asas of yang .pokok and . Zip fail yang
mdassembler mencipta. PATH ialah "laluan" dalam pokok monodoc yang sepatutnya mengandungi
dokumentasi tersebut. Lihat @prefix@/lib/monodoc/monodoc.xml fail untuk senarai
nilai PATH (the //nod/@nama nilai).

Lihat juga: http://www.mono-
project.com/docs/tools+libraries/tools/monodoc/generating-documentation/

Buat Matlamat dokumentasi
Lihat juga monodocer(1) halaman manual, cth

monodocer -assembly:foo.dll -path:foo/en

Berhimpun yang dokumentasi

mdassembler --ecma foo/en PREFIX

Pastikan anda menggunakan yang sama PERMULAAN di sini seperti yang anda lakukan di atas.

memasang yang dokumentasi by menggunakan yang arahan

cp PREFIX.source PREFIX.tree PREFIX.zip \
`pkg-config monodoc --variable=sourcesdir`

(Perhatikan kutu belakang yang digunakan dalam pkg-konfigurasi perintah!) Ini menyalin .sumber ,
.pokok , dan . Zip fail ke dalam monodoc sumber direktori, yang akan membenarkan monodoc
untuk memaparkan dokumentasi.

Gunakan mdassembler dalam talian menggunakan perkhidmatan onworks.net