الحدوق - عبر الإنترنت في السحابة

برنامج:

اسم

الحدوق - أداة توثيق لكود مصدر هاسكل المشروح

موجز

الحدوق [الخيارات] ملف

الوصف

توثق صفحة الدليل هذه بإيجاز ملف الحدوق يأمر. وثائق واسعة النطاق هي
متوفر بتنسيقات أخرى مختلفة بما في ذلك DVI وPostScript وHTML؛ انظر أدناه.

ملف هو اسم ملف يحتوي على وحدة مصدر Haskell. جميع الوحدات المحددة في
ستتم معالجة سطر الأوامر معًا. عندما تشير وحدة واحدة إلى كيان في وحدة أخرى
الوحدة التي تتم معالجتها، سيتم ربط الوثائق مباشرة بهذا الكيان.

الكيانات التي لا يمكن العثور عليها، على سبيل المثال لأنها موجودة في وحدة نمطية غير موجودة
معالجتها كجزء من الدفعة الحالية، ببساطة لن يتم ربطها تشعبيًا في عملية الإنشاء
كابل بيانات. الحدوق سوف ينبعث تحذيرات تسرد جميع المعرفات التي لم يتمكن من ذلك
حل.

لا ينبغي أن تكون الوحدات متكررة بشكل متبادل، كما الحدوق لا يحب السباحة فيه
الدوائر.

OPTIONS

تتبع البرامج الصيغة المعتادة لسطر أوامر جنو ، مع خيارات طويلة تبدأ بخيارين
شرطات ("-"). يتم تضمين ملخص من الخيارات أدناه. للحصول على وصف كامل ، انظر
الوثائق الأخرى.

-o DIR, --أودير=DIR
الدليل الذي سيتم وضع ملفات الإخراج فيه

-i FILE, --قراءة الواجهة =FILE
قراءة واجهة من FILE.

-D FILE, --dump-interface=FILE
تفريغ واجهة لهذه الوحدات في FILE.

-l DIR, --lib =DIR
موقع ملفات هادوك المساعدة

-h, --لغة البرمجة
إنشاء وثائق بتنسيق HTML. سيتم إنشاء العديد من الملفات في ملف
الدليل الحالي (أو الدليل المحدد إذا كان -o يتم إعطاء الخيار)، بما في ذلك
ما يلي:

index.html و
صفحة المستوى الأعلى للوثائق: تسرد الوحدات المتاحة باستخدام
المسافة البادئة لتمثيل التسلسل الهرمي إذا كانت الوحدات هرمية.

الحدوق.css
ورقة الأنماط المستخدمة بواسطة HTML الذي تم إنشاؤه. لا تتردد في تعديل هذا ل
قم بتغيير الألوان أو التخطيط، أو حتى قم بتحديد ورقة الأنماط الخاصة بك باستخدام
--css الخيار.

Module.html
صفحة HTML لكل وحدة.

doc-index.html, وثيقة-فهرس-XX.html
ينقسم الفهرس إلى قسمين (الوظائف/المنشئات والأنواع/الفئات، حسب
مساحات أسماء هاسكل) وتقسيمها أبجديًا.

--hoogle
الإخراج ل Hoogle

--html-help=شكل
إنتاج فهرس وجدول محتويات بتنسيق mshelp أو mshelp2 أو devhelp (مع -h)

--source-base=URL
قم بتضمين روابط إلى الملفات المصدر في الوثائق التي تم إنشاؤها، حيث يكون عنوان URL هو الملف
عنوان URL الأساسي حيث يمكن العثور على الملفات المصدر.

-s URL، --source-module=URL
قم بتضمين روابط إلى الملفات المصدر في الوثائق التي تم إنشاؤها، حيث يكون عنوان URL عبارة عن ملف
رابط الكود المصدري لكل وحدة (باستخدام %{FILE} أو %{MODULE} vars).

--الكيان المصدر =URL
قم بتضمين روابط إلى الملفات المصدر في الوثائق التي تم إنشاؤها، حيث يكون عنوان URL عبارة عن ملف
رابط الكود المصدري لكل كيان (باستخدام %{FILE} أو %{MODULE} أو %{NAME} vars).

--comments-base=URL
عنوان URL لرابط التعليقات على صفحات المحتويات والفهرس.

--comments-module=URL
عنوان URL لرابط التعليقات لكل وحدة (باستخدام %{MODULE} var).

--comments-entity=URL
عنوان URL لرابط التعليقات لكل كيان (باستخدام %{FILE} أو %{MODULE} أو %{NAME}
فار).

--css =FILE
استخدم CSS FILE بدلاً من ورقة الأنماط الافتراضية التي تأتي مع الحدوق لHTML
انتاج. يجب أن تحدد فئات معينة: راجع ورقة الأنماط الافتراضية للحصول على التفاصيل.

-p FILE, --مقدمة=FILE
حدد ملفًا يحتوي على نص المقدمة.

-t TITLE, - العنوان =TITLE
استعمل TITLE كعنوان الصفحة لكل صفحة في الوثائق. هذا سوف
عادة ما يكون اسم المكتبة التي يتم توثيقها.

يجب أن يكون العنوان عبارة عن سلسلة عادية (بدون علامات من فضلك!).

-k اسم, - الحزمة =اسم
حدد اسم الحزمة (اختياري).

-n, --لا مقدمة ضمنية
لا تفترض أن المقدمة مستوردة

-d, --Debug
تمكين إخراج التصحيح الإضافي.

-?, --مساعدة
عرض المساعدة.

-V, --الإصدار
نسخة العرض.

-v, - الإسراف
تقارير الحالة مطولة.

--use-contents=URL
استخدم صفحة محتويات HTML التي تم إنشاؤها بشكل منفصل.

--gen-contents
إنشاء محتويات HTML من واجهات محددة.

--use-index=URL
استخدم فهرس HTML الذي تم إنشاؤه بشكل منفصل.

--gen-index
إنشاء فهرس HTML من واجهات محددة.

--تجاهل جميع الصادرات
تتصرف كما لو أن جميع الوحدات تحتوي على سمة التجاهل للتصدير

--إخفاء=MODULE
تتصرف كما لو MODULE لديه خاصية الإخفاء

--use-package=
تعتمد الوحدات التي تتم معالجتها على .

استخدم الحدوق عبر الإنترنت باستخدام خدمات onworks.net