हैडॉक - क्लाउड में ऑनलाइन

कार्यक्रम:

नाम

हैडॉक - एनोटेटेड हास्केल स्रोत कोड के लिए दस्तावेज़ीकरण उपकरण

SYNOPSIS

हेडेक [विकल्पों] पट्टिका...

वर्णन

यह मैनुअल पेज संक्षेप में दस्तावेज करता है हेडेक आज्ञा। व्यापक दस्तावेज़ीकरण है
डीवीआई, पोस्टस्क्रिप्ट और एचटीएमएल सहित विभिन्न अन्य प्रारूपों में उपलब्ध; नीचे देखें।

पट्टिका एक फ़ाइल नाम है जिसमें हास्केल स्रोत मॉड्यूल है। पर निर्दिष्ट सभी मॉड्यूल
कमांड लाइन को एक साथ संसाधित किया जाएगा। जब एक मॉड्यूल दूसरे में एक इकाई को संदर्भित करता है
मॉड्यूल संसाधित होने पर, दस्तावेज़ सीधे उस इकाई से लिंक हो जाएगा।

उदाहरण के लिए, वे संस्थाएँ नहीं पाई जा सकतीं, क्योंकि वे एक ऐसे मॉड्यूल में हैं जो नहीं पाया जा रहा है
वर्तमान बैच के हिस्से के रूप में संसाधित, जेनरेट में हाइपरलिंक नहीं किया जाएगा
प्रलेखन। हेडेक उन सभी पहचानकर्ताओं को सूचीबद्ध करते हुए चेतावनियाँ उत्सर्जित करेगा जिन्हें वह नहीं कर सका
संकल्प।

मॉड्यूल परस्पर पुनरावर्ती नहीं होने चाहिए, जैसे हेडेक में तैरना पसंद नहीं है
हलकों।

विकल्प

