Bu, Ubuntu Online, Fedora Online, Windows çevrimiçi emülatörü veya MAC OS çevrimiçi emülatörü gibi birden fazla ücretsiz çevrimiçi iş istasyonumuzdan birini kullanarak OnWorks ücretsiz barındırma sağlayıcısında çalıştırılabilen mezgit balığı komutudur.
Program:
ADI
mezgit balığı - açıklamalı Haskell kaynak kodu için dokümantasyon aracı
SİNOPSİS
mezgit balığı [seçenekleri] dosya...
TANIM
Bu kılavuz sayfası kısaca şunları belgelemektedir: mezgit balığı emretmek. Kapsamlı belgeler
DVI, PostScript ve HTML dahil olmak üzere çeşitli diğer formatlarda mevcuttur; aşağıya bakınız.
dosya Haskell kaynak modülünü içeren bir dosya adıdır. Belirtilen tüm modüller
komut satırı birlikte işlenecektir. Bir modül diğerindeki bir varlığa atıfta bulunduğunda
modül işlenirken, belgeler doğrudan o varlığa bağlanacaktır.
Bulunamayan varlıklar, örneğin mevcut olmayan bir modülde oldukları için
mevcut partinin bir parçası olarak işlenirse, oluşturulan dosyada köprü oluşturulmaz.
dokümantasyon. mezgit balığı yapamadığı tüm tanımlayıcıları listeleyen uyarılar yayar
çözmek.
Modüller karşılıklı olarak özyinelemeli olmamalıdır, çünkü mezgit balığı yüzmeyi sevmez
çevreler.
SEÇENEKLER
Programlar, iki ile başlayan uzun seçeneklerle olağan GNU komut satırı sözdizimini takip eder.
tireler (`--'). Seçeneklerin bir özeti aşağıda yer almaktadır. Tam bir açıklama için bkz.
diğer belgeler.
-o DIR, --odir=DIR
çıktı dosyalarının yerleştirileceği dizin
-i DOSYA, --okuma arayüzü=DOSYA
şuradan bir arayüz oku DOSYA.
-D DOSYA, --dump-arayüz=DOSYA
bu modüller için bir arayüz dökümü DOSYA.
-l DIR, --lib=DIR
Haddock'un yardımcı dosyalarının konumu
-h, --html
HTML formatında belgeler oluşturun. Birkaç dosya oluşturulacak
geçerli dizin (veya belirtilen dizin -o seçeneği verilmiştir), dahil
şu:
index.html
Belgelerin en üst düzey sayfası: Kullanılabilir modülleri listeler.
modüller hiyerarşik ise hiyerarşiyi temsil etmek için girinti.
mezgit balığı.css
Oluşturulan HTML tarafından kullanılan stil sayfası. Bunu değiştirmek için çekinmeyin
renkleri veya düzeni değiştirin, hatta kullanarak kendi stil sayfanızı belirtin.
--css seçeneği.
modül.html
Her modül için bir HTML sayfası.
doc-index.html, doc-index-XX.html
Dizin, ikiye bölünmüştür (işlevler/yapıcılar ve türler/sınıflar,
Haskell ad alanları) ve ayrıca alfabetik olarak bölünür.
--hoogle
Hoogle için çıktı
--html-yardım=biçim
mshelp, mshelp2 veya devhelp biçiminde dizin ve içindekiler tablosu oluşturun (ile -h)
--kaynak-taban=URL
Oluşturulan belgelere kaynak dosyalara bağlantılar ekleyin; burada URL
kaynak dosyaların bulunabileceği temel URL.
-s URL --kaynak modülü=URL
URL'nin bir
her modül için kaynak kodu bağlantısı (%{FILE} veya %{MODULE} değişkenlerini kullanarak).
--kaynak-varlık=URL
URL'nin bir
her varlık için kaynak kodu bağlantısı (%{FILE}, %{MODULE} veya %{NAME} değişkenlerini kullanarak).
--yorum-tabanı=URL
İçerik ve dizin sayfalarındaki bir yorum bağlantısının URL'si.
--yorum-modülü=URL
Her modül için bir yorum bağlantısının URL'si (%{MODULE} değişkenini kullanarak).
--yorum-varlık=URL
Her varlık için bir yorum bağlantısının URL'si (%{FILE}, %{MODULE} veya %{NAME} kullanılarak
değişir).
--css=DOSYA
CSS'yi kullanın DOSYA birlikte gelen varsayılan stil sayfası yerine mezgit balığı HTML için
çıktı. Belirli sınıfları belirtmelidir: ayrıntılar için varsayılan stil sayfasına bakın.
-p DOSYA, --prolog=DOSYA
Giriş metni içeren bir dosya belirtin.
-t BAŞLIK, --başlık=BAŞLIK
kullanım BAŞLIK belgelerdeki her sayfa için sayfa başlığı olarak. Bu irade
normalde belgelenen kitaplığın adıdır.
Başlık düz bir dize olmalıdır (lütfen işaretleme yapmayın!).
-k ADI, --paket=ADI
Paket adını belirtin (isteğe bağlı).
-n, --no-implicit-prelüd
Prelude'un içe aktarıldığını varsaymayın
-d, - hata ayıklama
Ekstra hata ayıklama çıktısını etkinleştirin.
-?, --yardım et
Yardımı göster.
-V, --versiyon
Ekran sürümü.
-v, --ayrıntılı
Ayrıntılı durum raporlaması.
--kullanım içeriği=URL
Ayrı olarak oluşturulmuş bir HTML içeriği sayfası kullanın.
--gen içeriği
Belirtilen arayüzlerden bir HTML içeriği oluşturun.
--kullanım indeksi=URL
Ayrı olarak oluşturulmuş bir HTML dizini kullanın.
--gen-endeksi
Belirtilen arabirimlerden bir HTML dizini oluşturun.
--yoksay-tüm-ihracat
Tüm modüllerde yoksayma-dışa aktarma özniteliğine sahipmiş gibi davranın
--gizle=MODÜL
gibi davran MODÜL hide özelliğine sahiptir.
--use-paket=PAKET
İşlenmekte olan modüller şunlara bağlıdır: PAKET.
onworks.net hizmetlerini kullanarak mezgit balığını çevrimiçi kullanın
