ocamldoc.opt - क्लाउड में ऑनलाइन

कार्यक्रम:

नाम

ocamldoc - OCaml दस्तावेज़ीकरण जनरेटर

SYNOPSIS

ओकैमल्डोक [ विकल्पों ] फ़ाइल का नाम ...

वर्णन

OCaml दस्तावेज़ीकरण जनरेटर ओकैमल्डोक(1) विशेष से दस्तावेज़ तैयार करता है
टिप्पणियाँ स्रोत फ़ाइलों में एम्बेडेड हैं। द्वारा उपयोग की गई टिप्पणियाँ ओकैमल्डोक स्वरूप के हैं (** ...
*) और में वर्णित प्रारूप का पालन करें RSI OCaml उपयोगकर्ता की गाइड.

ओकैमल्डोक विभिन्न स्वरूपों में दस्तावेज़ तैयार कर सकता है: HTML, LaTeX, TeXinfo, Unix man
पृष्ठ, और डॉट(1) निर्भरता ग्राफ़। इसके अलावा, उपयोगकर्ता अपने स्वयं के कस्टम जनरेटर जोड़ सकते हैं।

इस मैनपेज में, हम शब्द का उपयोग करते हैं तत्व किसी के निम्नलिखित भागों में से किसी को संदर्भित करने के लिए
OCaml स्रोत फ़ाइल: एक प्रकार की घोषणा, एक मान, एक मॉड्यूल, एक अपवाद, एक मॉड्यूल प्रकार, ए
टाइप कंस्ट्रक्टर, एक रिकॉर्ड फ़ील्ड, एक क्लास, एक क्लास प्रकार, एक क्लास विधि, एक क्लास वैल्यू या
एक वर्ग विरासत खंड.

विकल्प

निम्नलिखित कमांड-लाइन विकल्प जेनरेट किए गए दस्तावेज़ के लिए प्रारूप निर्धारित करते हैं
द्वारा उत्पन्न ओकैमल्डोक(1).

ऑप्शंस एसटी चुनने la उत्पादन प्रारूप
-एचटीएमएल HTML डिफ़ॉल्ट प्रारूप में दस्तावेज़ तैयार करें। जेनरेट किए गए HTML पेज संग्रहीत हैं
वर्तमान निर्देशिका में, या के साथ निर्दिष्ट निर्देशिका में -d विकल्प। आप ऐसा कर सकते हैं
जनरेट किए गए पृष्ठों को संपादित करके उनकी शैली को अनुकूलित करें style.css फ़ाइल,
या विकल्प का उपयोग करके अपनी स्वयं की स्टाइल शीट प्रदान करके -सीएसएस-शैली. फ़ाइल style.css
यदि यह पहले से मौजूद है तो उत्पन्न नहीं होता है।

-लेटेक्स LaTeX डिफ़ॉल्ट प्रारूप में दस्तावेज़ तैयार करें। जनरेट किया गया LaTeX दस्तावेज़ है
फ़ाइल में सहेजा गया ocamldoc.out, या के साथ निर्दिष्ट फ़ाइल में -o विकल्प।
दस्तावेज़ शैली फ़ाइल का उपयोग करता है ocamldoc.sty. का उपयोग करते समय यह फ़ाइल उत्पन्न होती है
-लेटेक्स विकल्प, यदि यह पहले से मौजूद नहीं है। आप इस फ़ाइल को अनुकूलित करने के लिए बदल सकते हैं
आपके LaTeX दस्तावेज़ की शैली।

-टेक्सी TeXinfo डिफ़ॉल्ट प्रारूप में दस्तावेज़ तैयार करें। जनरेट किया गया LaTeX दस्तावेज़ है
फ़ाइल में सहेजा गया ocamldoc.out, या के साथ निर्दिष्ट फ़ाइल में -o विकल्प.

-आदमी यूनिक्स मैन पेजों के एक सेट के रूप में दस्तावेज़ तैयार करें। जेनरेट किए गए पेज संग्रहीत हैं
वर्तमान निर्देशिका में, या के साथ निर्दिष्ट निर्देशिका में -d विकल्प.

-बिंदु शीर्ष स्तर के मॉड्यूल के लिए उपयुक्त प्रारूप में एक निर्भरता ग्राफ तैयार करें
द्वारा प्रदर्शित एवं संसाधित करना डॉट(1)। डॉट(1) टूल यहां से उपलब्ध है
http://www.research.att.com/sw/tools/graphviz/. का शाब्दिक प्रतिनिधित्व
ग्राफ़ फ़ाइल में लिखा गया है ocamldoc.out, या के साथ निर्दिष्ट फ़ाइल में -o
विकल्प। प्रयोग करें डॉट ocamldoc.out इसे प्रदर्शित करने के लिए