प्रोग्राम सामान्य जीएनयू कमांड लाइन सिंटैक्स का पालन करते हैं, जिसमें लंबे विकल्प दो से शुरू होते हैं
डैश (`--'). विकल्पों का सारांश नीचे शामिल है। संपूर्ण विवरण के लिए देखें
अन्य दस्तावेज.

-o डीआईआर, --ओडिर=डीआईआर
वह निर्देशिका जिसमें आउटपुट फ़ाइलें डालनी हैं

-i फ़ाइल, --पढ़ें-इंटरफ़ेस=फ़ाइल
से एक इंटरफ़ेस पढ़ें फ़ाइल.

-D फ़ाइल, --डंप-इंटरफ़ेस=फ़ाइल
इन मॉड्यूल के लिए एक इंटरफ़ेस डंप करें फ़ाइल.

-l डीआईआर, --lib=डीआईआर
हैडॉक की सहायक फ़ाइलों का स्थान

-h, --एचटीएमएल
HTML प्रारूप में दस्तावेज़ तैयार करें. में कई फ़ाइलें जनरेट की जाएंगी
वर्तमान निर्देशिका (या निर्दिष्ट निर्देशिका यदि -o विकल्प दिया गया है), सहित
निम्नलिखित हैं:

सूचकांक
दस्तावेज़ीकरण का शीर्ष स्तरीय पृष्ठ: उपयोग करके उपलब्ध मॉड्यूल सूचीबद्ध करता है
यदि मॉड्यूल पदानुक्रमित हैं तो पदानुक्रम का प्रतिनिधित्व करने के लिए इंडेंटेशन।

Haddock.css
जनरेट किए गए HTML द्वारा उपयोग की जाने वाली स्टाइलशीट। इसे संशोधित करने के लिए स्वतंत्र महसूस करें
रंग या लेआउट बदलें, या यहां तक ​​कि इसका उपयोग करके अपनी स्वयं की स्टाइलशीट भी निर्दिष्ट करें
--सीएसएस विकल्प.

मॉड्यूल.एचटीएमएल
प्रत्येक मॉड्यूल के लिए एक HTML पेज.

डॉक्टर-index.html, डॉक्टर-सूचकांक-XX.html
सूचकांक, दो (फ़ंक्शन/कंस्ट्रक्टर और प्रकार/वर्ग, के अनुसार) में विभाजित है
हास्केल नेमस्पेस) और आगे वर्णानुक्रम में विभाजित किया गया।

--हूगल
हुगल के लिए आउटपुट

--एचटीएमएल-सहायता=प्रारूप
MShelp, mshelp2 या devhelp प्रारूप में अनुक्रमणिका और सामग्री तालिका तैयार करें (साथ)। -h)

--स्रोत-आधार=यूआरएल
जेनरेट किए गए दस्तावेज़ में स्रोत फ़ाइलों के लिंक शामिल करें, जहां यूआरएल है
आधार URL जहां स्रोत फ़ाइलें पाई जा सकती हैं।

-s यूआरएल, --स्रोत-मॉड्यूल=यूआरएल
जेनरेट किए गए दस्तावेज़ में स्रोत फ़ाइलों के लिंक शामिल करें, जहां यूआरएल है
प्रत्येक मॉड्यूल के लिए स्रोत कोड लिंक (%{FILE} या %{MODULE} वर्र्स का उपयोग करके)।

--स्रोत-इकाई=यूआरएल
जेनरेट किए गए दस्तावेज़ में स्रोत फ़ाइलों के लिंक शामिल करें, जहां यूआरएल है
प्रत्येक इकाई के लिए स्रोत कोड लिंक (%{FILE}, %{MODULE} या %{NAME} वर्र्स का उपयोग करके)।

--टिप्पणियाँ-आधार=यूआरएल
सामग्री और अनुक्रमणिका पृष्ठों पर टिप्पणी लिंक के लिए यूआरएल।

--टिप्पणियाँ-मॉड्यूल=यूआरएल
प्रत्येक मॉड्यूल के लिए टिप्पणी लिंक का यूआरएल (%{MODULE} var का उपयोग करके)।

--टिप्पणियाँ-इकाई=यूआरएल
प्रत्येक इकाई के लिए टिप्पणी लिंक का यूआरएल (%{FILE}, %{MODULE} या %{NAME} का उपयोग करके)
वार्स)।

--सीएसएस=फ़ाइल
सीएसएस का प्रयोग करें फ़ाइल इसके साथ आने वाली डिफ़ॉल्ट स्टाइलशीट के बजाय हेडेक एचटीएमएल के लिए
आउटपुट. इसमें कुछ वर्ग निर्दिष्ट होने चाहिए: विवरण के लिए डिफ़ॉल्ट स्टाइलशीट देखें।

-p फ़ाइल, --प्रस्तावना=फ़ाइल
प्रस्तावना पाठ वाली फ़ाइल निर्दिष्ट करें।

-t शीर्षक, --शीर्षक=शीर्षक
उपयोग शीर्षक दस्तावेज़ में प्रत्येक पृष्ठ के लिए पृष्ठ शीर्षक के रूप में। यह करेगा
आम तौर पर दस्तावेज़ीकृत की जा रही लाइब्रेरी का नाम होना चाहिए।

शीर्षक एक सादा स्ट्रिंग होना चाहिए (कृपया कोई मार्कअप नहीं!)।

-k नाम, --पैकेज=नाम
पैकेज का नाम निर्दिष्ट करें (वैकल्पिक)।

-n, --नहीं-निहित-प्रस्तावना
यह न मानें कि प्रस्तावना आयातित है

-d, - दाढ़
अतिरिक्त डिबगिंग आउटपुट सक्षम करें.

-?, --मदद
सहायता प्रदर्शित करें।

-V, --संस्करण
प्रदर्शन संस्करण।

-v, --शब्दशः
वर्बोज़ स्थिति रिपोर्टिंग.

--उपयोग-सामग्री=यूआरएल
एक अलग से जेनरेट किए गए HTML सामग्री पृष्ठ का उपयोग करें।

--जन-सामग्री
निर्दिष्ट इंटरफ़ेस से एक HTML सामग्री उत्पन्न करें।

--उपयोग-सूचकांक=यूआरएल
अलग से जेनरेट किए गए HTML इंडेक्स का उपयोग करें.

--जेन-सूचकांक
निर्दिष्ट इंटरफ़ेस से एक HTML इंडेक्स जेनरेट करें।

--अनदेखा-सभी-निर्यात
ऐसा व्यवहार करें मानो सभी मॉड्यूल में अनदेखा-निर्यात विशेषता हो

--छिपाना=मॉड्यूल
जैसा व्यवहार करो मॉड्यूल छिपाने की विशेषता है.

--उपयोग-पैकेज=पैकेज
संसाधित किये जा रहे मॉड्यूल इस पर निर्भर करते हैं पैकेज.

onworks.net सेवाओं का उपयोग करके हैडॉक का ऑनलाइन उपयोग करें