autogsdoc - Dalam talian dalam Awan

JADUAL:

NAMA

autogsdoc - penjana dokumentasi API GNUstep dan penukar XML->HTML

SINOPSIS

autogsdoc [-Fail nama fail] [-GenerateHtml YA|tidak] [-Bersihkan ya|TIDAK] [-CleanTemplates
ya|TIDAK] [-AbaikanDependencies ya|TIDAK] [-MakeDependencies ya|TIDAK] [-ShowDependencies ya|TIDAK]
[-Direktori Header jalan] [-Direktori Dokumentasi jalan] [-Diisytiharkan lokasi] [-Projek
tajuk] [-Standard ya|TIDAK] [-DocumentAllInstanceVariables ya|TIDAK]
[-DocumentInstanceVariables YA|tidak] [-InstanceVariablesAtEnd ya|TIDAK] [-ConstantsTemplate
nama fail] [-FungsiTemplat nama fail] [-MacrosTemplate nama fail] [-TypedefsTemplate
nama fail] [-Templat Pembolehubah nama fail] [-Projek Sistem rentetan] [-Projek Tempatan rentetan]
[-Projek dictString] [-Verbose ya|TIDAK] [-Amaran ya|TIDAK] [-Peta Perkataan dictString] [fail]

DESCRIPTION

Alat autogsdoc ialah utiliti baris arahan yang membantu pembangun menghasilkan rujukan
dokumentasi untuk API GNUstep. Ia juga membolehkan pembangun menulis dan menyelenggara yang lain
dokumentasi dalam XML dan minta ia ditukar kepada HTML. Secara terperinci, autogsdoc akan:

- Ekstrak komen khas yang menerangkan antara muka awam kelas, kategori,
protokol, fungsi dan makro daripada kod sumber Objektif C (fail pengepala dan
fail sumber pilihan) ke dalam fail XML GSDoc.

- Tukar fail XML GSDoc, sama ada dijana daripada kod sumber atau ditulis secara manual oleh
pembangun, ke dalam HTML.

- Bina indeks berdasarkan set fail XML GSDoc, dan tukarkannya kepada HTML juga.

Penggunaan yang paling biasa ini adalah untuk menjalankan arahan dengan satu atau lebih nama fail pengepala sebagai
argumen ... alat akan menghuraikan fail sumber yang sepadan secara automatik dalam fail yang sama
direktori sebagai pengepala (atau direktori semasa, atau direktori yang ditentukan menggunakan
DocumentationDirectory lalai), dan menghasilkan fail GSDoc dan HTML sebagai output. Untuk yang terbaik
keputusan mod ini harus dijalankan dari direktori yang mengandungi fail sumber. (Catatan
kerana C ialah subset Objektif C, alat ini boleh beroperasi untuk mendokumentasikan fungsi dan
struktur C lain dalam sumber C biasa.)

Fail GSDoc juga boleh diberikan secara langsung sebagai tambahan atau dengan sendirinya, dan akan ditukar
kepada HTML. Lihat dokumentasi HTML GSDoc atau gsdoc(7) halaman manual untuk maklumat mengenai
Format GSDoc.

Akhir sekali, fail HTML boleh diberikan pada baris arahan. Rujukan silang kepada bahagian lain
dokumentasi kod yang terdapat di dalamnya akan ditulis semula berdasarkan apa yang terdapat dalam
projek pada masa ini.

SUMBER KOD MARKUP

Penghurai kod sumber secara automatik akan menghasilkan dokumen GSDoc yang menyenaraikan kaedah dalam
kelas yang terdapat dalam fail sumber, dan ia akan memasukkan teks daripada diformat khas
komen daripada fail sumber.

Sebarang komen yang bermula dengan garis miring dan 2 asterisk dan bukannya garis miring biasa dan tunggal
asterisk, diambil sebagai penanda GSDoc, untuk digunakan sebagai perihalan kelas atau kaedah
mengikutinya. Teks ulasan ini diformat semula dan kemudian dimasukkan ke dalam output.
Jika berbilang komen dikaitkan dengan item yang sama, ia digabungkan bersama dengan a
pemutusan baris ( ) antara setiap satu jika perlu.

