यह कमांड ऑटोग्सडॉक है जिसे हमारे कई मुफ्त ऑनलाइन वर्कस्टेशन जैसे उबंटू ऑनलाइन, फेडोरा ऑनलाइन, विंडोज ऑनलाइन एमुलेटर या मैक ओएस ऑनलाइन एमुलेटर में से एक का उपयोग करके ऑनवर्क्स फ्री होस्टिंग प्रदाता में चलाया जा सकता है।
कार्यक्रम:
नाम
autogsdoc - GNUstep API प्रलेखन जनरेटर और XML->HTML कनवर्टर
SYNOPSIS
ऑटोग्सडॉक [-फाइल्स फ़ाइल का नाम] [-जनरेट एचटीएमएल हाँ|नहीं] [-स्वच्छ हाँ|नहीं] [-क्लीनटेम्पलेट्स
हाँ|नहीं] [-अनदेखा निर्भरता हाँ|नहीं] [-मेक डिपेंडेंसी हाँ|नहीं] [-शो निर्भरता हाँ|नहीं]
[-हैडरडायरेक्टरी पथ] [-दस्तावेज़ीकरण निर्देशिका पथ] [-घोषित स्थान ] [-प्रयोग करें
शीर्षक] [-मानक हाँ|नहीं] [-DocumentAllInstanceVariables हाँ|नहीं]
[-दस्तावेज़ उदाहरण चर हाँ|नहीं] [-InstanceVariablesAtEnd हाँ|नहीं] [-स्थिरांकटेम्पलेट
फ़ाइल का नाम] [-कार्य टेम्पलेट फ़ाइल का नाम] [-मैक्रोसटेम्पलेट फ़ाइल का नाम] [-टाइपपीफ्सटेम्पलेट
फ़ाइल का नाम] [-चर टेम्पलेट फ़ाइल का नाम] [-सिस्टम प्रोजेक्ट्स स्ट्रिंग] [-स्थानीय परियोजनाएं स्ट्रिंग]
[-परियोजनाएं तानाशाही] [-verbose हाँ|नहीं] [-चेतावनी हाँ|नहीं] [-वर्डमैप तानाशाही] [फ़ाइलों]
वर्णन
Autogsdoc टूल एक कमांड-लाइन उपयोगिता है जो डेवलपर्स को संदर्भ उत्पन्न करने में मदद करती है
जीएनयूस्टेप एपीआई के लिए दस्तावेज। यह डेवलपर्स को अन्य लिखने और बनाए रखने में भी सक्षम बनाता है
एक्सएमएल में दस्तावेज़ीकरण और इसे एचटीएमएल में परिवर्तित कर दिया है। विस्तार से, autogsdoc करेगा:
- वर्गों, श्रेणियों के सार्वजनिक इंटरफेस का वर्णन करते हुए विशेष टिप्पणियां निकालें,
उद्देश्य सी स्रोत कोड से प्रोटोकॉल, फ़ंक्शन और मैक्रोज़ (हेडर फ़ाइलें और
वैकल्पिक रूप से स्रोत फ़ाइलें) GSDoc XML फ़ाइलों में।
- जीएसडॉक एक्सएमएल फाइलों को कनवर्ट करें, चाहे स्रोत कोड से उत्पन्न हो या मैन्युअल रूप से लिखा गया हो
डेवलपर्स, एचटीएमएल में।
- GSDoc XML फ़ाइल सेट के आधार पर सूचकांकों का निर्माण करें, और उन्हें HTML में भी रूपांतरित करें।
इसका सबसे आम उपयोग कमांड को एक या अधिक हेडर फ़ाइल नामों के साथ चलाने के लिए है:
तर्क ... उपकरण स्वचालित रूप से संबंधित स्रोत फ़ाइलों को उसी में पार्स कर देगा
हेडर के रूप में निर्देशिका (या वर्तमान निर्देशिका, या निर्देशिका का उपयोग करके निर्दिष्ट)
DocumentationDirectory डिफ़ॉल्ट), और GSDoc और HTML फ़ाइलों को आउटपुट के रूप में प्रस्तुत करता है। अच्छे के लिए
परिणाम इस मोड को स्रोत फ़ाइलों वाली निर्देशिका से चलाया जाना चाहिए। (ध्यान दें
चूँकि C, उद्देश्य C का एक उपसमुच्चय है, यह उपकरण दस्तावेज़ कार्यों के लिए कार्य कर सकता है और
सादे सी स्रोत में अन्य सी संरचनाएं।)
GSDoc फाइलें इसके अलावा या स्वयं भी सीधे दी जा सकती हैं, और परिवर्तित की जाएंगी
एचटीएमएल को। GSDoc HTML दस्तावेज़ देखें या जीएसडॉक(7) मैन पेज पर जानकारी के लिए
जीएसडॉक प्रारूप।
अंत में, कमांड लाइन पर HTML फाइलें दी जा सकती हैं। के अन्य भागों के लिए क्रॉस-रेफरेंस
उनके भीतर पाए जाने वाले कोड प्रलेखन को इसमें जो पाया गया है, उसके आधार पर फिर से लिखा जाएगा
परियोजना वर्तमान में।
स्रोत कोड मार्कअप
स्रोत कोड पार्सर स्वचालित रूप से GSDoc दस्तावेज़ प्रस्तुत करेगा जिसमें विधियों को सूचीबद्ध किया जाएगा
स्रोत फ़ाइलों में पाए जाने वाले वर्ग, और इसमें विशेष रूप से स्वरूपित पाठ शामिल होंगे
स्रोत फ़ाइलों से टिप्पणियाँ।
स्लैश से शुरू होने वाली कोई भी टिप्पणी और दो सामान्य स्लैश और सिंगल के बजाय तारांकन
तारांकन, GSDoc मार्कअप के रूप में लिया जाता है, जिसका उपयोग वर्ग या विधि के विवरण के रूप में किया जाता है
इसका पालन करना। इस टिप्पणी पाठ को पुन: स्वरूपित किया जाता है और फिर आउटपुट में डाला जाता है।
जहाँ एक ही आइटम के साथ कई टिप्पणियाँ जुड़ी होती हैं, वे एक साथ जुड़ जाती हैं a
पंक्ति तोड़ना ( ) यदि आवश्यक हो तो प्रत्येक के बीच।
टूल को आसानी से प्रोग्रामों के साथ-साथ पुस्तकालयों को दस्तावेज करने के लिए इस्तेमाल किया जा सकता है, बस इसे देकर
स्रोत फ़ाइल का नाम जिसमें प्रोग्राम का मुख्य () फ़ंक्शन होता है - यह लेता है
उस फ़ंक्शन से विशेष टिप्पणियां और उन्हें विशेष रूप से संभालती हैं, उन्हें a . के रूप में सम्मिलित करती हैं
दस्तावेज़ के पहले अध्याय के अंत में अनुभाग (यह पहला अध्याय बनाता है if
ज़रूरी)।
ऑप्शंस अनुभाग में वर्णित हैं तर्क और डिफ़ॉल्ट्स नीचे.
अतिरिक्त मार्कअप
ऐसे कुछ मामले हैं जहां विशेष अतिरिक्त प्रसंस्करण किया जाता है, मुख्यतः में
स्रोत फ़ाइल में पहली टिप्पणी मिली, जिसमें से GSDoc मार्कअप के विभिन्न भाग हो सकते हैं
निकाला गया और आउटपुट दस्तावेज़ में उपयुक्त स्थानों पर रखा गया -
Autogsdoc स्रोत:
किसी भी पंक्ति में जहाँ Autogsdoc स्रोत: पाया जाता है, शेष रेखा को a के रूप में लिया जाता है
स्रोत फ़ाइल नाम का उपयोग यह अनुमान लगाने के बजाय किया जाना चाहिए कि प्रत्येक .h फ़ाइल
संसाधित उसी नाम की एक .m फ़ाइल का उपयोग करता है। आप कई आपूर्ति कर सकते हैं Autogsdoc स्रोत:
पंक्तियाँ जहाँ एक हेडर फ़ाइल उन वस्तुओं की घोषणा करती है जो कई स्रोत फ़ाइलों में परिभाषित होती हैं।
यदि कोई फ़ाइल नाम निरपेक्ष है, तो इसका उपयोग आपूर्ति के अनुसार ही किया जाता है। यदि दूसरी ओर, यह एक है
सापेक्ष पथ, सॉफ़्टवेयर पहले स्थान के सापेक्ष स्रोत फ़ाइल की तलाश करता है
हेडर फ़ाइल का, और यदि वहां नहीं मिला, तो वर्तमान निर्देशिका के सापेक्ष जिसमें
autogsdoc चल रहा है, और अंत में द्वारा निर्दिष्ट निर्देशिका के सापेक्ष
दस्तावेज़ीकरण निर्देशिका चूक।
दस्तावेज़ की सामग्री का एक सार ... GSDoc आउटपुट के शीर्ष में रखा गया।
कोड के लेखक का विवरण - उस मामले को संभालने के लिए दोहराया जा सकता है जहां a
दस्तावेज़ में कई लेखक हैं। GSDoc आउटपुट के शीर्ष में रखा गया। सहायता के रूप में
स्रोत की पठनीयता, कुछ विशेष अतिरिक्त प्रसंस्करण से संबंधित किया जाता है
दस्तावेज़ लेखक - प्रपत्र की कोई भी पंक्ति 'लेखक: नाम' ', या द्वारा:
नाम ', या 'लेखक: नाम' या 'द्वारा: नाम' को पहचाना जाएगा और
an . में परिवर्तित लेखक तत्व, संभवतः एक युक्त ईमेल तत्व।
दस्तावेज़ के मुख्य भाग के अंत से ठीक पहले GSDoc आउटपुट में रखा गया - इरादा
परिशिष्ट, अनुक्रमणिका आदि के लिए उपयोग किया जाना है।
किसी भी जनरेट किए गए वर्ग दस्तावेज़ीकरण से ठीक पहले रखा गया ... उपयोग करने का इरादा
दस्तावेज़ीकृत किया जा रहा कोड कैसे काम करता है, इसका समग्र विवरण प्रदान करने के लिए। कोई भी
किसी प्रोग्राम के मुख्य () फ़ंक्शन के लिए दस्तावेज़ अंत में एक अनुभाग के रूप में डाला जाता है
इस अध्याय का।
दस्तावेज़ की सामग्री का कॉपीराइट ... GSDoc आउटपुट के शीर्ष में रखा गया है।
स्रोत की पठनीयता में सहायता के रूप में, कुछ विशेष अतिरिक्त संसाधन हैं
प्रदर्शन किया गया - 'कॉपीराइट (सी) टेक्स्ट' फ़ॉर्म की किसी भी पंक्ति को पहचाना और परिवर्तित किया जाएगा
एक करने के लिए प्रतिलिपि तत्व।
दस्तावेज़ के संशोधन की तिथि ... को GSDoc आउटपुट के शीर्ष में रखा गया है। अगर
इसे छोड़ दिया जाता है, टूल RCS दिनांक टैग से एक मान बनाने का प्रयास करेगा (यदि
उपलब्ध)।
मुख्य भाग के प्रारंभ में दस्तावेज़ में डाला गया ... प्रदान करने का इरादा
परिचय या सामग्री पृष्ठ आदि।
दस्तावेज़ का शीर्षक ... GSDoc आउटपुट के शीर्ष में रखा गया है। यदि यह छोड़ा जाता है
उपकरण स्वयं का एक (शायद खराब) शीर्षक उत्पन्न करेगा - इसलिए आपको इसे शामिल करना चाहिए
मैन्युअल रूप से मार्कअप।
दस्तावेज़ का संस्करण पहचानकर्ता ... GSDoc आउटपुट के शीर्ष में रखा गया है। अगर
इसे छोड़ दिया जाता है, टूल RCS संशोधन टैग से एक मान बनाने का प्रयास करेगा (यदि
उपलब्ध)।
NB अभी वर्णित मार्कअप का उपयोग वर्ग, श्रेणी या प्रोटोकॉल दस्तावेज़ीकरण में किया जा सकता है
... यदि ऐसा है, तो इसे निकाला जाता है और कक्षा के लिए शेष दस्तावेज़ों के चारों ओर लपेटा जाता है
कक्षा के अध्याय के रूप में। कक्षा के बाकी दस्तावेज सामान्य रूप से पर डाले जाते हैं
अध्याय के अंत में, लेकिन इसके स्थान पर प्रतिस्थापित किया जा सकता है झूठा
के भीतर तत्व तत्व।
विधि मार्कअप
एक विधि विवरण के लिए पाठ प्रदान करने के लिए उपयोग की जा रही टिप्पणियों में, निम्नलिखित मार्कअप है:
पाठ से हटा दिया और विशेष रूप से संभाला -
विधि को कक्षा के लिए नामित प्रारंभकर्ता के रूप में चिह्नित किया गया है।
विधि को एक के रूप में चिह्नित किया जाता है जिसे उपवर्गों को ओवरराइड करना चाहिए (उदाहरण के लिए एक सार
तरीका)।
विधि को एक के रूप में चिह्नित किया जाता है जिसे उपवर्गों को करना चाहिए नहीं ओवरराइड।
मार्कअप को विवरण से हटा दिया जाता है और रखा जाता है बाद इसे GSDoc आउटपुट में -
ताकि विधि को निर्दिष्ट के अनुरूप (या अनुरूप नहीं) के रूप में वर्णित किया जा सके
मानकों।
स्वचालित मार्कअप
आम तौर पर, टिप्पणियों में पाठ को अच्छी तरह से मानकीकृत और इंडेंट करने के लिए पुन: स्वरूपित किया जाता है ... the
रिफॉर्मेटिंग is नहीं a . के अंदर किसी भी पाठ पर किया गया तत्व। जब पाठ है
पुन: स्वरूपित, इसे व्हॉट्सएप से अलग किए गए "शब्दों" में विभाजित किया जाता है, जो तब के अधीन होते हैं
कुछ अतिरिक्त प्रसंस्करण ...
हाँ, नहीं, और शून्य जैसे कुछ प्रसिद्ध स्थिरांक संलग्न हैं ...
मार्कअप
विधि विवरण के भीतर विधि तर्कों के नाम संलग्न हैं ...
</ var> मार्कअप।
विधि के नाम (एक प्लस या माइनस से शुरू) में संलग्न हैं ...
मार्कअप जैसे "-init" (उद्धरण के बिना) एक GSDoc संदर्भ में लपेटा जाएगा
तत्व वर्तमान वर्ग की init विधि को इंगित करने के लिए या, यदि केवल एक ज्ञात वर्ग
एक init विधि थी, यह उस वर्ग की विधि को संदर्भित करेगा। इस तथ्य पर ध्यान दें कि
विधि का नाम पहचाने जाने के लिए व्हाइटस्पेस से घिरा होना चाहिए (हालांकि एक अल्पविराम,
फुलस्टॉप, या विनिर्देशक के अंत में अर्धविराम व्हाइटस्पेस की तरह कार्य करेगा)।
वर्ग के नाम सहित विधि विनिर्देशक (वर्ग कोष्ठक के साथ आरंभ और समाप्त)
में संलग्न हैं ... मार्कअप उदाहरण के लिए '[NSObject-init]', a . बनाएगा
एनएसओब्जेक्ट की इनिट विधि का संदर्भ (या तो उचित वर्ग, या इसका कोई भी)
श्रेणियां), जबकि '[(NSCopying)-copyWithZone:]', में एक विधि का संदर्भ बनाता है
NSCopying प्रोटोकॉल। ध्यान दें कि वर्गाकार कोष्ठकों के बीच कोई रिक्त स्थान नहीं दिखना चाहिए
इन विनिर्देशों में। प्रोटोकॉल के नाम गोल कोष्ठक में संलग्न हैं, न कि
प्रथागत कोण कोष्ठक, क्योंकि GSDoc एक XML भाषा है, और XML कोण को मानता है
कोष्ठक विशेष रूप से।
फ़ंक्शन नाम ('()' से समाप्त होने वाले) 'मुख्य ()' के अलावा अन्य में संलग्न हैं ...
मार्कअप जैसे "NSLogv ()" (उद्धरण के बिना) एक GSDoc में लपेटा जाएगा
संदर्भ तत्व NSLog फ़ंक्शन के दस्तावेज़ीकरण को इंगित करने के लिए। तथ्य पर ध्यान दें
कि फ़ंक्शन का नाम व्हॉट्सएप से घिरा होना चाहिए (हालांकि अल्पविराम, पूर्ण विराम, या
विनिर्देशक के अंत में अर्धविराम भी एक व्हाइटस्पेस टर्मिनेटर के रूप में कार्य करेगा)।
बहस और चूक
उपकरण कुछ उपयोगकर्ता चूक को स्वीकार करता है (जो निश्चित रूप से कमांड-लाइन के रूप में आपूर्ति की जा सकती है
डिफ़ॉल्ट नाम से पहले '-' तैयार करके और बाद में मान देकर तर्क, जैसा कि in
- स्वच्छ हाँ):
स्वच्छ
यदि यह बूलियन मान हाँ पर सेट है, तो दस्तावेज़ीकरण उत्पन्न करने के बजाय,
टूल प्रोजेक्ट में जेनरेट की गई सभी GSDoc फाइलों और जेनरेट की गई सभी html फाइलों को हटा देता है
उनसे (साथ ही कोई भी जो सूचीबद्ध GSDoc फाइलों से उत्पन्न होगा
स्पष्ट रूप से), और अंत में प्रोजेक्ट इंडेक्स फ़ाइल को हटा देता है। इसका एकमात्र अपवाद
क्या वह टेम्प्लेट GSDoc फाइलें हैं (अर्थात "-ConstantsTemplate ..." का उपयोग करके निर्दिष्ट,
"-FunctionsTemplate ..." तर्क आदि) तब तक नहीं हटाए जाते जब तक कि CleanTemplates
झंडा लगा दिया है।
स्वच्छ टेम्पलेट्स
यह फ़्लैग निर्दिष्ट करता है कि टेम्पलेट GSDoc फ़ाइलों को अन्य के साथ हटाया जाना है या नहीं
फ़ाइलें जब स्वच्छ विकल्प निर्दिष्ट किया जाता है। डिफ़ॉल्ट उनके लिए नहीं हटाया जाना है
... चूंकि ये टेम्प्लेट मैन्युअल रूप से तैयार किए गए होंगे और केवल डेटा डाला गया होगा
उनके अंदर।
स्थिरांकटेम्पलेट
एक टेम्प्लेट दस्तावेज़ का नाम निर्दिष्ट करें जिसमें स्थिरांक के बारे में दस्तावेज़ीकरण हो
परियोजना में सभी फाइलों से डाला जाना चाहिए। यह उपयोगी है यदि में स्थिरांक
स्रोत कोड कई फाइलों के आसपास बिखरे हुए हैं, और आपको उन्हें एक में समूहित करने की आवश्यकता है
जगह। आप यह सुनिश्चित करने के लिए ज़िम्मेदार हैं कि मूल टेम्पलेट दस्तावेज़ (जिसमें
व्यक्तिगत निरंतर दस्तावेज़ सम्मिलित किया गया है) में अन्य सभी जानकारी शामिल है जो आप
चाहते हैं, लेकिन एक सुविधा के रूप में autogsdoc एक साधारण टेम्पलेट उत्पन्न करेगा (जिसे आप कर सकते हैं
फिर संपादित करें) आपके लिए यदि फ़ाइल मौजूद नहीं है। सम्मिलन तुरंत होता है
से पहले वापस तत्व (या यदि वह मौजूद नहीं है, के अंत से ठीक पहले)
परिवर्तन तत्व) टेम्पलेट में।
घोषित
निर्दिष्ट करें कि हेडर कहाँ पाए जाने के रूप में प्रलेखित किए जाने हैं। वास्तविक नाम उत्पादित
दस्तावेज़ में हेडर फ़ाइल नाम के अंतिम घटक को जोड़कर बनाया गया है
इस डिफ़ॉल्ट के मूल्य के लिए। यदि यह डिफ़ॉल्ट निर्दिष्ट नहीं है, तो का पूरा नाम
हेडर फ़ाइल (जैसा कि कमांड लाइन पर दिया गया है), हैडरडायरेक्टरी डिफ़ॉल्ट के साथ
प्रीपेड, प्रयोग किया जाता है। इसका एक विशिष्ट उपयोग ''-घोषित फाउंडेशन'' हो सकता है, जब
जीएनयूस्टेप बेस लाइब्रेरी के लिए दस्तावेज तैयार करना। इसका परिणाम होगा
दस्तावेज़ीकरण कह रहा है कि एनएसएसटींग 'फाउंडेशन/एनएसएसटींग.एच' में घोषित किया गया है
DocumentAllInstanceVariables
यह ध्वज आपको सभी आवृत्ति चर के लिए दस्तावेज़ीकरण उत्पन्न करने की अनुमति देता है। सामान्य रूप से,
केवल स्पष्ट रूप से घोषित 'सार्वजनिक' या 'संरक्षित' को ही प्रलेखित किया जाएगा।
दस्तावेज़InstanceVariables
यह ध्वज आपको उदाहरण चर के लिए दस्तावेज़ीकरण को पूरी तरह से बंद करने की अनुमति देता है।
आम तौर पर, स्पष्ट रूप से घोषित 'सार्वजनिक' या 'संरक्षित' आवृत्ति चर होंगे
दस्तावेज।
इंस्टेंस वेरिएबल्सएटएंड
यह ध्वज, यदि सेट किया गया है, तो HTML जनरेटर को आवृत्ति चर दस्तावेज़ीकरण रखने के लिए निर्देशित करता है
कक्षा के अंत में, शुरुआत के बजाय। यह उपयोगी है यदि आप बहुत अधिक . का उपयोग करते हैं
संरक्षित आवृत्ति चर जो केवल माध्यमिक हित के होने जा रहे हैं
वर्ग के सामान्य उपयोगकर्ता।
दस्तावेज़ीकरण निर्देशिका
उस निर्देशिका को निर्दिष्ट करने के लिए उपयोग किया जा सकता है जिसमें उत्पन्न दस्तावेज़ीकरण रखा जाना है।
यदि यह सेट नहीं है, तो आउटपुट को वर्तमान निर्देशिका में रखा जाता है। यह निर्देशिका भी है
स्रोत फ़ाइलों (हेडर नहीं) का पता लगाने के लिए अंतिम उपाय के रूप में उपयोग किया जाता है, और इससे भी महत्वपूर्ण बात, it
के रूप में प्रयोग किया जाता है प्रथम और केवल किसी भी .gsdoc फ़ाइलों का पता लगाने का सहारा लें, जो on . में पास की गई हैं
कमांड लाइन। इन फ़ाइलों के लिए दी गई कोई भी पथ जानकारी है हटाया और वो हैं
'दस्तावेज़ीकरण निर्देशिका' में खोजा गया (भले ही वे
स्व - उत्पन्न)।
फ़ाइलें
संपत्ति सूची सरणी के रूप में फ़ाइल नामों की सूची वाली फ़ाइल का नाम निर्दिष्ट करता है
(नाम1,नाम2,...) प्रारूप। यदि यह मौजूद है, प्रोग्राम तर्क सूची में फ़ाइल नाम
पर ध्यान नहीं दिया जाता है और इस फ़ाइल में नामों को संसाधित करने के लिए नामों की सूची के रूप में उपयोग किया जाता है।
कार्य टेम्पलेट
टेम्पलेट दस्तावेज़ का नाम निर्दिष्ट करें जिसमें फ़ंक्शंस के बारे में दस्तावेज़ीकरण
परियोजना में सभी फाइलों से डाला जाना चाहिए। यह उपयोगी है अगर फ़ंक्शन स्रोत
कोड कई फाइलों के आसपास बिखरा हुआ है, और आपको इसे एक स्थान पर समूहित करने की आवश्यकता है। आप
यह सुनिश्चित करने के लिए जिम्मेदार है कि मूल टेम्पलेट दस्तावेज़ (जिसमें व्यक्ति
फ़ंक्शन प्रलेखन डाला गया है) में अन्य सभी जानकारी शामिल है जो आप चाहते हैं, लेकिन
सुविधा के रूप में autogsdoc एक साधारण टेम्पलेट उत्पन्न करेगा (जिसे आप तब संपादित कर सकते हैं)
आपके लिए अगर फ़ाइल मौजूद नहीं है। सम्मिलन तुरंत पहले होता है वापस
तत्व (या यदि वह मौजूद नहीं है, के अंत से ठीक पहले) परिवर्तन तत्व) में
नमूना।
एचटीएमएल उत्पन्न करें
यह निर्दिष्ट करने के लिए उपयोग किया जा सकता है कि HTML आउटपुट उत्पन्न किया जाना है या नहीं। हाँ के लिए डिफ़ॉल्ट।
हैडरडायरेक्टरी
हेडर फ़ाइलों के लिए खोजी जाने वाली निर्देशिका को निर्दिष्ट करने के लिए उपयोग किया जा सकता है। जब आपूर्ति की जाती है,
यह मान सापेक्ष शीर्षलेख नामों से जोड़ा जाता है, अन्यथा सापेक्ष शीर्षलेख नाम
वर्तमान निर्देशिका के सापेक्ष व्याख्या की जाती है। निरपेक्ष के रूप में निर्दिष्ट शीर्षलेख फ़ाइलें
पथ इस डिफ़ॉल्ट से प्रभावित नहीं हैं।
निर्भरता पर ध्यान न दें
एक बूलियन मान जिसका उपयोग यह निर्दिष्ट करने के लिए किया जा सकता है कि प्रोग्राम को फ़ाइल को अनदेखा करना चाहिए
संशोधन समय और वैसे भी फ़ाइलों को पुन: उत्पन्न करें। के साथ संयोजन के रूप में उपयोग के लिए प्रदान किया गया
'मेक' प्रणाली, जो स्वयं निर्भरता जाँच को प्रबंधित करने की अपेक्षा की जाती है।
स्थानीय परियोजनाएं
इस मान का उपयोग स्थानीय बाहरी परियोजनाओं के स्वत: समावेशन को नियंत्रित करने के लिए किया जाता है
अंतिम दस्तावेज़ आउटपुट में क्रॉस-रेफरेंस उत्पन्न करने के लिए अनुक्रमण प्रणाली। अगर
'कोई नहीं' पर सेट, फिर कोई स्थानीय परियोजना संदर्भ नहीं किया जाता है, अन्यथा, 'स्थानीय'
GNUstep दस्तावेज़ निर्देशिका को '.igsdoc' वाली फ़ाइलों के लिए पुनरावर्ती रूप से खोजा जाता है
एक्सटेंशन, और उन फ़ाइलों से अनुक्रमण जानकारी का उपयोग किया जाता है। इसका मूल्य
स्ट्रिंग का उपयोग क्रॉस संदर्भ में फ़ाइल नाम उत्पन्न करने के लिए भी किया जाता है ... यदि यह एक है
खाली स्ट्रिंग, उपयोग करने का पथ उसी निर्देशिका में एक फ़ाइल माना जाता है जहां
igsdoc फ़ाइल मिली, अन्यथा इसे अनुक्रमणिका में नाम के उपसर्ग के रूप में प्रयोग किया जाता है। नायब।
स्थानीय परियोजनाओं का नाम उसी नाम से होगा जिस परियोजना का वर्तमान में दस्तावेजीकरण किया जा रहा है नहीं
इस तंत्र द्वारा शामिल किया जा सकता है। यदि आप ऐसी परियोजनाओं को शामिल करना चाहते हैं, तो आपको ऐसा करना चाहिए
स्पष्ट रूप से उपयोग करना -परियोजनाएं ...
मैक्रो टेम्पलेट
एक टेम्प्लेट दस्तावेज़ का नाम निर्दिष्ट करें जिसमें मैक्रोज़ के बारे में दस्तावेज़ीकरण होना चाहिए
परियोजना में सभी फाइलों से डाला जा सकता है। मैक्रो कोड बिखरा हुआ है तो यह उपयोगी है
कई फाइलों के आसपास, और आपको इसे एक स्थान पर समूहित करने की आवश्यकता है। आप इसके लिए जिम्मेदार हैं
यह सुनिश्चित करना कि मूल टेम्पलेट दस्तावेज़ (जिसमें व्यक्तिगत मैक्रो दस्तावेज़ीकरण हो)
डाला गया है) में अन्य सभी जानकारी शामिल है जो आप चाहते हैं, लेकिन सुविधा के रूप में
autogsdoc आपके लिए एक साधारण टेम्पलेट (जिसे आप तब संपादित कर सकते हैं) उत्पन्न करेगा यदि
फ़ाइल मौजूद नहीं है। सम्मिलन तुरंत पहले होता है वापस तत्व (या यदि
जो अस्तित्व में नहीं है, के अंत से ठीक पहले परिवर्तन
तत्व) टेम्पलेट में।
निर्भरता बनाएं
मेक के लिए निर्भरता जानकारी को आउटपुट करने के लिए उपयोग किया जाने वाला फ़ाइल नाम। यह ले जाएगा
परियोजना के लिए जानी जाने वाली सभी शीर्षलेख और स्रोत फ़ाइलों को की निर्भरता के रूप में सूचीबद्ध करने का रूप
परियोजना का नाम ('परियोजना' देखें)।
परियोजना
इस परियोजना का नाम निर्दिष्ट करने के लिए इस्तेमाल किया जा सकता है ... सूचकांक का नाम निर्धारित करता है
सक्षम करने वाली जानकारी प्रदान करने के लिए दस्तावेज़ीकरण के हिस्से के रूप में उत्पादित संदर्भ फ़ाइल
अन्य परियोजनाओं को इस परियोजना में मदों के क्रॉस-रेफरेंस के लिए।
परियोजनाएं
यह मान एक शब्दकोश के रूप में दिया जा सकता है जिसमें igsdoc . के पथ शामिल हैं
बाहरी परियोजनाओं द्वारा उपयोग की जाने वाली अनुक्रमणिका/संदर्भ फ़ाइलें, मानचित्र के लिए उपयोग किए जाने वाले मानों के साथ
अनुक्रमणिका में पाए गए फ़ाइल नाम। उदाहरण के लिए, यदि कोई प्रोजेक्ट इंडेक्स (igsdoc) फ़ाइल
कहता है कि 'फू' वर्ग 'फू' फ़ाइल में पाया जाता है, और पथ से जुड़ा हुआ है
वह प्रोजेक्ट इंडेक्स '/ usr/share/doc/proj' है, फिर जेनरेट किया गया एचटीएमएल आउटपुट संदर्भित हो सकता है
वर्ग '/usr/share/doc/prj/Foo.html' में है। ध्यान दें कि एक शब्दकोश हो सकता है
मानक PropertyList प्रारूप (XML नहीं) का उपयोग करके कमांड लाइन पर दिया गया
ओएस एक्स का प्रारूप), अर्धविरामों को लाइन-सेपरेटर के रूप में उपयोग करना, और इसे एकल में संलग्न करना
उल्लेख। उद्धरण।
दिखाएँ निर्भरता
एक बूलियन मान जिसका उपयोग यह निर्दिष्ट करने के लिए किया जा सकता है कि प्रोग्राम को कौन सी फाइलें लॉग करनी चाहिए
अन्य फाइलों पर उनकी निर्भरता के कारण पुन: उत्पन्न किए जा रहे हैं।
मानक
एक बूलियन मान निर्दिष्ट करने के लिए उपयोग किया जाता है कि क्या प्रोग्राम को इसके बारे में जानकारी सम्मिलित करनी चाहिए
प्रलेखन में मानकों का अनुपालन। इसका उपयोग तभी किया जाना चाहिए जब
जीएनयूस्टेप पुस्तकालयों और उपकरणों को स्वयं दस्तावेज करना क्योंकि यह मानता है कि कोड
दस्तावेज किया जाना जीएनयूस्टेप का हिस्सा है और संभवतः ओपनस्टेप मानक का अनुपालन करता है
या MacOS-X संगत विधियों को लागू करता है।
सिस्टम प्रोजेक्ट्स
इस मान का उपयोग सिस्टम बाहरी परियोजनाओं के स्वत: समावेशन को नियंत्रित करने के लिए किया जाता है
अंतिम दस्तावेज़ आउटपुट में क्रॉस-रेफरेंस उत्पन्न करने के लिए अनुक्रमण प्रणाली। अगर
'कोई नहीं' पर सेट करें, फिर कोई सिस्टम प्रोजेक्ट संदर्भ नहीं किया जाता है, अन्यथा, 'सिस्टम'
GNUstep दस्तावेज़ निर्देशिका को '.igsdoc' वाली फ़ाइलों के लिए पुनरावर्ती रूप से खोजा जाता है
एक्सटेंशन, और उन फ़ाइलों से अनुक्रमण जानकारी का उपयोग किया जाता है। इसका मूल्य
स्ट्रिंग का उपयोग क्रॉस संदर्भ में फ़ाइल नाम उत्पन्न करने के लिए भी किया जाता है ... यदि यह एक है
खाली स्ट्रिंग, उपयोग करने का पथ उसी निर्देशिका में एक फ़ाइल माना जाता है जहां
igsdoc फ़ाइल मिली, अन्यथा इसे अनुक्रमणिका में नाम के उपसर्ग के रूप में प्रयोग किया जाता है। नायब।
सिस्टम प्रोजेक्ट उसी नाम के साथ जिस प्रोजेक्ट का वर्तमान में दस्तावेज़ीकरण किया जा रहा है नहीं
इस तंत्र द्वारा शामिल किया जा सकता है। यदि आप ऐसी परियोजनाओं को शामिल करना चाहते हैं, तो आपको ऐसा करना चाहिए
स्पष्ट रूप से उपयोग करना -परियोजनाएं ...
टाइपपीफ्सटेम्पलेट
एक टेम्प्लेट दस्तावेज़ का नाम निर्दिष्ट करें जिसमें टाइपिफ़ के बारे में दस्तावेज़ीकरण होना चाहिए
परियोजना में सभी फाइलों से डाला जा सकता है। यह उपयोगी है यदि typedef स्रोत कोड है
कई फाइलों के आसपास बिखरा हुआ है, और आपको इसे एक स्थान पर समूहित करने की आवश्यकता है। आप
यह सुनिश्चित करने के लिए जिम्मेदार है कि मूल टेम्पलेट दस्तावेज़ (जिसमें व्यक्ति
typedef दस्तावेज़ सम्मिलित किया गया है) में अन्य सभी जानकारी शामिल है जो आप चाहते हैं, लेकिन as
एक सुविधा autogsdoc एक साधारण टेम्पलेट उत्पन्न करेगा (जिसे आप तब संपादित कर सकते हैं)
आप अगर फ़ाइल मौजूद नहीं है। सम्मिलन तुरंत पहले होता है वापस
तत्व (या यदि वह मौजूद नहीं है, के अंत से ठीक पहले) परिवर्तन तत्व) में
नमूना।
Up उत्पन्न GSDoc . से 'अप' लिंक में उपयोग किए जाने वाले नाम की आपूर्ति करने के लिए प्रयुक्त एक स्ट्रिंग
दस्तावेज। यह सामान्य रूप से उस फ़ाइल का नाम होना चाहिए जिसमें की अनुक्रमणिका होती है
एक परियोजना की सामग्री। यदि यह अनुपलब्ध है या रिक्त स्ट्रिंग पर सेट है, तो 'ऊपर' नहीं
दस्तावेजों में लिंक प्रदान किया जाएगा।
चर टेम्पलेट
एक टेम्प्लेट दस्तावेज़ का नाम निर्दिष्ट करें जिसमें चर के बारे में दस्तावेज़ीकरण हो
परियोजना में सभी फाइलों से डाला जाना चाहिए। यह उपयोगी है अगर परिवर्तनीय स्रोत
कोड कई फाइलों के आसपास बिखरा हुआ है, और आपको इसे एक स्थान पर समूहित करने की आवश्यकता है। आप
यह सुनिश्चित करने के लिए जिम्मेदार है कि मूल टेम्पलेट दस्तावेज़ (जिसमें व्यक्ति
परिवर्तनीय दस्तावेज डाला गया है) में अन्य सभी जानकारी शामिल है जो आप चाहते हैं, लेकिन
सुविधा के रूप में autogsdoc एक साधारण टेम्पलेट उत्पन्न करेगा (जिसे आप तब संपादित कर सकते हैं)
आपके लिए अगर फ़ाइल मौजूद नहीं है। सम्मिलन तुरंत पहले होता है वापस
तत्व (या यदि वह मौजूद नहीं है, के अंत से ठीक पहले) परिवर्तन तत्व) में
नमूना।
वाचाल
एक बूलियन यह निर्दिष्ट करने के लिए प्रयोग किया जाता है कि क्या आप वर्बोज़ डीबग/चेतावनी आउटपुट होना चाहते हैं
का उत्पादन किया।
चेतावनी देना
एक बूलियन यह निर्दिष्ट करने के लिए प्रयोग किया जाता है कि क्या आप मानक चेतावनी आउटपुट चाहते हैं (उदाहरण के लिए . की रिपोर्ट)
अनिर्दिष्ट तरीके) का उत्पादन किया।
वर्डमैप
यह मान स्रोत फ़ाइलों में पाए जाने वाले पहचानकर्ताओं/कीवर्ड को मैप करने के लिए उपयोग किया जाने वाला एक शब्दकोश है
दूसरे शब्दों को। आम तौर पर आपको इसका उपयोग नहीं करना पड़ेगा, लेकिन यह कभी-कभी मददगार होता है
सी प्रीप्रोसेसर मैक्रोज़ के उपयोग से पार्सर को भ्रमित होने से बचाने के लिए। आप ऐसा कर सकते हैं
कुछ कम भ्रमित करने के लिए मैक्रो को प्रभावी ढंग से फिर से परिभाषित करें। आप जिस मान को मैप करते हैं
पहचानकर्ता इनमें से एक होना चाहिए - एक अन्य पहचानकर्ता, एक खाली स्ट्रिंग - मान है
अनदेखा किया गया, दो स्लैश ('//') - शेष पंक्ति को अनदेखा कर दिया गया है। ध्यान दें कि एक शब्दकोश
मानक संपत्ति सूची प्रारूप का उपयोग करके कमांड लाइन पर दिया जा सकता है (नहीं
OS X का XML स्वरूप), अर्धविरामों को लाइन-विभाजक के रूप में उपयोग करना, और इसे एकल में संलग्न करना
उल्लेख। उद्धरण।
इंटर-डॉक्यूमेंट कड़ी
'अप' डिफॉल्ट का उपयोग किसी दस्तावेज़ के नाम को निर्दिष्ट करने के लिए किया जाता है जिसे के रूप में उपयोग किया जाना चाहिए
उपयोग किए गए किसी अन्य दस्तावेज़ के लिए 'अप' लिंक। इस नाम में पथ या विस्तार शामिल नहीं होना चाहिए।
आम तौर पर, इस डिफ़ॉल्ट द्वारा संदर्भित दस्तावेज़ हाथ से संपादित GSDoc दस्तावेज़ होना चाहिए
जिसमें एक प्रोजेक्ट इंडेक्स वाला बैक सेक्शन होना चाहिए। जैसे
<!DOCTYPE gsdoc PUBLIC "-//GNUstep//DTD gsdoc 1.0.3//EN"
"http://www.gnustep.org/gsdoc-1_0_3.xml">
मेरा प्रोजेक्ट संदर्भ
मेरा प्रोजेक्ट संदर्भ
onworks.net सेवाओं का उपयोग करके ऑनलाइन autogsdoc का उपयोग करें