gjdoc-4.8 - क्लाउड में ऑनलाइन

कार्यक्रम:

नाम

सीपी-टूल्स - जीएनयू क्लासपाथ टूल्स गाइड

SYNOPSIS

gjdoc [-स्रोतपथ पथसूची]
[-सब] [-उपपैकेज पीकेजी:पीकेजी:...] [-निकालना pkglist]
[-एन्कोडिंग चारसेट] [-लोकेल नाम] [स्रोत और ]
[-जनता] [-संरक्षित] [-पैकेज] [-प्यार]
[-doctitle टेक्स्ट] [-शीर्षक टेक्स्ट] [-फुटर टेक्स्ट] [-तल टेक्स्ट]
[-संपर्क यूआरएल] [-लिंकऑफ़लाइन यूआरएल पथ] [-नोक्वालिफायर पीकेजी:पीकेजी:...]
[-टैगलेटपथ पथसूची] [-टैगलेट कक्षा का नाम] [-टैग tagspec]
[-उपयोग] [-लिंकस्रोत] [-स्प्लिटिंडेक्स] [-नोइंडेक्स] [-नोट्री]
[-संस्करण] [-लेखक] [-नोसिंस] [-स्टाइलशीट जोड़ें पट्टिका]
[-d targetdir]
[संकुल...] [स्रोत फ़ाइलें...] [@cmdफ़ाइल]

gjdoc [-स्रोतपथ पथसूची]
[-सब] [-उपपैकेज पीकेजी:पीकेजी:...] [-निकालना pkglist]
[-एन्कोडिंग चारसेट] [-लोकेल नाम] [स्रोत और ]
[-जनता] [-संरक्षित] [-पैकेज] [-प्यार]
[-docletpath पथसूची] [-डॉकलेट कक्षा का नाम]
[संकुल...] [स्रोत फ़ाइलें...] [@cmdफ़ाइल]
[डॉकलेट विकल्प]

gjdoc --मदद

gjdoc --संस्करण

केवल सबसे उपयोगी विकल्प यहां सूचीबद्ध हैं; शेष के लिए नीचे देखें।

वर्णन

Gjdoc का उपयोग दो तरीकों से किया जा सकता है: एक स्टैंड-अलोन दस्तावेज़ीकरण उपकरण के रूप में, या ड्राइवर के रूप में
उपयोगकर्ता-निर्दिष्ट डॉकलेट।

डिफ़ॉल्ट मोड में, Gjdoc मानक डॉकलेट का उपयोग करेगा HtmlDoclet का एक सेट तैयार करने के लिए
HTML पृष्ठ. विहित उपयोग है:

gjdoc -s src/java/ -all -d एपीआई-डॉक्स/

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

मानक डॉकलेट के अलावा अन्य डॉकलेट चलाने के बारे में अधिक जानने के लिए मैनुअल देखें।

विकल्प

विकल्प सारांश by प्रकार

यहां Gjdoc और स्टैंडर्ड डॉकलेट दोनों के सभी विकल्पों का सारांश दिया गया है, जिन्हें समूहीकृत किया गया है
प्रकार। स्पष्टीकरण निम्नलिखित अनुभागों में हैं।

स्रोत सेट ऑप्शंस
-स्रोतपथ पथसूची -उपपैकेज pkglist -निकालना pkglist

स्रोत का गठन ऑप्शंस
स्रोत और -एन्कोडिंग एन्कोडिंग -ब्रेकिटरेटर

जोड़ने ऑप्शंस
-संपर्क यूआरएल -लिंकऑफ़लाइन यूआरएल पट्टिका -नोक्वालिफायर पीकेजी:पीकेजी:...

पीढ़ी ऑप्शंस
-लेखक -लाइसेंसपाठ -उपयोग -संस्करण -स्प्लिटिंडेक्स -नोइंडेक्स
-नोडप्रीकेटिड -नोडप्रीकेटिडलिस्ट -कोई सहायता नही -नॉनवबार
-नोसिंस -नोट्री -जनता -संरक्षित -पैकेज -प्यार
-docfilessubdirs -बहिष्कृतdocfilessubdir दिरनाम
-लिंकस्रोत

उत्पादन ऑप्शंस
-d -लोकेल नाम -चारसेट चारसेट -docencoding चारसेट
-validhtml -बेसयूरल यूआरएल

सजावट ऑप्शंस
-विंडोशीर्षक टेक्स्ट -doctitle टेक्स्ट -शीर्षक टेक्स्ट
-शीर्षक टेक्स्ट -फुटर टेक्स्ट -तल टेक्स्ट
-हेल्पफ़ाइल पट्टिका -स्टाइलशीटफाइल पट्टिका -स्टाइलशीट जोड़ें पट्टिका
-ग्रुप समूहशीर्षक पीकेजीपैटर्न:पीकेजीपैटर्न:...

टैगलेट ऑप्शंस
-टैगलेटपथ -टैगलेट कक्षा का नाम -टैग tagspec

डॉकलेट ऑप्शंस
-docletpath -डॉकलेट कक्षा का नाम

शब्दाडंबर ऑप्शंस
-शांत -कहना

वास्तविक मशीन ऑप्शंस
-क्लासपाथ -बूटक्लासपथ -J vmopt

चुनना कौन कौन से स्रोत फ़ाइलें सेवा मेरे प्रक्रिया

