haddock - آنلاین در ابر

برنامه:

نام

haddock - ابزار مستندسازی برای کد منبع Haskell مشروح

خلاصه

ماهی روغن کوچک [گزینه های] پرونده...

شرح

این صفحه راهنما به اختصار مستندات ماهی روغن کوچک فرمان مستندات گسترده است
در قالب های مختلف دیگر از جمله DVI، PostScript و HTML موجود است. زیر را ببینید.

پرونده نام فایل حاوی یک ماژول منبع Haskell است. تمام ماژول های مشخص شده در
خط فرمان با هم پردازش خواهد شد. وقتی یک ماژول به یک موجودیت در دیگری اشاره می کند
ماژول در حال پردازش است، اسناد به طور مستقیم به آن موجودیت مرتبط می شود.

موجودیت هایی که نمی توان آنها را پیدا کرد، برای مثال به دلیل اینکه در ماژولی هستند که وجود ندارد
پردازش شده به عنوان بخشی از دسته فعلی، به سادگی در تولید شده پیوند داده نخواهد شد
مستندات. ماهی روغن کوچک اخطارهایی را منتشر می کند که تمام شناسه هایی را که نمی تواند فهرست می کند
برطرف کردن.

ماژول ها نباید متقابلاً بازگشتی باشند ماهی روغن کوچک شنا کردن را دوست ندارد
حلقه ها

OPTIONS

برنامه ها از دستور خط فرمان معمول گنو پیروی می کنند، با گزینه های طولانی که با دو شروع می شود
خط تیره ('--'). خلاصه ای از گزینه ها در زیر گنجانده شده است. برای توضیحات کامل رجوع کنید
اسناد دیگر

-o DIR, --odir=DIR
دایرکتوری که فایل های خروجی را در آن قرار دهید

-i فایل, --read-interface=فایل
خواندن یک رابط از فایل.

-D فایل, --dump-interface=فایل
یک اینترفیس برای این ماژول ها داخل آن قرار دهید فایل.

-l DIR, --lib=DIR
محل فایل های کمکی هادوک

-h, --html
ایجاد اسناد در قالب HTML. چندین فایل در آن تولید خواهد شد
دایرکتوری فعلی (یا دایرکتوری مشخص شده اگر -o گزینه داده شده است)، از جمله
به شرح زیر است:

index.html به
صفحه سطح بالای مستندات: ماژول های موجود را با استفاده از فهرست فهرست می کند
تورفتگی برای نشان دادن سلسله مراتب اگر ماژول ها سلسله مراتبی هستند.

haddock.css
شیوه نامه استفاده شده توسط HTML تولید شده. این را به راحتی تغییر دهید
رنگ ها یا چیدمان را تغییر دهید، یا حتی صفحه سبک خود را با استفاده از آن مشخص کنید
--css گزینه.

module.html
یک صفحه HTML برای هر ماژول.

doc-index.html, doc-index-XX.html
این شاخص، به دو (توابع/سازنده و انواع/کلاس‌ها، مطابق با) تقسیم می‌شود
فضاهای نام Haskell) و بیشتر بر اساس حروف الفبا تقسیم می شوند.

-- هوگل
خروجی برای هوگل

--html-help=قالب
فهرست و فهرست مطالب را با فرمت mshelp، mshelp2 یا devhelp (با -h)

--source-base=URL
پیوندهایی را به فایل‌های منبع در مستندات ایجاد شده، جایی که URL است، اضافه کنید
URL پایه که در آن می توان فایل های منبع را پیدا کرد.

-s URL ، --source-module=URL
پیوندهایی را به فایل‌های منبع در مستندات تولید شده اضافه کنید، جایی که URL یک است
پیوند کد منبع برای هر ماژول (با استفاده از متغیرهای %{FILE} یا %{MODULE}).

--source-entity=URL
پیوندهایی را به فایل‌های منبع در مستندات تولید شده اضافه کنید، جایی که URL یک است
پیوند کد منبع برای هر موجودیت (با استفاده از متغیرهای %{FILE}، %{MODULE} یا %{NAME}).

--comments-base=URL
URL برای پیوند نظرات در مطالب و صفحات فهرست.

--comments-module=URL
URL برای پیوند نظرات برای هر ماژول (با استفاده از %{MODULE} var).

--comments-entity=URL
URL برای پیوند نظرات برای هر نهاد (با استفاده از %{FILE}، %{MODULE} یا %{NAME}
vars).

--css=فایل
از CSS استفاده کنید فایل به جای شیوه نامه پیش فرضی که همراه با آن ارائه می شود ماهی روغن کوچک برای HTML
خروجی باید کلاس های خاصی را مشخص کند: برای جزئیات به شیوه نامه پیش فرض مراجعه کنید.

-p فایل, --پرولوگ=فایل
یک فایل حاوی متن مقدمه را مشخص کنید.

-t TITLE, --عنوان=TITLE
استفاده کنید TITLE به عنوان عنوان صفحه برای هر صفحه در مستندات. این اراده
معمولاً نام کتابخانه ای است که مستند می شود.

عنوان باید یک رشته ساده باشد (بدون نشانه گذاری لطفا!).

-k نام, -- بسته =نام
نام بسته را مشخص کنید (اختیاری).

-n, --بدون مقدمه ضمنی
فرض نکنید که Prelude وارد شده است

-d, - رفع اشکال
خروجی دیباگ اضافی را فعال کنید.

-?, --کمک
نمایش راهنما

-V, - نسخه
نمایش نسخه.

-v, -- پرحرف
گزارش وضعیت مفصل

--use-contents=URL
از یک صفحه محتویات HTML تولید شده جداگانه استفاده کنید.

-- ژن-محتوا
محتوای HTML را از رابط های مشخص شده ایجاد کنید.

--use-index=URL
از یک نمایه HTML تولید شده جداگانه استفاده کنید.

---gen-index
یک فهرست HTML از رابط های مشخص شده ایجاد کنید.

--نادیده گرفتن-همه-صادرات
طوری رفتار کنید که انگار همه ماژول ها دارای ویژگی ignore-exports هستند

-- پنهان =MODULE
طوری رفتار کن که انگار MODULE دارای ویژگی hide است.

--use-package=بسته
ماژول های در حال پردازش بستگی به بسته.

با استفاده از خدمات onworks.net از هادوک به صورت آنلاین استفاده کنید