Alat ini boleh digunakan dengan mudah untuk mendokumentasikan program dan juga perpustakaan, hanya dengan memberikannya
nama fail sumber yang mengandungi fungsi utama() program - ia memerlukan
komen khas daripada fungsi itu dan mengendalikannya secara khusus, memasukkannya sebagai a
bahagian pada penghujung bab pertama dokumen (ia mencipta bab pertama jika
perlu).

Pilihan diterangkan dalam bahagian Argumen and Lalai di bawah.

EXTRA MARKUP

Terdapat beberapa kes di mana pemprosesan tambahan khas dilakukan, terutamanya dalam
ulasan pertama ditemui dalam fail sumber, yang mana mungkin terdapat pelbagai ketulan penanda GSDoc
diekstrak dan diletakkan ke lokasi yang sesuai dalam dokumen output -

AutogsdocSource:
Dalam mana-mana baris di mana AutogsdocSource: didapati, baki garisan diambil sebagai a
nama fail sumber untuk digunakan dan bukannya membuat andaian bahawa setiap fail .h
diproses menggunakan fail .m dengan nama yang sama. Anda boleh membekalkan berbilang AutogsdocSource:
baris di mana fail pengepala mengisytiharkan item yang ditakrifkan dalam berbilang fail sumber.
Jika nama fail adalah mutlak, ia digunakan sama seperti yang dibekalkan. Jika sebaliknya, ia adalah a
laluan relatif, perisian mencari fail sumber terlebih dahulu berbanding dengan lokasi
daripada fail pengepala, dan jika tidak ditemui di sana, berbanding dengan direktori semasa di mana
autogsdoc sedang berjalan, dan akhirnya relatif kepada direktori yang ditentukan oleh
Direktori Dokumentasi lalai.


Abstrak kandungan dokumen ... diletakkan di kepala output GSDoc.


Penerangan tentang pengarang kod - boleh diulang untuk mengendalikan kes di mana a
dokumen mempunyai banyak pengarang. Diletakkan di kepala output GSDoc. Sebagai bantuan kepada
kebolehbacaan sumber, beberapa pemprosesan tambahan khas dilakukan berkaitan dengan
pengarang dokumen - Mana-mana baris dalam bentuk 'Pengarang: nama ', atau 'Oleh:
nama ', atau 'Pengarang: nama' atau 'Oleh: nama' akan dikenali dan
ditukar kepada an pengarang elemen, mungkin mengandungi an e-mel elemen.


Diletakkan dalam output GSDoc sejurus sebelum penghujung badan dokumen - dimaksudkan
untuk digunakan untuk lampiran, indeks dll.


Diletakkan segera sebelum sebarang dokumentasi kelas yang dijana ... bertujuan untuk digunakan
untuk memberikan penerangan keseluruhan tentang cara kod yang didokumenkan berfungsi. mana-mana
dokumentasi untuk fungsi main() program dimasukkan sebagai bahagian pada penghujungnya
bab ini.


Hak cipta kandungan dokumen ... diletakkan di kepala output GSDoc.
Sebagai bantuan kepada kebolehbacaan sumber, beberapa pemprosesan tambahan khas adalah
dilakukan - Mana-mana baris dalam bentuk 'teks Hak Cipta (C)' akan diiktiraf dan ditukar
kepada salinan elemen.


Tarikh semakan dokumen ... diletakkan di kepala output GSDoc. Jika
ini diabaikan alat akan cuba membina nilai daripada tag Tarikh RCS (jika
disediakan).


Dimasukkan ke dalam dokumen pada permulaan badan ... bertujuan untuk menyediakan
muka surat pengenalan atau kandungan dsb.