-s पथसूची
-स्रोतपथ पथसूची
निर्दिष्ट निर्देशिका या निर्देशिकाओं में स्रोत फ़ाइलें देखें।

पथसूची आपके प्लेटफ़ॉर्म के पथ से अलग एक या अधिक निर्देशिका पथ होने चाहिए
विभाजक (आमतौर पर : or ;).

यदि यह विकल्प नहीं दिया गया है, gjdoc वर्तमान में स्रोत फ़ाइलों की तलाश करेगा
निर्देशिका.

निर्दिष्ट निर्देशिकाएँ जावा पैकेज के संदर्भ में रूट निर्देशिकाएँ होनी चाहिए
प्रणाली। उदाहरण के लिए, यदि आप package
फू.बार, आपको शीर्ष-स्तर वाली निर्देशिका निर्दिष्ट करनी होगी foo उप-निर्देशिका,
निर्देशिका नहीं फू/बार/ जिसमें जावा स्रोत फ़ाइलें रहती हैं।

लघु-हस्त उपनाम -s के लिए विशिष्ट है gjdoc और सूर्य के अनुकूल नहीं है जावाडोक.

-सब
[प्रायोगिक] सूचीबद्ध निर्देशिकाओं में पाई गई सभी मान्य जावा स्रोत फ़ाइलों को संसाधित करें
स्रोत पथ और उनकी उप-निर्देशिकाएँ।

यह एक विशिष्ट विकल्प है gjdoc और सूर्य के अनुकूल नहीं है जावाडोक.

-उपपैकेज पीकेजी:पीकेजी:...
दिए गए जावा पैकेज और सभी उप-पैकेजों में कक्षाओं को पुनरावर्ती रूप से संसाधित करें।
ध्यान दें कि एकाधिक पैकेज नामों को रिक्त स्थान के बजाय कोलन से अलग किया जाना चाहिए।

-निकालना पीकेजी:पीकेजी:...
दिए गए जावा पैकेज और सभी उप-पैकेजों में कक्षाओं को पुनरावर्ती रूप से संसाधित न करें।
इस विकल्प के साथ संयोजन के रूप में इस्तेमाल किया जा सकता है -सब or -उपपैकेज बहिष्कृत करने के लिए
आउटपुट से अलग-अलग पैकेज या पैकेज उप-पेड़।

संकुल...
दिए गए जावा पैकेज में सभी कक्षाओं को संसाधित करें।

स्रोत फ़ाइलें...
दी गई जावा स्रोत फ़ाइलों में कक्षाओं को संसाधित करें।

निर्दिष्ट करना la का गठन of निवेश फ़ाइलें

स्रोत और
मान लें कि स्रोत फ़ाइलें जावा प्लेटफ़ॉर्म के दिए गए रिलीज़ पर लक्षित हैं।

और प्रारूप में जावा प्लेटफ़ॉर्म रिलीज़ की संस्करण संख्या होनी चाहिए
उदाहरण के लिए, प्रमुख.मामूली 1.4.

इस विकल्प को फिलहाल नजरअंदाज कर दिया गया है सिवाय इसके कि रिलीज नंबर होने पर एक त्रुटि सामने आती है
अन्य की तुलना में 1.2, 1.3 or 1.4 अधिकृत है।

-एन्कोडिंग चारसेट
मान लें कि स्रोत फ़ाइलों का उपयोग करके एन्कोड किया गया है चारसेट.

के उदाहरण हैं चारसेट रहे हमें-ascii, आईएसओ 8859-1 or UTF-8.

का शब्दार्थ चारसेट के समान हैं
java.nio.charset.Charset.forName (स्ट्रिंग).

-ब्रेकिटरेटर
आंतरिक प्रथम वाक्य के बजाय लोकेल के java.text.BreakIterator का उपयोग करें
डिटेक्टर।

डिफ़ॉल्ट रूप से, gjdoc यह निर्धारित करने के लिए कि कोई वाक्य कहाँ समाप्त होता है, एक आंतरिक एल्गोरिदम का उपयोग करता है। कब
यह विकल्प दिया गया है, इसके स्थान पर इसका उपयोग किया जाएगा java.text.BreakIterator उदाहरण के लिए
स्थान के साथ दिया गया -लोकेल (या डिफ़ॉल्ट स्थान)।

आवेदन करते समय यह विकल्प निर्दिष्ट किया जाना चाहिए gjdoc स्रोत कोड पर एक गैर में टिप्पणी की गई-
लैटिन भाषा जिसके लिए डिफ़ॉल्ट पहला वाक्य डिटेक्टर काम नहीं करता है। सभी के लिए
अन्य मामलों में, डिफ़ॉल्ट (ब्रेक इटरेटर का उपयोग न करें) बेहतर परिणाम देता है
इस लेखन का समय.

जोड़ने साथ में अन्य प्रलेखन सेट

-संपर्क यूआरएल
किसी अन्य दस्तावेज़ सेट के लिए हाइपरलिंक बनाएं।

डिफ़ॉल्ट रूप से, gjdoc केवल स्रोत सेट में कक्षाओं के लिए हाइपरलिंक बनाएगा। इस का उपयोग करें
निर्दिष्ट द्वारा कवर की गई कक्षाओं के लिए अतिरिक्त हाइपरलिंक बनाने का विकल्प
दस्तावेज़ीकरण सेट.

