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

कार्यक्रम:

नाम

एलडॉक - एक LuaDoc-संगत दस्तावेज़ निर्माण प्रणाली

वर्णन

LDoc, Lua के लिए एक दस्तावेज़ीकरण जनरेटर जो LuaDoc के अनुकूल है।

विकल्प

-डी, --दिरो
(डिफ़ॉल्ट दस्तावेज़) आउटपुट निर्देशिका

-ओ, --आउटपुट
(डिफ़ॉल्ट 'इंडेक्स') आउटपुट नाम

-में, --शब्दशः
दस्तावेज़ निर्माण के दौरान क्रियात्मक रहें

-ए --सब
दस्तावेज़ों में स्थानीय फ़ंक्शन आदि दिखाएं

-क्यू, --शांत
आउटपुट दबाएं

-एम, --मापांक
मॉड्यूल दस्तावेज़ पाठ के रूप में

-एस, --अंदाज
(डिफ़ॉल्ट!) स्टाइल शीट के लिए निर्देशिका (ldoc.css)

-एल, --टेम्पलेट
(डिफ़ॉल्ट!) टेम्पलेट के लिए निर्देशिका (ldoc.ltp)

-पी, --परियोजना
(डिफ़ॉल्ट एलडॉक) प्रोजेक्ट नाम

-टी, --शीर्षक
(डिफ़ॉल्ट संदर्भ) पृष्ठ शीर्षक

-एफ, --प्रारूप
(डिफ़ॉल्ट सादा) फ़ॉर्मेटिंग, वैध विकल्प मार्कडाउन, डिस्काउंट या सादा हैं

-बी, --पैकेज
(डिफ़ॉल्ट।) शीर्ष-स्तरीय पैकेज बेसनाम (के लिए आवश्यक)। मॉड्यूल(...))

-एक्स, --ext
(डिफ़ॉल्ट html) आउटपुट फ़ाइल एक्सटेंशन

-सी, --कॉन्फ़िगरेशन
(डिफ़ॉल्ट config.ld) कॉन्फ़िगरेशन नाम

-मैं, --अनदेखा करना
किसी भी 'कोई दस्तावेज़ टिप्पणी या कोई मॉड्यूल नहीं' चेतावनियों को अनदेखा करें

-एक्स, --not_luadoc
LuaDoc अनुकूलता को तोड़ें। टैग के बाद विवरण जारी रह सकते हैं।

-डी, --परिभाषित करें
(डिफ़ॉल्ट कोई नहीं) config.ld में उपयोग के लिए एक ध्वज सेट करें

-सी, --कोलन
कोलन शैली का प्रयोग करें

-बी, --बॉयलरप्लेट
स्रोत फ़ाइलों में पहली टिप्पणी को अनदेखा करें

-एम, --मर्ज
मॉड्यूल विलय की अनुमति दें

-एस, --सरल
कोई रिटर्न या पैरामीटर नहीं, कोई सारांश नहीं

-ओ, --एक
एक-स्तंभ आउटपुट लेआउट

--गंदी जगह डीबग आउटपुट डंप

--फ़िल्टर
(डिफ़ॉल्ट कोई नहीं) आउटपुट को लुआ डेटा के रूप में फ़िल्टर करें (उदाहरण के लिए pl.pretty.dump)

--टैग (डिफ़ॉल्ट कोई नहीं) दिए गए टैग के सभी संदर्भ अल्पविराम से अलग करके दिखाएं

(स्ट्रिंग) स्रोत फ़ाइल या स्रोत युक्त निर्देशिका

उदाहरण

एलडॉक . उसी निर्देशिका में config.ld फ़ाइल से विकल्प पढ़ता है

एलडॉक -c पथ/से/myconfig.ld .
path/to/myconfig.ld से विकल्प पढ़ता है

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