Tajuk dokumen ... diletakkan di kepala output GSDoc. Jika ini ditinggalkan
alat itu akan menjana tajuk (mungkin miskin) sendiri - jadi anda harus memasukkan ini
markup secara manual.


Pengecam versi dokumen ... diletakkan di kepala output GSDoc. Jika
ini diabaikan alat akan cuba membina nilai daripada tag Semakan RCS (jika
disediakan).

NB Penanda yang baru diterangkan boleh digunakan dalam kelas, kategori atau dokumentasi protokol
... jika ya, ia diekstrak dan dibalut pada seluruh dokumentasi untuk kelas
sebagai bab kelas. Selebihnya dokumentasi kelas biasanya disisipkan di
akhir bab, tetapi sebaliknya boleh digantikan sebagai pengganti pseudo-
elemen dalam unsur.

KAEDAH MARKUP

Dalam ulasan yang digunakan untuk menyediakan teks untuk penerangan kaedah, penanda berikut ialah
dikeluarkan daripada teks dan dikendalikan khas -


Kaedah ini ditandakan sebagai pemula yang ditetapkan untuk kelas.


Kaedah ini ditandakan sebagai salah satu subkelas mesti mengatasi (cth. abstrak
kaedah).


Kaedah ini ditandakan sebagai salah satu subkelas yang sepatutnya TIDAK menimpa.


Penanda dialih keluar daripada penerangan dan diletakkan selepas ia dalam output GSDoc -
supaya kaedah itu digambarkan sebagai mematuhi (atau tidak mematuhi) dengan yang ditentukan
piawaian.

AUTOMATED MARKUP

Secara amnya, teks dalam ulasan diformat semula untuk menyeragamkan dan mengendenkannya dengan baik ...
pemformatan semula adalah tidak dilakukan pada mana-mana teks di dalam an unsur. Apabila teks itu
diformatkan semula, ia dipecahkan kepada "perkataan" yang dipisahkan ruang putih yang kemudiannya tertakluk kepada
beberapa pemprosesan tambahan ...

Pemalar tertentu yang terkenal seperti YA, TIDAK, dan nihil disertakan dalam ...
markup.

Nama argumen kaedah dalam huraian kaedah disertakan dalam ...
</ var> markup.

Nama kaedah (bermula dengan tambah atau tolak) disertakan ...
markup. Cth "-init" (tanpa petikan) akan dibalut dalam rujukan GSDoc
elemen untuk menunjuk kepada kaedah init kelas semasa atau, jika hanya satu kelas yang diketahui
mempunyai kaedah init, ia akan merujuk kepada kaedah kelas itu. Perhatikan fakta bahawa
nama kaedah mesti dikelilingi oleh ruang putih untuk dikenali (walaupun koma,
hentian penuh, atau koma bertitik di hujung penentu akan bertindak seperti ruang putih).

Penentu kaedah termasuk nama kelas (bermula dan berakhir dengan kurungan segi empat sama)
disertakan dalam ... markup. cth '[NSObject-init]', akan mencipta a
merujuk kepada kaedah init NSObject (sama ada kelas yang betul, atau mana-mana daripadanya
kategori), manakala '[(NSCopying)-copyWithZone:]', mencipta rujukan kepada kaedah dalam
protokol NSCopying. Ambil perhatian bahawa tiada ruang mesti muncul di antara kurungan segi empat sama
dalam penentu ini. Nama protokol disertakan dalam kurungan bulat dan bukannya
kurungan sudut biasa, kerana GSDoc ialah bahasa XML dan XML merawat sudut
kurungan khas.

Nama fungsi (berakhir dengan '()') selain daripada 'main()' disertakan ...
markup. Cth "NSLogv()" (tanpa petikan) akan dibungkus dalam GSDoc
elemen rujukan untuk menunjuk kepada dokumentasi fungsi NSLog. Perhatikan fakta
bahawa nama fungsi mesti dikelilingi oleh ruang putih (walaupun koma, hentian penuh atau
koma bertitik di hujung penentu juga akan bertindak sebagai penamat ruang putih).