यूआरएल अन्य दस्तावेज़ सेट का मूल URL होना चाहिए। उदाहरण के लिए, जोड़ना
जीएनयू क्लासपाथ के हाइपरलिंक, निम्नलिखित निर्दिष्ट करें:

-संपर्क http://developer.classpath.org/doc/

RSI -संपर्क विकल्प कई बार निर्दिष्ट किया जा सकता है।

ध्यान दें कि निर्दिष्ट करना -संपर्क विकल्प हर बार gjdoc के HTTP एक्सेस का कारण बनेगा
आह्वान किया. आप उपयोग कर सकते हैं -लिंकऑफ़लाइन इसके बजाय इस पहुंच से बचने के लिए।

-लिंकऑफ़लाइन यूआरएल पट्टिका
किसी अन्य दस्तावेज़ सेट के लिए हाइपरलिंक बनाएं जो स्थानीय फ़ाइल पर भी मौजूद है
प्रणाली।

यह विकल्प बिल्कुल वैसे ही काम करता है -संपर्क, सिवाय इसके कि यह स्थानीय फ़ाइल सिस्टम तक पहुँचता है
यह निर्धारित करने के लिए नेटवर्क के बजाय कि कौन से वर्ग लिंक्ड द्वारा कवर किए गए हैं
दस्तावेज़ीकरण सेट.

उपयोग करते समय -लिंकऑफ़लाइन दूरस्थ दस्तावेज़ सेट तक बिल्कुल भी पहुंच नहीं है, जो हो सकता है
आपके नेटवर्क कनेक्शन के आधार पर जेनरेशन समय में काफी तेजी आती है।
दस्तावेज़ीकरण सेट के लिए जेनरेट किए गए हाइपरलिंक हालांकि रिमोट सेट को संदर्भित करते हैं, नहीं
स्थानीय, ताकि आप बिना किसी अतिरिक्त दस्तावेज़ीकरण को वितरित कर सकें
निर्भरता।

RSI -लिंकऑफ़लाइन विकल्प कई बार निर्दिष्ट किया जा सकता है।

-नोक्वालिफायर पीकेजी:पीकेजी:...
दिए गए पैकेजों में कक्षाओं के नामों को उनके पैकेज नाम के साथ अर्हता प्राप्त न करें।

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

उदाहरण के लिए, आमतौर पर स्ट्रिंग क्लास का संदर्भ पूर्णतः योग्य के रूप में दर्शाया जाता है
java.lang.स्ट्रिंग (जब तक आप उपयुक्त दस्तावेज़ सेट का उपयोग करके लिंक नहीं करते -संपर्क)
क्योंकि यह दस्तावेज़ सेट का हिस्सा नहीं है. आप निर्दिष्ट कर सकते हैं -नोक्वालिफायर
java.lang उसी संदर्भ को प्रस्तुत करने के लिए तार.

ध्यान दें कि सभी अयोग्य वर्ग नामों के लिए, जब आप अपना नाम रखते हैं तो एक टूलटिप प्रदान किया जाता है
HTML दस्तावेज़ में इसके ऊपर माउस पॉइंटर।

-नोक्वालिफायर सब
सभी वर्ग नामों में से पैकेज नाम क्वालीफायर को हटा दें।

पैकेज नाम क्वालीफायर को पूरी तरह से हटाने के लिए इस विकल्प को निर्दिष्ट करें,

चुनना कौन कौन से जानकारी सेवा मेरे उत्पन्न करें

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

-संरक्षित
आउटपुट में सार्वजनिक वर्गों के सार्वजनिक या संरक्षित सदस्यों को शामिल करें। यह है
चूक।

-पैकेज
सार्वजनिक, संरक्षित और पैकेज-निजी के सार्वजनिक और पैकेज-निजी सदस्यों को शामिल करें
कक्षाएं।

-प्यार
सभी वर्गों और वर्ग के सदस्यों को उनकी पहुंच स्तर की परवाह किए बिना शामिल करें।

-स्प्लिटिंडेक्स
एकल, अखंड सूचकांक पृष्ठ के बजाय प्रति अक्षर एक सूचकांक पृष्ठ बनाएं।

डिफ़ॉल्ट रूप से, मानक डॉकलेट द्वारा बनाए गए सूचकांक में सभी प्रविष्टियाँ एक ही स्थान पर होती हैं
पृष्ठ। यह छोटे दस्तावेज़ सेटों के लिए ठीक है, लेकिन बड़े सेटों के लिए आपको ऐसा करना चाहिए
इस विकल्प को निर्दिष्ट करें.

-नोसिंस
उपेक्षा @जबसे javadoc टिप्पणियों में टैग।

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

-नोट्री
कोई भी ट्री पेज न बनाएं.

डिफ़ॉल्ट रूप से, जेनरेट किए गए आउटपुट में प्रति पैकेज एक इनहेरिटेंस ट्री, और - यदि शामिल होता है
दस्तावेज़ीकरण सेट में कई पैकेज होते हैं - पूर्ण विरासत वाला एक पृष्ठ
पेड़। इन पृष्ठों की पीढ़ी को छोड़ने के लिए इस विकल्प को निर्दिष्ट करें।