-g पट्टिका
दी गई फ़ाइल को गतिशील रूप से लोड करें (जो एक्सटेंशन आमतौर पर .cmo या .cma है), जो
एक कस्टम दस्तावेज़ जनरेटर को परिभाषित करता है। यदि दी गई फ़ाइल सरल है और
तो, वर्तमान निर्देशिका में मौजूद नहीं है ओकैमल्डोक कस्टम में इसकी तलाश करता है
जनरेटर डिफ़ॉल्ट निर्देशिका, और के साथ निर्दिष्ट निर्देशिकाओं में -i विकल्प.

-कस्टमडिर
कस्टम जेनरेटर डिफ़ॉल्ट निर्देशिका प्रदर्शित करें।

-i डायरेक्टरी
दी गई निर्देशिका को उस पथ में जोड़ें जहां कस्टम जेनरेटर देखना है।

सामान्य जानकारी विकल्पों
-d दीर निर्देशिका में फ़ाइलें जनरेट करें दीर, वर्तमान निर्देशिका के बजाय।

-डंप करना पट्टिका
एकत्रित जानकारी को इसमें डंप करें पट्टिका. यह जानकारी इसके साथ पढ़ी जा सकती है -भार
के बाद के आह्वान में विकल्प ओकैमल्डोक(1).

-छिपाना मॉड्यूल
जनरेट किए गए दस्तावेज़ में दिए गए संपूर्ण मॉड्यूल नाम छिपाएँ। मॉड्यूल एक
पूर्ण मॉड्यूल नामों की सूची रिक्त स्थान के बिना, अल्पविराम (,) द्वारा अलग की जाती है। के लिए
उदाहरण: व्यापक,एम2.एम3.

-इन्व-मर्ज-एमएल-एमएलआई
विलय करते समय कार्यान्वयन और इंटरफ़ेस की प्राथमिकता को उलट दें। सभी
कार्यान्वयन फ़ाइलों में तत्व रखे जाते हैं, और -m विकल्प इंगित करता है कि कौन से भाग हैं
इंटरफ़ेस फ़ाइलों में से कुछ टिप्पणियाँ कार्यान्वयन में टिप्पणियों के साथ विलय कर दी जाती हैं
फाइलें.

-रखें-कोड
मूल्यों, विधियों और उदाहरण चर के लिए स्रोत कोड हमेशा रखें
उपलब्ध। जब कोई .ml फ़ाइल दी जाती है तो स्रोत कोड हमेशा रखा जाता है, लेकिन इसके द्वारा रखा जाता है
जब .mli दिया जाता है तो डिफ़ॉल्ट खारिज कर दिया जाता है। यह विकल्प स्रोत कोड की अनुमति देता है
हमेशा रखा.

-भार पट्टिका
से जानकारी लोड करें पट्टिका, जिसका निर्माण किया गया है ओकैमल्डोक -डंप करना। कई
-भार विकल्प दिये जा सकते हैं.

-m झंडे
इंटरफ़ेस और कार्यान्वयन के बीच मर्ज विकल्प निर्दिष्ट करें। झंडे एक या हो सकता है
निम्नलिखित में से कई पात्र:

d मर्ज विवरण

a @लेखक को मर्ज करें

v @संस्करण मर्ज करें

l विलय @देखें

s @से मर्ज करें

o मर्ज @बहिष्कृत

p @परम को मर्ज करें

e @raise मर्ज करें

r मर्ज @वापसी

A सब कुछ मिला दो

-कोई-कस्टम-टैग नहीं
कस्टम @-टैग की अनुमति न दें.