HUJAH DAN PIALA

Alat ini menerima lalai pengguna tertentu (yang sudah tentu boleh dibekalkan sebagai baris arahan
argumen dengan menambahkan '-' sebelum nama lalai dan memberikan nilai selepas itu, seperti dalam
-Bersih YA):

bersih
Jika nilai boolean ini ditetapkan kepada YA, maka daripada menjana dokumentasi, the
alat mengalih keluar semua fail GSDoc yang dijana dalam projek, dan semua fail html yang dijana
daripada mereka (serta mana-mana yang akan dihasilkan daripada fail GSDoc yang disenaraikan
secara eksplisit), dan akhirnya mengalih keluar fail indeks projek. Satu-satunya pengecualian untuk ini
ialah fail GSDoc templat (iaitu yang dinyatakan menggunakan "-ConstantsTemplate ...",
"-FunctionsTemplate ..." argumen dll) tidak dipadamkan melainkan CleanTemplates
bendera ditetapkan.

CleanTemplates
Bendera ini menentukan sama ada fail GSDoc templat akan dialih keluar bersama-sama dengan fail lain
fail apabila pilihan Bersih ditentukan. Lalai adalah untuk mereka tidak dialih keluar
... kerana templat ini mungkin telah dihasilkan secara manual dan baru sahaja data dimasukkan
ke dalam mereka.

ConstantsTemplate
Nyatakan nama dokumen templat di mana dokumentasi tentang pemalar
hendaklah dimasukkan daripada semua fail dalam projek. Ini berguna jika pemalar dalam
kod sumber bertaburan di sekeliling banyak fail, dan anda perlu mengumpulkannya menjadi satu
tempat. Anda bertanggungjawab untuk memastikan bahawa dokumen templat asas (di mana
dokumentasi pemalar individu dimasukkan) mengandungi semua maklumat lain yang anda
mahu, tetapi sebagai kemudahan autogsdoc akan menjana templat mudah (yang anda boleh
kemudian edit) untuk anda jika fail itu tidak wujud. Penyisipan berlaku serta-merta
sebelum kembali elemen (atau jika itu tidak wujud, sejurus sebelum tamat
badan elemen) dalam templat.

Dikemukakan
Tentukan tempat pengepala hendak didokumenkan sebagai ditemui. Nama sebenar yang dihasilkan
dalam dokumentasi dibentuk dengan menambahkan komponen terakhir nama fail pengepala
kepada nilai lalai ini. Jika lalai ini tidak dinyatakan, nama penuh
fail header (seperti yang dibekalkan pada baris arahan), dengan lalai HeaderDirectory
prepended, digunakan. Penggunaan biasa ini mungkin '"-Diisytiharkan Yayasan"' apabila
menjana dokumentasi untuk perpustakaan asas GNUstep. Ini akan mengakibatkan
dokumentasi yang mengatakan bahawa NSString diisytiharkan dalam 'Foundation/NSString.h'

DocumentAllInstanceVariables
Bendera ini membenarkan anda menjana dokumentasi untuk semua pembolehubah contoh. Biasanya,
hanya yang diisytiharkan secara jelas 'awam' atau 'dilindungi' akan didokumenkan.

DocumentInstanceVariables
Bendera ini membenarkan anda mematikan dokumentasi contohnya pembolehubah sepenuhnya.
Biasanya, pembolehubah contoh 'awam' atau 'dilindungi' secara eksplisit akan menjadi
didokumenkan.

InstanceVariablesAtEnd
Bendera ini, jika ditetapkan, mengarahkan penjana HTML untuk meletakkan dokumentasi pembolehubah contoh
pada akhir kelas, bukannya permulaan. Ini berguna jika anda menggunakan banyak
pembolehubah contoh dilindungi yang hanya akan menjadi kepentingan kedua
pengguna umum kelas.