-नोइंडेक्स
वर्णमाला अनुक्रमणिका आउटपुट न करें.

डिफ़ॉल्ट रूप से, gjdoc सभी प्रोग्राम तत्वों का एक वर्णमाला सूचकांक उत्पन्न करता है
दस्तावेज़ीकरण सेट (पैकेज, कक्षाएं, आंतरिक कक्षाएं, कंस्ट्रक्टर, विधियां, आदि)।
खेत)। इस जानकारी को छोड़ने के लिए इस विकल्प को निर्दिष्ट करें।

-कोई सहायता नही
सहायता पृष्ठ न बनाएं.

इस विकल्प को वर्तमान में अनदेखा कर दिया गया है क्योंकि मानक डॉकलेट सहायता पृष्ठ प्रदान नहीं करता है।

-नोडप्रीकेटिड
अप्रचलित पैकेजों, कक्षाओं या कक्षा सदस्यों के बारे में इनलाइन जानकारी आउटपुट न करें।

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

-नोडप्रीकेटिडलिस्ट
अप्रचलित एपीआई तत्वों के लिए सारांश पृष्ठ आउटपुट न करें।

डिफ़ॉल्ट रूप से, स्टैंडर्ड डॉकलेट सभी अप्रचलित एपीआई तत्वों को सूचीबद्ध करते हुए एक पेज बनाता है
एक बहिष्करण विवरण के साथ जिसमें आमतौर पर बहिष्करण का कारण शामिल होता है
और संभावित विकल्प। इस जानकारी को छोड़ने के लिए इस विकल्प को निर्दिष्ट करें।

-नॉनवबार
नेविगेशन बार, हेडर और फ़ूटर को आउटपुट न करें।

डिफ़ॉल्ट रूप से, प्रत्येक आउटपुट पेज एक शीर्ष नेविगेशन बार से सुसज्जित होता है (जिसमें शामिल हो सकता है
एक उपयोगकर्ता-निर्दिष्ट हेडर) और एक निचला नेविगेशन बार (जिसमें एक उपयोगकर्ता शामिल हो सकता है-
निर्दिष्ट पाद लेख)। इस सजावट को छोड़ने के लिए इस विकल्प को निर्दिष्ट करें।

-कोई टिप्पणी नहीं
जेनरेट की गई फ़ाइलों से सभी दस्तावेज़ीकरण पाठ को हटा दें और केवल घोषणाएँ आउटपुट करें
कार्यक्रम तत्व संबंध.

यह विकल्प यहां अनुकूलता के लिए है जावाडोक. यदि आप निकालने की योजना बना रहे हैं
आपके प्रोजेक्ट के बारे में जानकारी gjdoc, आपको एक अलग डॉकलेट का उपयोग करने पर विचार करना चाहिए
इसके बजाय आपके उद्देश्यों के लिए, उदाहरण के लिए XmlDoclet। आप डॉकलेट एपीआई का भी उपयोग कर सकते हैं
सीधे एक नया डॉकलेट लागू करके।

-लिंकस्रोत
प्रत्येक कक्षा के लिए सिंटैक्स-हाइलाइट किए गए स्रोत कोड वाला एक पृष्ठ बनाएं। डिफ़ॉल्ट रूप से, यह
पृष्ठ उत्पन्न नहीं हुआ है.

स्रोत कोड को "स्रोत" लेबल वाले बटन पर क्लिक करके एक्सेस किया जा सकता है
नेविगेशन बार, या किसी कंस्ट्रक्टर, फ़ील्ड, विधि या इनर के नाम पर क्लिक करके
क्लास दस्तावेज़ीकरण पृष्ठ के विवरण अनुभाग में क्लास।

-उपयोग
क्रॉस-रेफरेंस जानकारी वाला एक पेज बनाएं। डिफ़ॉल्ट रूप से, यह पृष्ठ नहीं है
उत्पन्न।