-कोई रोक नहिं
तत्वों को के बाद रखें (**/**) विशेष टिप्पणी.

-o पट्टिका
जेनरेट किए गए दस्तावेज़ को आउटपुट करें पट्टिका के बजाय ocamldoc.out. यह विकल्प है
के संयोजन से ही सार्थक है -लेटेक्स, -टेक्सीया, -बिंदु विकल्प.

पीपी आदेश
प्रीप्रोसेसर के माध्यम से पाइप स्रोत आदेश.

-पीपीएक्स आदेश
प्रीप्रोसेसर के माध्यम से पाइप अमूर्त सिंटैक्स ट्री आदेश.

-सॉर्ट दस्तावेज़ तैयार करने से पहले शीर्ष-स्तरीय मॉड्यूल की सूची को क्रमबद्ध करें।

-सितारे टिप्पणियों की प्रत्येक पंक्ति में पहले तारांकन चिह्न ('*') तक रिक्त वर्ण हटाएँ।

-t शीर्षक
उपयोग शीर्षक उत्पन्न दस्तावेज़ के शीर्षक के रूप में।

परिचय पट्टिका
की सामग्री का उपयोग करें पट्टिका as ओकैमल्डोक परिचय के रूप में उपयोग करने के लिए पाठ (HTML, LaTeX और
केवल TeXinfo)। HTML के लिए, फ़ाइल का उपयोग संपूर्ण "index.html" फ़ाइल बनाने के लिए किया जाता है।

-v वाचाल प्रकार। प्रगति की जानकारी प्रदर्शित करें.

-संस्करण
प्रिंट संस्करण स्ट्रिंग और बाहर निकलें।

-वनुम संक्षिप्त संस्करण संख्या प्रिंट करें और बाहर निकलें।

-चेतावनी-त्रुटि
उपचार ओकैमल्डोक त्रुटियों के रूप में चेतावनियाँ।

-छिपाएँ-चेतावनी
मत छापो ओकैमल्डोक चेतावनियाँ।

-मदद or --मदद
एक संक्षिप्त उपयोग सारांश प्रदर्शित करें और बाहर निकलें।

प्रकार-चेकिंग विकल्पों
ओकैमल्डोक(1) प्रकार की जानकारी प्राप्त करने के लिए OCaml टाइप-चेकर को कॉल करता है। निम्नलिखित विकल्प
टाइप-चेकिंग चरण को प्रभावित करें। उनका वही अर्थ है जो के लिए है
ocamlc(1) और ओकामलोप्ट(1) आज्ञा।

-I डायरेक्टरी
डायरेक्टरी निर्देशिकाओं की सूची में संकलित इंटरफ़ेस फ़ाइलें खोजें (.cmi
फ़ाइलें)।

-नोलेबल्स
प्रकारों में गैर-वैकल्पिक लेबलों पर ध्यान न दें।

-रेक्टटाइप्स
मनमाने ढंग से पुनरावर्ती प्रकारों की अनुमति दें। (देखें -रेक्टटाइप्स विकल्प ocamlc(1)।)

ऑप्शंस एसटी सृजन एचटीएमएल पृष्ठों
निम्नलिखित विकल्प इसके साथ संयोजन में लागू होते हैं -एचटीएमएल विकल्प:

-सभी-परम
फ़ंक्शंस और विधियों के लिए पैरामीटर की पूरी सूची प्रदर्शित करें।

-सीएसएस-शैली फ़ाइल का नाम
उपयोग फ़ाइल का नाम कैस्केडिंग स्टाइल शीट फ़ाइल के रूप में।

-रंग-कोड
जोर देने के लिए रंगों का उपयोग करके, [ ] और \{[ ]\} में संलग्न OCaml कोड को रंगीन करें
कीवर्ड, आदि। यदि कोड के टुकड़े वाक्य रचना की दृष्टि से सही नहीं हैं, तो कोई रंग नहीं है
जोड़ा।

-केवल-सूचकांक
केवल अनुक्रमणिका फ़ाइलें जनरेट करें.

-शॉर्ट-फ़ंक्टर
फ़ंक्टर प्रदर्शित करने के लिए संक्षिप्त रूप का उपयोग करें: मॉड्यूल M : फ़ैक्टर (ए:मॉड्यूल) -> फ़ैक्टर
(बी:मॉड्यूल2) -> हस्ताक्षर .. समाप्त के रूप में प्रदर्शित किया जाता है मॉड्यूल M (ए:मॉड्यूल) (बी:मॉड्यूल2) : हस्ताक्षर ..
समाप्त.

ऑप्शंस एसटी सृजन LaTeX फ़ाइलों
निम्नलिखित विकल्प इसके साथ संयोजन में लागू होते हैं -लेटेक्स विकल्प:

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

ये विकल्प तब उपयोगी होते हैं जब आपके पास, उदाहरण के लिए, एक प्रकार और एक मान होता है
एक ही नाम। यदि आप उपसर्ग निर्दिष्ट नहीं करते हैं, तो LaTeX गुणा के बारे में शिकायत करेगा
परिभाषित लेबल.

-लेटेक्सटाइटल एन,शैली
सहयोगी शैली संख्या n दिए गए LaTeX सेक्शनिंग कमांड के लिए अंदाज, उदा
अनुभागorउपधारा. (केवल LaTeX।) जेनरेटेड को शामिल करते समय यह उपयोगी होता है
किसी अन्य LaTeX दस्तावेज़ में, किसी दिए गए सेक्शनिंग स्तर पर दस्तावेज़। डिफ़ॉल्ट
एसोसिएशन अनुभाग के लिए 1, उपधारा के लिए 2, उपधारा के लिए 3, 4 के लिए है
पैराग्राफ और उपपैराग्राफ के लिए 5।

-कोई रहनुमा नहीं
जनरेट किए गए दस्तावेज़ में हेडर को दबाएँ।

-नोटोक विषय-वस्तु की तालिका न बनाएं.

-नोट्रेलर
जेनरेट किए गए दस्तावेज़ में ट्रेलर को दबाएँ।

-sepfiles
वैश्विक के बजाय, प्रति टॉपलेवल मॉड्यूल में एक .tex फ़ाइल जेनरेट करें ocamldoc.out
फ़ाइल.

ऑप्शंस एसटी सृजन TeXinfo फ़ाइलों
निम्नलिखित विकल्प इसके साथ संयोजन में लागू होते हैं -टेक्सी विकल्प:

-esc8 जानकारी फ़ाइलों में उच्चारण वर्णों से बचें।

-जानकारी-प्रविष्टि
जानकारी निर्देशिका प्रविष्टि निर्दिष्ट करें.

-जानकारी-अनुभाग
जानकारी निर्देशिका का अनुभाग निर्दिष्ट करें.

-कोई रहनुमा नहीं
जनरेट किए गए दस्तावेज़ में हेडर को दबाएँ।

-नोइंडेक्स
जानकारी फ़ाइलों के लिए अनुक्रमणिका न बनाएं.

-नोट्रेलर
जेनरेट किए गए दस्तावेज़ में ट्रेलर को दबाएँ।

ऑप्शंस एसटी सृजन डॉट रेखांकन
निम्नलिखित विकल्प इसके साथ संयोजन में लागू होते हैं -बिंदु विकल्प:

-बिंदु-रंग रंग
जेनरेट किए गए डॉट कोड में उपयोग करने के लिए रंग निर्दिष्ट करें। मॉड्यूल बनाते समय
निर्भरताएँ, ओकैमल्डोक(1) मॉड्यूल के लिए अलग-अलग रंगों का उपयोग करता है, जो इस पर निर्भर करता है
वे निर्देशिकाएँ जिनमें वे रहते हैं। प्रकार निर्भरताएँ उत्पन्न करते समय, ओकैमल्डोक(1)
प्रकारों के लिए अलग-अलग रंगों का उपयोग करता है, यह इस बात पर निर्भर करता है कि वे किस मॉड्यूल में हैं
परिभाषित। रंग अल्पविराम (,) द्वारा अलग किए गए रंग नामों की एक सूची है, जैसे कि
लाल, नीला, हरा. उपलब्ध रंग वे हैं जो इसके द्वारा समर्थित हैं डॉट(1) उपकरण।

-डॉट-इनक्लूड-ऑल
में सभी मॉड्यूल शामिल करें डॉट(1) आउटपुट, न केवल कमांड पर दिए गए मॉड्यूल
लाइन या के साथ लोड किया गया -भार विकल्प.

-डॉट-कम करें
डॉट आउटपुट करने से पहले निर्भरता ग्राफ की एक सकर्मक कमी करें
कोड. यह उपयोगी हो सकता है यदि बहुत सारी सकर्मक निर्भरताएँ अव्यवस्थित हों
लेखाचित्र।

-डॉट-प्रकार
आउटपुट डॉट कोड मॉड्यूल के बजाय प्रकार निर्भरता ग्राफ का वर्णन करता है
निर्भरता ग्राफ.

ऑप्शंस एसटी सृजन आदमी फ़ाइलों
निम्नलिखित विकल्प इसके साथ संयोजन में लागू होते हैं -आदमी विकल्प:

-आदमी-मिनी
इसके बजाय, केवल मॉड्यूल, मॉड्यूल प्रकार, क्लास और क्लास प्रकार के लिए मैन पेज जेनरेट करें
सभी तत्वों के लिए पृष्ठों की संख्या.

-आदमी-प्रत्यय प्रत्यय
जनरेट किए गए मैन फ़ाइल नाम के लिए प्रयुक्त प्रत्यय सेट करें। डिफ़ॉल्ट ओ है, जैसे कि सूची.ओ.

-मानव-अनुभाग अनुभाग
जनरेट किए गए मैन फ़ाइल नाम के लिए उपयोग की जाने वाली अनुभाग संख्या सेट करें। डिफ़ॉल्ट 3 है.

onworks.net सेवाओं का उपयोग करके ocamldoc.opt का ऑनलाइन उपयोग करें