Direktori Dokumentasi
Boleh digunakan untuk menentukan direktori di mana dokumentasi yang dijana akan diletakkan.
Jika ini tidak ditetapkan, output diletakkan dalam direktori semasa. Direktori ini juga
digunakan sebagai pilihan terakhir untuk mencari fail sumber (bukan pengepala), dan yang lebih penting, ia
digunakan sebagai pertama and hanyalah mengambil jalan keluar untuk mencari mana-mana fail .gsdoc yang dihantar
baris arahan. Sebarang maklumat laluan yang diberikan untuk fail ini ialah dikeluarkan dan mereka
dicari dalam 'DocumentationDirectory' (walaupun mereka mungkin tidak pernah
dijana secara automatik).

Fail
Menentukan nama fail yang mengandungi senarai nama fail sebagai tatasusunan senarai harta
(nama1, nama2,...) format. Jika ini ada, nama fail dalam senarai hujah program
diabaikan dan nama dalam fail ini digunakan sebagai senarai nama untuk diproses.

FunctionsTemplate
Tentukan nama dokumen templat di mana dokumentasi tentang fungsi
hendaklah dimasukkan daripada semua fail dalam projek. Ini berguna jika sumber fungsi
kod bertaburan di sekeliling banyak fail, dan anda perlu mengumpulkannya ke satu tempat. Awak
bertanggungjawab untuk memastikan bahawa dokumen templat asas (ke mana individu
dokumentasi fungsi dimasukkan) mengandungi semua maklumat lain yang anda inginkan, tetapi
sebagai kemudahan autogsdoc akan menjana templat mudah (yang kemudian anda boleh edit)
untuk anda jika fail itu tidak wujud. Sisipan berlaku sejurus sebelum kembali
elemen (atau jika itu tidak wujud, sejurus sebelum tamat badan unsur) dalam
templat.

GenerateHtml
Boleh digunakan untuk menentukan sama ada output HTML akan dijana. Lalai kepada YA.

HeaderDirectory
Boleh digunakan untuk menentukan direktori yang akan dicari untuk fail pengepala. Apabila dibekalkan,
nilai ini ditambah kepada nama pengepala relatif, jika tidak, nama pengepala relatif
ditafsirkan secara relatif kepada direktori semasa. Fail pengepala dinyatakan sebagai mutlak
laluan tidak dipengaruhi oleh lalai ini.

IgnoreDependencies
Nilai boolean yang boleh digunakan untuk menentukan bahawa program harus mengabaikan fail
masa pengubahsuaian dan menjana semula fail pula. Disediakan untuk digunakan bersama dengan
sistem 'buat', yang dijangka menguruskan semakan pergantungan sendiri.

Projek Tempatan
Nilai ini digunakan untuk mengawal kemasukan automatik projek luaran tempatan ke dalam
sistem pengindeksan untuk penjanaan rujukan silang dalam output dokumen akhir. Jika
ditetapkan kepada 'Tiada', maka tiada rujukan projek tempatan dilakukan, jika tidak, 'Tempatan'
Direktori dokumentasi GNUstep dicari secara rekursif untuk fail dengan '.igsdoc'
sambungan, dan maklumat pengindeksan daripada fail tersebut digunakan. Nilai ini
rentetan juga digunakan untuk menjana nama fail dalam rujukan silang ... jika ia adalah
rentetan kosong, laluan untuk digunakan diandaikan sebagai fail dalam direktori yang sama di mana fail
fail igsdoc ditemui, jika tidak, ia digunakan sebagai awalan kepada nama dalam indeks. NB.
Projek tempatan dengan nama yang sama seperti projek yang sedang didokumenkan akan tidak
dimasukkan oleh mekanisme ini. Jika anda ingin memasukkan projek sedemikian, anda mesti berbuat demikian
secara eksplisit menggunakan -Projek ...