क्रॉस-रेफरेंस जानकारी को लेबल किए गए बटन पर क्लिक करके एक्सेस किया जा सकता है
नेविगेशन बार में `उपयोग करें'.

'उपयोग' पृष्ठ दस्तावेज़ सेट में सभी वर्गों/इंटरफ़ेस को सूचीबद्ध करता है
प्रश्न में वर्ग (प्रकार) का विस्तार/कार्यान्वयन करें; प्रकार के फ़ील्ड; तरीके या
प्रकार के एक पैरामीटर को स्वीकार करने वाले निर्माता; प्रकार लौटाने वाली विधियाँ; और
प्रकार फेंकने वाली विधियाँ या निर्माता।

-लेखक
आउटपुट में लेखक की जानकारी शामिल करें।

जब निर्दिष्ट किया जाता है, तो लेखक की जानकारी का उपयोग करके निर्दिष्ट की जाती है @लेखक javadoc में टैग करें
टिप्पणियाँ आउटपुट में शामिल की जाती हैं। डिफ़ॉल्ट रूप से, @लेखक टैग को नजरअंदाज कर दिया जाता है.

-संस्करण
आउटपुट में संस्करण जानकारी शामिल करें.

जब निर्दिष्ट किया जाता है, तो संस्करण जानकारी का उपयोग करके निर्दिष्ट किया जाता है @संस्करण javadoc में टैग करें
टिप्पणियाँ आउटपुट में शामिल की जाती हैं। डिफ़ॉल्ट रूप से, @संस्करण टैग को नजरअंदाज कर दिया जाता है.

-लाइसेंसपाठ
मान लें कि प्रत्येक स्रोत फ़ाइल में पहली टिप्पणी में लाइसेंस टेक्स्ट है, और जोड़ें
प्रत्येक उत्पन्न वर्ग पृष्ठ के पादलेख में लाइसेंस की जानकारी।

यह एक विशिष्ट विकल्प है gjdoc और सूर्य के अनुकूल नहीं है जावाडोक.

यह विकल्प मुफ़्त और मुक्त स्रोत परियोजनाओं के साथ उपयोग के लिए है जहां स्रोत कोड है
कानूनी कारण होने पर आमतौर पर बॉयलरप्लेट लाइसेंस टिप्पणी के साथ उपसर्ग किया जाता है
दस्तावेज़ में लाइसेंस शामिल करने के लिए.

-docfilessubdirs
में सभी फ़ाइलों को पुनरावर्ती रूप से कॉपी करें doc-files प्रत्येक पैकेज निर्देशिका की उप-निर्देशिका।

आमतौर पर, केवल फ़ाइलें ही doc-files उप-निर्देशिका को नीचे उतरे बिना कॉपी किया जाता है
फिर से।

-बहिष्कृतdocfilessubdir नाम:नाम: ...
कुछ निर्देशिकाओं को सीधे नीचे कॉपी न करें doc-files उप-निर्देशिकाएँ जब
पुनरावर्ती रूप से उतरना।

इस विकल्प का तर्क निर्देशिका नामों की एक कोलन-पृथक सूची होनी चाहिए।

यह विकल्प केवल तभी समझ में आता है यदि -docfilessubdirs भी निर्दिष्ट है. इस मामले में, कोई भी
उप-निर्देशिका सीधे a के नीचे स्थित है doc-files सूचीबद्ध होने पर निर्देशिका छोड़ दी जाती है।

रिवाज प्रलेखन टैग

-टैगलेटपथ पथसूची
Search पथसूची उपयोग करते हुए निर्दिष्ट बाद की टैगलेट कक्षाओं को लोड करते समय -टैगलेट.

पथसूची किसी निर्देशिका या जार फ़ाइल के लिए आपके द्वारा अलग किए गए एक या अधिक पथ होने चाहिए
प्लेटफ़ॉर्म का पथ विभाजक (आमतौर पर : or ;).

-टैगलेट कक्षा का नाम
एक टैगलेट पंजीकृत करें.

कक्षा का नाम जावा क्लास कार्यान्वयन का पूर्णतः योग्य नाम होना चाहिए
com.sun.tools.doclet.टैगलेट.

टैगलेट कक्षाओं को निर्दिष्ट क्लासपाथ से लोड किया जाएगा -टैगलेटपथसे,
क्लासपाथ का उपयोग करके निर्दिष्ट किया गया है -क्लासपाथ और डिफ़ॉल्ट क्लासपाथ से।

का दस्तावेज़ीकरण देखें com.sun.tools.doclet.टैगलेट अधिक जानकारी के लिए।

ध्यान दें कि सरल टैग के लिए भी है -टैग.

-टैग tagspec
एक सामान्य टैगलेट पंजीकृत करें.

का प्रारूप tagspec होना चाहिए : :" ".

टैग नाम मिलान करने योग्य टैग नाम है, बिना अग्रणी @ चिह्न के।

झंडे निम्नलिखित वर्णों में से एक या अधिक है, जहाँ प्रत्येक वर्ण एक निर्दिष्ट करता है
स्रोत कोड संदर्भ जिसमें टैग को पहचाना जाना है।

a सभी संदर्भ

c कंस्ट्रक्टर्स

f फ़ील्ड्स

m तरीकों

o सिंहावलोकन

p संकुल

t प्रकार (वर्ग, इंटरफ़ेस, अपवाद, त्रुटियाँ)

X विशेष वर्ण जो टैगलेट को अस्थायी रूप से पूरी तरह से अक्षम कर देता है।

टैगहेड टैग के लिए समर्पित अनुभाग के हेडर में प्रदर्शित होने वाली स्ट्रिंग है
सवाल।

उदाहरण के लिए, किसी टैग मिलान को परिभाषित करने के लिए @cvsid जिसे अवलोकन में स्वीकार किया जाना है,
पैकेज और टाइप पेज और जिसे हेडर के साथ लेबल किया गया है CVS ID, आप करेंगे
उल्लिखित करना:

-टैग सीवीएसआईडी: टीपीओ: "सीवीएस आईडी"

मान लीजिए कि एक वर्ग javadoc टिप्पणी में शामिल है

@cvsid $Id: cp-tools.texinfo,v 1.9 2012-03-07 15:27:27 gnu_andrew ऍक्स्प $

फिर HTML आउटपुट में कुछ इस तरह होगा

सीवीएस आईडी:
$आईडी: cp-tools.texinfo,v 1.9 2012-03-07 15:27:27 gnu_andrew ऍक्स्प $

रनिंग अन्य डॉकलेट्स

-docletpath पथसूची
Search पथसूची निर्दिष्ट डॉकलेट के लिए कक्षाएं लोड करते समय -डॉकलेट.

पथसूची किसी निर्देशिका या जार फ़ाइल के लिए आपके द्वारा अलग किए गए एक या अधिक पथ होने चाहिए
प्लेटफ़ॉर्म का पथ विभाजक (आमतौर पर : or ;).

-डॉकलेट कक्षा का नाम
मानक HtmlDoclet के बजाय निर्दिष्ट डॉकलेट चलाएँ।

कक्षा का नाम उस वर्ग का पूर्ण-योग्य नाम होना चाहिए जिसमें सार्वजनिक डिफ़ॉल्ट हो
कंस्ट्रक्टर और निम्नलिखित हस्ताक्षर के साथ एक विधि शामिल है:

आयात com.sun.javadoc.RootDoc;
सार्वजनिक स्थैतिक बूलियन प्रारंभ (रूटडॉक रूटडॉक)

डॉकलेट कक्षाओं को निर्दिष्ट क्लासपाथ से लोड किया जाएगा -docletpathसे,
क्लासपाथ का उपयोग करके निर्दिष्ट किया गया है -क्लासपाथ और डिफ़ॉल्ट क्लासपाथ से।

RSI प्रारंभ विधि को डॉकलेट एपीआई द्वारा उजागर की गई जानकारी को संसाधित करना चाहिए रूटडॉक
और वापस <strong>उद्देश्य</strong> सफलता पर, असत्य विफलता पर।

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

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

जोड़ना जानकारी सेवा मेरे la उत्पादन

-विंडोशीर्षक टेक्स्ट
उपयोग टेक्स्ट ब्राउज़र विंडो शीर्षक उपसर्ग के रूप में।

निर्दिष्ट होने पर, प्रत्येक पृष्ठ के लिए ब्राउज़र विंडो शीर्षक के साथ उपसर्ग किया जाएगा टेक्स्ट
डिफ़ॉल्ट स्ट्रिंग के बजाय जनरेट किया गया API प्रलेखन.

टेक्स्ट सादा पाठ होना चाहिए (इसमें HTML टैग नहीं होने चाहिए)।

-doctitle टेक्स्ट
अवलोकन पृष्ठ के हेडर टेक्स्ट को इस पर सेट करें टेक्स्ट.

टेक्स्ट एक छोटी सादा पाठ स्ट्रिंग होनी चाहिए.

एकल पैकेज के लिए दस्तावेज़ तैयार करते समय, इस विकल्प को निर्दिष्ट करना बाध्य करता है
सिंहावलोकन पृष्ठ का निर्माण.

-शीर्षक htmltext
htmltext प्रत्येक जेनरेट किए गए पृष्ठ के दाएँ ऊपरी कोने पर। htmltext आमतौर पर है
दस्तावेज़ीकृत किए जा रहे प्रोजेक्ट के नाम पर सेट करें।

-फुटर htmltext
htmltext प्रत्येक जेनरेट किए गए पृष्ठ के दाहिने निचले कोने पर। htmltext अक्सर
के समान मान पर सेट करें -शीर्षक.

-तल htmltext
htmltext प्रत्येक जेनरेट किए गए पेज के बिल्कुल नीचे तक, पूरी चौड़ाई में फैला हुआ
पृष्ठ। निर्दिष्ट होने पर, htmltext आमतौर पर इसमें कॉपीराइट नोटिस और/या शामिल होता है
अन्य परियोजना पृष्ठों के लिंक।

-स्टाइलशीट जोड़ें पट्टिका
उपयोगकर्ता द्वारा निर्दिष्ट स्टाइलशीट के साथ डिफ़ॉल्ट सीएसएस स्टाइल शीट को संवर्धित करें पट्टिका.

दी गई स्टाइलशीट को डिफ़ॉल्ट के अतिरिक्त प्रत्येक HTML पेज द्वारा आसानी से लोड किया जाता है
वाले, अंतिम स्टाइलशीट के रूप में।

ध्यान दें कि सीएसएस कैस्केडिंग नियम लागू होते हैं। यानी आपकी स्टाइल प्रॉपर्टीज ही होंगी
यदि उनके पास उच्चतर कैस्केडिंग क्रम है तो उन्हें असाइन किया गया है gjdocकी डिफ़ॉल्ट शैली. एक सरल
यह सुनिश्चित करने का तरीका है कि मामला यही है कि आप अपने ओवरराइड घोषित करें ! महत्वपूर्ण.

देखोhttp://www.w3.org/TR/REC-CSS2/cascade.html#कैस्केडिंग-ऑर्डर>.

-ग्रुप शीर्षक pkgwildcard:pkgwildcard: ...
दिए गए पैकेजों को अवलोकन पृष्ठ पर एक अलग समूह में व्यवस्थित करें।

पहला तर्क एक संक्षिप्त सादा पाठ होना चाहिए जिसका उपयोग शीर्षक के रूप में किया जाता है
पैकेज समूह. दूसरा तर्क पैकेज की कोलन से अलग की गई सूची होनी चाहिए
वाइल्डकार्ड. समूह में दस्तावेज़ीकरण सेट के सभी पैकेज शामिल होंगे जिनके नाम
दिए गए किसी भी वाइल्डकार्ड से मेल खाता है।

केवल एक वाइल्डकार्ड वर्ण है, *, जो पैकेज नाम के दोनों अक्षरों से मेल खाता है
घटक और . पैकेज नाम घटकों को अलग करना। उदाहरण के लिए, j*रेगेक्स होगा
मैच पैकेज java.util.regex. एक अधिक उपयोगी उदाहरण होगा जावैक्स.स्विंग* मैच के लिए
javax.स्विंग और इसके सभी उप-पैकेज।

यह विकल्प कई बार दिया जा सकता है।

FIXME: ग्रुप नेस्टिंग के बारे में जानकारी यहां दी गई है।

gjdoc -ग्रुप "कोर क्लासेस" 'जावा*' \
-समूह "स्विंग" 'javax.swing*' \
-समूह "एक्सएमएल एपीआई" 'javax.xml*' \
-समूह "अन्य एक्सटेंशन" javax* \
...

-अवलोकन पट्टिका
से XHTML बॉडी फ़्रैगमेंट जोड़ें पट्टिका अवलोकन पृष्ठ पर.

पट्टिका HTML के साथ एक XHTML फ़्रैगमेंट होना चाहिए परिवर्तन रूट नोड के रूप में टैग करें।

इस विकल्प का उपयोग संपूर्ण दस्तावेज़ सेट का विवरण प्रदान करने के लिए किया जा सकता है।

निर्दिष्ट होने पर, टुकड़े का पहला वाक्य तालिकाओं के ऊपर रखा जाएगा
टुकड़े की पूरी प्रतिलिपि के लिंक के साथ दस्तावेजित पैकेजों को सूचीबद्ध करना
जिसे टेबल के नीचे रखा गया है.

एकल पैकेज के लिए दस्तावेज़ तैयार करते समय, इस विकल्प को निर्दिष्ट करना बाध्य करता है
सिंहावलोकन पृष्ठ का निर्माण.

-स्टाइलशीटफाइल पट्टिका
सीएसएस स्टाइलशीट का उपयोग करें पट्टिका डिफ़ॉल्ट CSS स्टाइलशीट के बजाय।

यदि आप केवल डिफ़ॉल्ट स्टाइलशीट के कुछ हिस्सों को ओवरराइड करना चाहते हैं, तो इसका उपयोग करें -स्टाइलशीट जोड़ें
बजाय.

-शीर्षक टेक्स्ट
पदावनत। उपयोग -doctitle टेक्स्ट बजाय.

-हेल्पफ़ाइल पट्टिका
इस विकल्प को फिलहाल नजरअंदाज कर दिया गया है.

लागू होने पर, यह XHTML खंड का उपयोग करेगा पट्टिका सहायता पृष्ठ सामग्री के लिए
डिफ़ॉल्ट सहायता पाठ के बजाय.

नियंत्रित करना la आउटपुट।

-d डायरेक्टरी
सभी आउटपुट फ़ाइलें इसमें रखें डायरेक्टरी (और उप-निर्देशिकाएँ)। डायरेक्टरी उत्पन्न होगा
यदि यह मौजूद नहीं है, तो सभी गैर-मौजूदा मूल निर्देशिकाओं और सभी आवश्यक सहित
उप-निर्देशिकाएँ।

यदि निर्दिष्ट नहीं है, तो आउटपुट को वर्तमान निर्देशिका में रखा जाएगा।

-लोकेल नाम
लोकेल का प्रयोग करें नाम सभी उद्देश्यों के लिए डिफ़ॉल्ट स्थान के बजाय।

नाम प्रपत्र में एक स्थान निर्दिष्ट होना चाहिए ll_CC[_VAR] जहां ll एक लोअरकेस दो है-
पत्र आईएसओ-639 भाषा कोड, CC एक वैकल्पिक अपरकेस दो-अक्षर ISO-3166 देश है
कोड, और वर एक वैकल्पिक वैरिएंट कोड है. उदाहरण के लिए, en अंग्रेजी निर्दिष्ट करता है, en_US
यूएस अंग्रेजी निर्दिष्ट करता है, और en_US_WIN अमेरिकी अंग्रेजी का एक विकृत संस्करण निर्दिष्ट करता है
स्थानीय.

ध्यान दें कि इस विकल्प का शब्दार्थ बिल्कुल कंस्ट्रक्टर से मेल खाता है
कक्षा के java.util.Locale.

यह विकल्प वर्तमान में केवल यह निर्धारित करता है कि आउटपुट को सॉर्ट करने के लिए किस कोलेटर का उपयोग किया जा रहा है
तत्व. इसका मतलब यह है कि लोकेल का प्रभाव केवल तभी होगा जब आप गैर-का उपयोग कर रहे हों
पहचानकर्ताओं में ASCII वर्ण.

-चारसेट चारसेट
पदावनत। आउटपुट XHTML फ़ाइलों में निर्दिष्ट एन्कोडिंग को दिए गए एन्कोडिंग से ओवरराइड करें
by चारसेट.

यदि यह विकल्प नहीं दिया गया है, तो आउटपुट XHTML में एन्कोडिंग विनिर्देश को चुना जाता है
फ़ाइल लिखते समय उपयोग की गई एन्कोडिंग का मिलान करें (साथ दी गई एन्कोडिंग)। -docencoding,
या आपके प्लेटफ़ॉर्म की डिफ़ॉल्ट एन्कोडिंग)।

के लिए शब्दार्थ चारसेट यहाँ निर्दिष्ट हैं:
<http://www.w3.org/TR/2000/REC-xml-20001006#NT-EncName>. सभी व्यावहारिक उद्देश्यों के लिए,
वे वर्णसेट पैरामीटर स्वीकार करने वाले अन्य विकल्पों के समान हैं।

यह विकल्प यहां अनुकूलता के लिए है जावाडोक और इससे बचना चाहिए।

-docencoding चारसेट
अपने प्लेटफ़ॉर्म के बजाय आउटपुट फ़ाइलें लिखते समय दिए गए चारसेट एन्कोडिंग का उपयोग करें
डिफ़ॉल्ट एन्कोडिंग.

के उदाहरण हैं चारसेट रहे हमें-ascii, आईएसओ 8859-1 or UTF-8.

इस विकल्प का शब्दार्थ वर्ग के रचनाकारों से बिल्कुल मेल खाता है
java.util.Locale.

-validhtml
मान्य XHTML कोड को बलपूर्वक जनरेट करें. इससे पारंपरिक अनुकूलता टूट जाती है
कुछ हद तक Javadoc टूल।

यदि यह विकल्प निर्दिष्ट किया गया है, तो एंकर नामों को तोड़ दिया जाएगा ताकि वे मान्य हों
XHTML 1.1 विनिर्देश के अनुसार. हालाँकि, एक दस्तावेज़ीकरण सेट तैयार किया गया है
इस विकल्प को पारंपरिक जावाडोक टूल के उचित उपयोग से नहीं जोड़ा जा सकता है। यह
हालाँकि, Gjdoc का उपयोग करके ठीक से लिंक किया जा सकता है।

इस विकल्प के बिना, निष्पादन योग्य वर्ग के सदस्यों के लिए एंकर नाम पारंपरिक का उपयोग करते हैं
प्रारूप, उदाहरण के लिए: "foo(String,int[])"। यह पारंपरिक के अनुकूल है
Javadoc टूल, लेकिन HTML 4.0 और XHTML 1.0 और 1.1 दोनों विनिर्देशों के अनुसार,
इस प्रारूप में अवैध वर्ण शामिल हैं. कोष्ठक, वर्गाकार कोष्ठक और अल्पविराम
एंकर नामों में इसकी अनुमति नहीं है।

-बेसयूरल यूआरएल
किसी पृष्ठ URL के सापेक्ष हार्डवायर करें यूआरएल प्रत्येक उत्पन्न पृष्ठ में।

यदि आप दस्तावेज़ तैयार कर रहे हैं जो विशेष रूप से एक निश्चित समय पर उपलब्ध होगा
यूआरएल, आपको इस यूआरएल को निर्दिष्ट करने के लिए इस विकल्प का उपयोग करना चाहिए।

इससे स्पैमर द्वारा उपयोग किए जाने वाले कुछ रीडायरेक्ट हमलों से बचने में मदद मिल सकती है, और यह सहायक भी हो सकता है
कुछ वेब क्लाइंट के लिए.

शब्दाडंबर ऑप्शंस

-शांत
चेतावनियों और त्रुटि संदेशों को छोड़कर सभी आउटपुट को रोकें।

-कहना
किस बारे में बहुत वाचाल हो gjdoc कर रहा है।

इस विकल्प को फिलहाल नजरअंदाज कर दिया गया है.

वास्तविक मशीन ऑप्शंस

रवि का जावाडोक टूल पर आधारित प्रतीत होता है जेवैक और इस तरह यह वीएम पर काम करता प्रतीत होता है
स्तर. gjdocइसके विपरीत, एक शुद्ध जावा एप्लिकेशन है।

इसलिए, gjdoc केवल निम्न VM-स्तरीय विकल्पों को नकली या अनुकरण कर सकता है।

-क्लासपाथ पथसूची
वर्चुअल मशीन सेट करें क्लासपाथ सेवा मेरे पथसूची.

अधिकांश मामलों में आपको उपयोग करना चाहिए -docletpath or -टैगलेटपथ इस विकल्प के बजाय।

पथसूची किसी निर्देशिका या जार फ़ाइल के लिए आपके द्वारा अलग किए गए एक या अधिक पथ होने चाहिए
प्लेटफ़ॉर्म का पथ विभाजक (आमतौर पर : or ;).

यदि यह विकल्प रैपर स्तर पर इंटरसेप्ट नहीं किया गया है, gjdoc वर्तमान में यह नकली है
बुला System.setProperty("java.class.path", पथसूची); और एक चेतावनी आउटपुट करता है.

-बूटक्लासपथ पथसूची
वर्चुअल मशीन सेट करें बूटक्लासपथ सेवा मेरे पथसूची.

यदि यह विकल्प रैपर स्तर पर इंटरसेप्ट नहीं किया गया है, gjdoc एक चेतावनी आउटपुट करता है.

-Jvmopt
वर्चुअल मशीन में एक मनमाना पैरामीटर पास करें gjdoc इससे संचालित।

यदि यह विकल्प रैपर स्तर पर इंटरसेप्ट नहीं किया गया है, gjdoc का अनुकरण करने का प्रयास करता है
विकल्प और एक चेतावनी आउटपुट करता है।

वर्तमान में, केवल VM विकल्प -D सिस्टम गुणों की सेटिंग के लिए अनुकरण किया जाता है।

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