mdassembler - Online di Cloud

PROGRAM:

NAMA

mdassembler - Kompilasi dokumentasi untuk digunakan di browser monodoc

RINGKASAN

mdassembler OPSI* DIRS+

DESKRIPSI

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

mdassembler adalah program yang membuat .pohon dan Zip. file untuk digunakan dalam monodoc
penjelajah dokumentasi.

.pohon dan Zip. file disalin ke monodoc's sumber direktori, dan tinggal dengan a
.sumber file yang digunakan oleh monodoc untuk menentukan di mana dokumentasi seharusnya
ditampilkan. NS .sumber file /monodoc/source/@basefile atribut menentukan nama file
awalan untuk file dokumentasi. Ini harus awalan yang sama seperti yang digunakan dengan --keluar
parameter.

PILIHAN

--ecma Dokumentasi ditemukan di dalam DIRS dalam format dokumentasi Mono ECMA. Lihat
itu Mono ECMA Dokumentasi dibentuk bagian di bawah ini.

--ecmaspec
Dokumentasi ditemukan di dalam DIRS ada dalam dokumentasi Spesifikasi ECMA
format. Lihat Mono ECMA Spesifikasi Dokumentasi dibentuk bagian di bawah ini.

--kesalahan
Dokumentasi ditemukan di dalam DIRS dalam format "kesalahan". Lihat error
Dokumentasi dibentuk bagian di bawah ini.

--membantu Tampilkan informasi argumen program.

--pria Dokumentasi ditemukan di dalam DIRS dalam format halaman manual. Lihat Pria Halaman
Dokumentasi dibentuk bagian di bawah ini.

-Hai, --keluar AWALAN
Tentukan awalan file keluaran. mdassembler membuat file Awalan.zip dan
PREFIX.pohon .

--sederhana
Dokumentasi ditemukan di dalam DIRS dalam format "sederhana". Lihat Sederhana
Dokumentasi dibentuk bagian di bawah ini.

--xhtml, --hb
Dokumentasi ditemukan di dalam DIRS dalam format XHTML. Lihat XHTML
Dokumentasi dibentuk bagian di bawah ini.

FORMAT

Format dokumentasi berikut ini didukung:

Mono ECMA Dokumentasi dibentuk
Format dokumentasi XML dengan satu file per jenis.

Lihat mdoc(5) halaman manual untuk informasi lebih lanjut.

Mono ECMA Spesifikasi Dokumentasi dibentuk
Ini bukan format yang Anda cari.

Ini adalah format yang digunakan untuk mewakili standar ECMA-334 (C#) di dalam monodoc. Bukan itu
digunakan untuk menampilkan dokumentasi perpustakaan kelas; untuk dokumentasi perpustakaan kelas, gunakan
--ecma Format.

error Dokumentasi dibentuk
Digunakan untuk menyajikan pesan kesalahan terperinci, dan digunakan dalam monodoc's "Kesalahan Kompilator C#
Referensi" pohon. DIRS bukan direktori, melainkan file konfigurasi, yang berisi
XML-nya:


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


/ErrorProviderConfig/FilesPath menentukan tempat untuk mencari file,
/ErrorProviderConfig/Match menentukan pola nama file untuk dicari di dalam
/ErrorProviderConfig/FilesPath, /ErrorProviderConfig/ErrorNumSubstringStart dan
/ErrorProviderConfig/ErrorNumSubstringLength mengontrol bagian mana dari nama file yang digunakan
sebagai nomor kesalahan, dan /ErrorProviderConfig/FriendlyFormatString mengontrol bagaimana
pemformatan/tampilan simpul di monodoc pohon.

Untuk setiap file yang ditemukan, itu dikonversi ke HTML dengan pewarnaan sintaks C# yang diterapkan.

Sederhana Dokumentasi dibentuk
Mengonversi file teks menjadi HTML dengan menerjemahkan setiap baris baru ke dalam HTML elemen.

Pria Halaman Dokumentasi dibentuk
Mengubah halaman manual menjadi HTML untuk ditampilkan.

XHTML Dokumentasi dibentuk
Salin file XHTML apa adanya.

CONTOH

Untuk menginstal dokumentasi Anda untuk digunakan dengan monodoc:

membuat a PREFIX.sumber fillet
dengan isinya:






di mana FORMAT adalah format dokumentasi yang terdapat di dalam PREFIX.pohon file,
misalnya ekma, atau sederhana. AWALAN is itu nama dasar of itu .pohon dan Zip. file yang
mdassembler menciptakan. PATH adalah "jalur" di pohon monodoc yang seharusnya berisi
dokumentasi. Lihat @awalan@/lib/monodoc/monodoc.xml file untuk daftar
nilai PATH ( //simpul/@nama nilai).

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

membuat Tujuan dokumentasi
Lihat juga monodocer(1) halaman manual, mis

monodocer -perakitan:foo.dll -jalur:foo/en

Berkumpul itu dokumentasi

mdassembler --ecma foo/en PREFIX

Pastikan Anda menggunakan yang sama AWALAN di sini seperti yang Anda lakukan di atas.

Install itu dokumentasi by menggunakan itu Command

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

(Perhatikan backtick yang digunakan dalam pkg-config perintah!) Ini menyalin .sumber ,
.pohon , dan Zip. file ke dalam monodoc sumber direktori, yang akan memungkinkan monodoc
untuk menampilkan dokumentasi.

Gunakan mdassembler online menggunakan layanan onworks.net