MacrosTemplate
Tentukan nama dokumen templat yang harus dimasukkan ke dalam dokumentasi tentang makro
dimasukkan daripada semua fail dalam projek. Ini berguna jika kod makro bertaburan
di sekeliling banyak fail, dan anda perlu mengumpulkannya ke satu tempat. Anda bertanggungjawab untuk
memastikan bahawa dokumen templat asas (di mana dokumentasi makro individu
dimasukkan) mengandungi semua maklumat lain yang anda inginkan, tetapi sebagai kemudahan
autogsdoc akan menjana templat mudah (yang kemudian anda boleh edit) untuk anda jika
fail tidak wujud. Sisipan berlaku sejurus sebelum kembali elemen (atau jika
yang tidak wujud, sejurus sebelum berakhirnya badan
elemen) dalam templat.

MakeDependency
Nama fail yang akan digunakan untuk mengeluarkan maklumat pergantungan untuk dibuat. Ini akan mengambil masa
bentuk penyenaraian semua fail pengepala dan sumber yang dikenali untuk projek sebagai kebergantungan
nama projek (lihat 'Projek').

Projek
Boleh digunakan untuk menentukan nama projek ini ... menentukan nama indeks
fail rujukan yang dihasilkan sebagai sebahagian daripada dokumentasi untuk menyediakan maklumat yang membolehkan
projek lain untuk merujuk silang kepada item dalam projek ini.

Projek
Nilai ini mungkin dibekalkan sebagai kamus yang mengandungi laluan ke igsdoc
fail indeks/rujukan yang digunakan oleh projek luaran, bersama-sama dengan nilai yang akan digunakan untuk memetakan
nama fail yang terdapat dalam indeks. Contohnya, jika fail indeks projek (igsdoc).
mengatakan bahawa kelas 'Foo' ditemui dalam fail 'Foo', dan laluan yang dikaitkan dengan
indeks projek itu ialah '/usr/share/doc/proj', Kemudian output html yang dihasilkan boleh merujuk
kelas berada dalam '/usr/share/doc/prj/Foo.html' . Ambil perhatian bahawa kamus mungkin
diberikan pada baris arahan dengan menggunakan format PropertyList standard (bukan XML
format OS X), menggunakan koma bertitik sebagai pemisah baris, dan melampirkannya dalam satu
petikan.

ShowDependency
Nilai boolean yang boleh digunakan untuk menentukan bahawa program harus log fail mana
sedang dijana semula kerana kebergantungan mereka pada fail lain.

Piawaian
Nilai boolean yang digunakan untuk menentukan sama ada program harus memasukkan maklumat tentang
pematuhan standard ke dalam dokumentasi. Ini hanya boleh digunakan apabila
mendokumenkan perpustakaan dan alatan GNUstep sendiri kerana ia menganggap bahawa kod
didokumenkan adalah sebahagian daripada GNUstep dan mungkin mematuhi piawaian OpenStep
atau melaksanakan kaedah serasi MacOS-X.

Projek Sistem
Nilai ini digunakan untuk mengawal kemasukan automatik projek luaran sistem ke dalam
sistem pengindeksan untuk penjanaan rujukan silang dalam output dokumen akhir. Jika
ditetapkan kepada 'Tiada', maka tiada rujukan projek sistem dilakukan, jika tidak, 'Sistem'
Direktori dokumentasi GNUstep dicari secara rekursif untuk fail dengan '.igsdoc'
sambungan, dan maklumat pengindeksan daripada fail tersebut digunakan. Nilai ini
rentetan juga digunakan untuk menjana nama fail dalam rujukan silang ... jika ia adalah
rentetan kosong, laluan untuk digunakan diandaikan sebagai fail dalam direktori yang sama di mana fail
fail igsdoc ditemui, jika tidak, ia digunakan sebagai awalan kepada nama dalam indeks. NB.
Projek sistem dengan nama yang sama seperti projek yang sedang didokumenkan akan tidak
dimasukkan oleh mekanisme ini. Jika anda ingin memasukkan projek sedemikian, anda mesti berbuat demikian
secara eksplisit menggunakan -Projek ...

TypedefsTemplate
Tentukan nama dokumen templat di mana dokumentasi mengenai typedefs harus
dimasukkan daripada semua fail dalam projek. Ini berguna jika kod sumber typedef adalah
bertaburan di sekeliling banyak fail, dan anda perlu mengumpulkannya ke satu tempat. Awak
bertanggungjawab untuk memastikan bahawa dokumen templat asas (ke mana individu
dokumentasi typedef dimasukkan) mengandungi semua maklumat lain yang anda inginkan, tetapi sebagai
autogsdoc kemudahan akan menjana templat mudah (yang kemudian anda boleh edit) untuknya
anda jika fail itu tidak wujud. Sisipan berlaku sejurus sebelum kembali
elemen (atau jika itu tidak wujud, sejurus sebelum tamat badan unsur) dalam
templat.

Up Rentetan yang digunakan untuk membekalkan nama untuk digunakan dalam pautan 'up' daripada GSDoc yang dijana
dokumen. Ini biasanya nama fail yang mengandungi indeks
kandungan sesuatu projek. Jika ini tiada atau ditetapkan kepada rentetan kosong, maka tiada 'naik'
pautan akan diberikan dalam dokumen.

VariablesTemplate
Tentukan nama dokumen templat di mana dokumentasi tentang pembolehubah
hendaklah dimasukkan daripada semua fail dalam projek. Ini berguna jika sumber berubah
kod bertaburan di sekeliling banyak fail, dan anda perlu mengumpulkannya ke satu tempat. Awak
bertanggungjawab untuk memastikan bahawa dokumen templat asas (ke mana individu
dokumentasi pembolehubah dimasukkan) mengandungi semua maklumat lain yang anda inginkan, tetapi
sebagai kemudahan autogsdoc akan menjana templat mudah (yang kemudian anda boleh edit)
untuk anda jika fail itu tidak wujud. Sisipan berlaku sejurus sebelum kembali
elemen (atau jika itu tidak wujud, sejurus sebelum tamat badan unsur) dalam
templat.

Kata Kerja
Boolean yang digunakan untuk menentukan sama ada anda mahu keluaran nyahpepijat/amaran verbose
dihasilkan.

Beri amaran
Boolean yang digunakan untuk menentukan sama ada anda mahu keluaran amaran standard (cth laporan bagi
kaedah tidak berdokumen) dihasilkan.

WordMap
Nilai ini ialah kamus yang digunakan untuk memetakan pengecam/kata kunci yang terdapat dalam fail sumber
kepada perkataan lain. Secara amnya anda tidak perlu menggunakan ini, tetapi kadangkala ia membantu
untuk mengelakkan penghurai keliru dengan penggunaan makro prapemproses C. Awak boleh
mentakrifkan semula makro dengan berkesan kepada sesuatu yang kurang mengelirukan. Nilai yang anda petakan
pengecam kepada mestilah salah satu daripada - Pengecam lain, Rentetan kosong - nilainya
diabaikan, Dua garis miring ('//') - selebihnya baris diabaikan. Perhatikan bahawa kamus
boleh diberikan pada baris arahan dengan menggunakan format PropertyList standard (bukan format
Format XML OS X), menggunakan koma bertitik sebagai pemisah baris, dan melampirkannya dalam satu
petikan.

ANTARA DOKUMEN HUBUNGAN

Lalai 'Naik' digunakan untuk menentukan nama dokumen yang harus digunakan sebagai
pautan 'up' untuk sebarang dokumen lain yang digunakan. Nama ini tidak boleh termasuk laluan atau sambungan.
Secara amnya, dokumen yang dirujuk secara lalai ini mestilah dokumen GSDoc yang disunting tangan
yang sepatutnya mempunyai bahagian belakang yang mengandungi indeks projek. cth


<!DOCTYPE gsdoc PUBLIC "-//GNUstep//DTD gsdoc 1.0.3//EN"
"http://www.gnustep.org/gsdoc-1_0_3.xml">


Rujukan projek saya




Rujukan projek saya

Gunakan autogsdoc dalam talian menggunakan perkhidmatan onworks.net