gjdoc-4.8 - متصل بالإنترنت في السحابة

برنامج:

اسم

cp-tools - دليل أدوات GNU Classpath

موجز

جدوك [-مسار المصدر قائمة المسار]
[-كل] [-الحزم الفرعية pkg: pkg: ...] [-استبعاد com.pkglist]
[-التشفير محارف] [-محدد الاسم] [-source الافراج عن]
[-عامة] [-محمي] [-صفقة] [-نشر]
[- العنوان نص] [-رأس نص] [-تذييل نص] [-قاع نص]
[-حلقة الوصل URL] [-ربط غير متصل URL مسار] [-مؤهل pkg: pkg: ...]
[-المسار قائمة المسار] [-تاج اسم_الفئة] [-بطاقة شعار com.tagspec]
[-استعمال] [-Linksource] [-المؤشر] [-نوينديكس] [- لا]
[-الإصدار] [-مؤلف] [-عدم] [- إضافة نمط ملف]
[-d targetdir]
[حزم...] [ملفات المصدر...] [@كمدفايل]

جدوك [-مسار المصدر قائمة المسار]
[-كل] [-الحزم الفرعية pkg: pkg: ...] [-استبعاد com.pkglist]
[-التشفير محارف] [-محدد الاسم] [-source الافراج عن]
[-عامة] [-محمي] [-صفقة] [-نشر]
[-docletpath قائمة المسار] [-دوكليت اسم_الفئة]
[حزم...] [ملفات المصدر...] [@كمدفايل]
[خيارات doclet]

com.gjdoc --مساعدة

com.gjdoc --الإصدار

يتم سرد الخيارات الأكثر فائدة فقط هنا ؛ انظر أدناه للباقي.

الوصف

يمكن استخدام Gjdoc بطريقتين: كأداة توثيق قائمة بذاتها ، أو كمحرك لملف
Doclet المحدد من قبل المستخدم.

في الوضع الافتراضي ، سيستخدم Gjdoc Doclet القياسي أتش تي أم أل لتوليد مجموعة من
صفحات HTML. الاستخدام المتعارف عليه هو:

gjdoc -s src / java / -all -d api-docs /

هنا، src / جافا / هو جذر التسلسل الهرمي لفئة شفرة المصدر ، -كل يعني أن كل شيء صالح
يجب معالجة ملفات Java الموجودة ضمن هذا الدليل الجذر ، و api-docs / هل
الدليل حيث يجب وضع الوثائق التي تم إنشاؤها.

لمعرفة المزيد حول تشغيل Doclets بخلاف Standard Doclet ، راجع الدليل.

OPTIONS

خيار نبذة عامة by النوع

فيما يلي ملخص لجميع خيارات كل من Gjdoc و Standard Doclet ، مجمعة حسب
يكتب. التفسيرات في الأقسام التالية.

مصدر المجموعات مزيد من الخيارات
-مسار المصدر قائمة المسار -الحزم الفرعية com.pkglist -استبعاد com.pkglist

مصدر شكل مزيد من الخيارات
-source الافراج عن -التشفير ترميز - قاطع

الترابط مزيد من الخيارات
-حلقة الوصل URL -ربط غير متصل URL ملف -مؤهل pkg: pkg: ...

جيل مزيد من الخيارات
-مؤلف -ترخيص النص -استعمال -الإصدار -المؤشر -نوينديكس
-محتج -قائمة غير محددة -لا مساعدة - نونافبار
-عدم - لا -عامة -محمي -صفقة -نشر
-docfilesubdirs -مستثنى من ذلك اسم
-Linksource

الناتج مزيد من الخيارات
-d -محدد الاسم -شريحة محارف -التوثيق محارف
-validhtml -باسيرل URL

ديكور مزيد من الخيارات
-windowtitle نص - العنوان نص -لقب نص
-رأس نص -تذييل نص -قاع نص
-ملف المساعدة ملف -ملف الأنماط ملف - إضافة نمط ملف
-مجموعة التجمع pkgpattern: pkgpattern: ...

تاجليت مزيد من الخيارات
-المسار -تاج اسم_الفئة -بطاقة شعار com.tagspec

دوكليت مزيد من الخيارات
-docletpath -دوكليت اسم_الفئة

الإسهاب مزيد من الخيارات
-هادئ -إفراط

افتراضي تشمل مزيد من الخيارات
- كلاسباث -bootclasspath -J vmopt

اختيار التي مصدر ملفات إلى المعالجة:

-s قائمة المسار
-مسار المصدر قائمة المسار
ابحث عن ملفات المصدر في الدليل أو الدلائل المحددة.

قائمة المسار يجب أن يكون واحدًا أو أكثر من مسارات الدليل مفصولة بمسار النظام الأساسي الخاص بك
فاصل (عادة : or ;).

إذا لم يتم إعطاء هذا الخيار ، com.gjdoc سيبحث عن ملفات المصدر في الوقت الحالي
الدليل.

يجب أن تكون الدلائل المحددة أدلة جذر من حيث حزمة Java
نظام. على سبيل المثال ، إذا كنت تريد إنشاء وثائق للفئات في الحزمة
foo.bar، يجب عليك تحديد الدليل الذي يحتوي على المستوى الأعلى فو دليل فرعي
ليس الدليل فو / بار / حيث توجد ملفات جافا المصدر.

الاسم المستعار المختصر -s خاص بـ com.gjdoc وغير متوافق مع الشمس جافادوك.

-كل
[تجريبي] معالجة جميع ملفات مصدر Java الصالحة الموجودة في الدلائل المدرجة في
مسار المصدر والأدلة الفرعية الخاصة بهم.

هذا خيار خاص بـ com.gjdoc وغير متوافق مع الشمس جافادوك.

-الحزم الفرعية pkg: pkg: ...
قم بمعالجة الفئات في حزم Java المحددة وجميع الحزم الفرعية بشكل متكرر.
لاحظ أنه يجب فصل أسماء الحزم المتعددة بنقطتين بدلاً من المسافات.

-استبعاد pkg: pkg: ...
لا تقم بمعالجة الفئات في حزم Java المحددة وجميع الحزم الفرعية بشكل متكرر.
يمكن استخدام هذا الخيار بالاشتراك مع -كل or -الحزم الفرعية من أجل استبعادها
الحزم الفردية أو حزم الأشجار الفرعية من الإخراج.

حزم
معالجة جميع الفئات في حزم Java المحددة.

ملفات المصدر
قم بمعالجة الفئات في ملفات مصدر Java المحددة.

تحديد ال شكل of إدخال ملفات

-source الافراج عن
افترض أن الملفات المصدر تستهدف الإصدار المحدد لمنصة Java.

الافراج عن يجب أن يكون رقم إصدار إصدار منصة Java بالتنسيق
MAJOR.MINOR ، على سبيل المثال 1.4.

يتم حاليًا تجاهل هذا الخيار فيما عدا أنه يظهر خطأ إذا كان رقم الإصدار
غير 1.2, 1.3 or 1.4 محدد.

-التشفير محارف
افترض أن ملفات المصدر مشفرة باستخدام محارف.

أمثلة على محارف . US-ASCII, ISO-8859-1 or UTF-8.

دلالات محارف متطابقة مع تلك الخاصة بـ
java.nio.charset.Charset.forName (سلسلة).

- قاطع
استخدم java.text.BreakIterator الخاص بالإعدادات المحلية بدلاً من الجملة الأولى الداخلية
كاشف.

افتراضيا، com.gjdoc يستخدم خوارزمية داخلية لتحديد مكان انتهاء الجملة. متى
يتم إعطاء هذا الخيار ، وسوف يستخدم بدلاً من ذلك java.text.BreakIterator على سبيل المثال
لغة معينة مع -محدد (أو اللغة الافتراضية).

يجب تحديد هذا الخيار عند التقديم com.gjdoc لشفرة المصدر علق في غير
اللغة اللاتينية التي لا يعمل لها كاشف الجملة الأولى الافتراضي. للجميع
في حالات أخرى ، ينتج عن الإعداد الافتراضي (لا تستخدم BreakIterator) نتائج أفضل في
وقت كتابة هذه السطور.

الترابط مع آخر توثيق باكجات

-حلقة الوصل URL
إنشاء ارتباطات تشعبية لمجموعة وثائق أخرى.

افتراضيا، com.gjdoc سيقوم فقط بإنشاء ارتباطات تشعبية للفئات في مجموعة المصدر. استخدم هذا
خيار لإنشاء ارتباطات تشعبية بالإضافة إلى الفئات التي يغطيها المحدد
مجموعة الوثائق.

URL يجب أن يكون عنوان URL الجذر لمجموعة الوثائق الأخرى. على سبيل المثال ، لإضافة
الارتباطات التشعبية إلى GNU Classpath ، حدد ما يلي:

-حلقة الوصل http://developer.classpath.org/doc/

• -حلقة الوصل يمكن تحديد الخيار عدة مرات.

لاحظ أن تحديد ملف -حلقة الوصل الخيار سيتسبب في وصول HTTP في كل مرة يكون فيها gjdoc
استدعى. يمكنك استخدام -ربط غير متصل بدلا من ذلك لتجنب هذا الوصول.

-ربط غير متصل URL ملف
قم بإنشاء ارتباطات تشعبية لمجموعة وثائق أخرى موجودة أيضًا في الملف المحلي
نظام.

يعمل هذا الخيار تمامًا مثل -حلقة الوصل، باستثناء أنه يصل إلى نظام الملفات المحلي
بدلاً من الشبكة لتحديد الفئات التي يغطيها الارتباط
مجموعة الوثائق.

عند استخدام -ربط غير متصل لا يتم الوصول إلى مجموعة الوثائق البعيدة على الإطلاق ، والتي يمكن
تسريع وقت التوليد بشكل كبير اعتمادًا على اتصال الشبكة الخاص بك. ال
تم إنشاء ارتباطات تشعبية لمجموعة الوثائق ولكن الرجوع إلى المجموعة البعيدة وليس إلى
المحلي ، بحيث يمكنك توزيع الوثائق دون المزيد
التبعيات.

• -ربط غير متصل يمكن تحديد الخيار عدة مرات.

-مؤهل pkg: pkg: ...
لا تؤهل أسماء الفئات في الحزم المحددة مع اسم الحزمة الخاص بها.

بشكل افتراضي ، يتم عرض اسم الفئة غير مؤهل فقط إذا كان الفصل جزءًا من
مجموعة المصدر أو مجموعة وثائق مرتبطة ، ومؤهلة باسمها
تحتوي على عبوة إذا لم تكن كذلك. يمكنك استخدام هذا الخيار لفرض الأسماء غير المؤهلة
للفئات حتى لو لم تكن جزءًا من مجموعة التوثيق.

على سبيل المثال ، عادةً ما يتم تمثيل إشارة إلى فئة String مؤهلة تمامًا كـ
java.lang.String (ما لم تقم بالارتباط بمجموعة التوثيق المناسبة باستخدام -حلقة الوصل)
لأنه ليس جزءًا من مجموعة الوثائق. يمكنك تحديد -مؤهل
جافا. لانج لتقديم نفس المراجع مثل خيط.

لاحظ أنه بالنسبة لجميع أسماء الفئات غير المؤهلة ، يتم توفير تلميح أداة عند وضع ملف
مؤشر الماوس فوقه في وثائق HTML.

-مؤهل من جميع
حذف مؤهل اسم الحزمة من جميع أسماء الفئات.

حدد هذا الخيار لحذف مؤهلات اسم الحزمة تمامًا ،

اختيار التي معلومات إلى توليد

-عامة
قم فقط بتضمين أعضاء عامة من الطبقات العامة في المخرجات. افتراضيا ، محمي
يتم تضمين أعضاء الفصل أيضًا.

-محمي
قم بتضمين أعضاء عامة أو محميين من الطبقات العامة في المخرجات. هذا ال
افتراضي.

-صفقة
قم بتضمين الأعضاء العامين والمحميون والخاصون بالحزمة من القطاعين العام والخاص بالحزمة
الطبقات.

-نشر
قم بتضمين جميع الفصول الدراسية وأعضاء الفصل بغض النظر عن مستوى وصولهم.

-المؤشر
قم بإنشاء صفحة فهرس واحدة لكل حرف بدلاً من صفحة فهرس واحدة متجانسة.

بشكل افتراضي ، يحتوي الفهرس الذي تم إنشاؤه بواسطة Standard Doclet على جميع الإدخالات في ملف واحد
صفحة. هذا جيد لمجموعات التوثيق الصغيرة ، ولكن بالنسبة للمجموعات الكبيرة ، يجب عليك ذلك
حدد هذا الخيار.

-عدم
تجاهل @منذ العلامات في التعليقات javadoc.

بشكل افتراضي ، يحتوي الإخراج الذي تم إنشاؤه على أقسام تسرد إصدار API الخاص بك
منذ وجود الحزمة أو الفصل الدراسي أو عضو الفصل المعني عندما تكون هذه العلامة
مواجهة. حدد هذا الخيار لحذف هذه المعلومات.

- لا
لا تقم بإنشاء أي صفحات شجرة.

بشكل افتراضي ، يشتمل الناتج الناتج على شجرة وراثة واحدة لكل حزمة ، و- if
تتكون مجموعة التوثيق من حزم متعددة - صفحة بالوراثة الكاملة
شجرة. حدد هذا الخيار لحذف إنشاء هذه الصفحات.

-نوينديكس
لا تقم بإخراج الفهرس الأبجدي.

بشكل افتراضي ، يُنشئ gjdoc فهرسًا أبجديًا لجميع عناصر البرنامج في ملف
مجموعة التوثيق (الحزم والفئات والفئات الداخلية والمنشآت والطرق و
مجالات). حدد هذا الخيار لحذف هذه المعلومات.

-لا مساعدة
لا تنشئ صفحة المساعدة.

يتم تجاهل هذا الخيار حاليًا نظرًا لأن Standard Doclet لا يوفر صفحة تعليمات.

-محتج
لا تقم بإخراج معلومات مضمنة حول الحزم أو الفئات أو أعضاء الفصل المهملة.

بشكل افتراضي ، يضيف Standard Doclet فقرة مميزة مع الإهمال
معلومات لوصف كل عنصر برنامج مهمل. حدد هذا
خيار لحذف هذه المعلومات.

-قائمة غير محددة
لا تقم بإخراج صفحة الملخص لعناصر واجهة برمجة التطبيقات المهملة.

بشكل افتراضي ، ينشئ Doclet القياسي صفحة تسرد جميع عناصر واجهة برمجة التطبيقات المهملة
إلى جانب وصف الإيقاف الذي يتضمن عادةً سبب الإيقاف
والبدائل الممكنة. حدد هذا الخيار لحذف هذه المعلومات.

- نونافبار
لا تقم بإخراج شريط التنقل والرأس والتذييل.

بشكل افتراضي ، يتم تجهيز كل صفحة مخرجات بشريط تنقل علوي (والذي قد يتضمن
رأس يحدده المستخدم) وشريط تنقل سفلي (قد يتضمن مستخدمًا-
التذييل المحدد). حدد هذا الخيار لحذف هذه الزخرفة.

-لا تعليق
احذف كل نصوص التوثيق من الملفات التي تم إنشاؤها وإخراج الإعلانات فقط و
علاقات عنصر البرنامج.

هذا الخيار موجود هنا للتوافق مع جافادوك. إذا كنت تخطط لاستخراج
معلومات عن مشروعك عبر com.gjdoc، يجب أن تفكر في استخدام Doclet مختلف
لأغراضك بدلاً من ذلك ، على سبيل المثال XmlDoclet. يمكنك أيضًا استخدام Doclet API
مباشرة عن طريق تطبيق Doclet جديد.

-Linksource
قم بإنشاء صفحة مع رمز مصدر مميز في بناء الجملة لكل فئة. افتراضيا ، هذا
لم يتم إنشاء الصفحة.

يمكن الوصول إلى شفرة المصدر بالنقر فوق الزر المسمى "المصدر" في ملف
شريط التنقل ، أو عن طريق النقر فوق اسم المُنشئ أو الحقل أو الأسلوب أو الجزء الداخلي
فئة في قسم التفاصيل بصفحة توثيق الفصل.

-استعمال
قم بإنشاء صفحة بمعلومات الإسناد الترافقي. بشكل افتراضي ، هذه الصفحة ليست كذلك
ولدت.

يمكن الوصول إلى معلومات الإسناد الترافقي بالنقر فوق الزر المسمى
"استخدام" في شريط التنقل.

تسرد صفحة "الاستخدام" جميع الفئات / الواجهات في مجموعة التوثيق التي
تمديد / تنفيذ الفئة (النوع) المعني ؛ حقول من النوع طرق أو
المُنشئون يقبلون معلمة من النوع ؛ طرق إرجاع النوع ؛ و
طرق أو صانعي رمي النوع.

-مؤلف
تضمين معلومات المؤلف في الإخراج.

عند تحديدها ، تكون معلومات المؤلف على النحو المحدد باستخدام امتداد @مؤلف العلامة في جافادوك
تم دمج التعليقات في الإخراج. بشكل افتراضي، @مؤلف يتم تجاهل العلامات.

-الإصدار
قم بتضمين معلومات الإصدار في الإخراج.

عند تحديد معلومات الإصدار كما هو محدد باستخدام امتداد @إصدار العلامة في جافادوك
تم دمج التعليقات في الإخراج. بشكل افتراضي، @إصدار يتم تجاهل العلامات.

-ترخيص النص
افترض أن التعليق الأول في كل ملف مصدر يحتوي على نص الترخيص ، وقم بإضافة
معلومات الترخيص لتذييل كل صفحة فئة تم إنشاؤها.

هذا خيار خاص بـ com.gjdoc وغير متوافق مع الشمس جافادوك.

هذا الخيار مخصص للاستخدام مع المشاريع المجانية ومفتوحة المصدر حيث التعليمات البرمجية المصدر
عادةً ما يكون مسبوقًا بتعليق ترخيص معياري ، عندما تكون هناك أسباب قانونية
لتضمين الترخيص في الوثائق.

-docfilesubdirs
انسخ جميع الملفات بشكل متكرر في ملف ملفات doc دليل فرعي لكل دليل حزمة.

عادة ، فقط الملفات الموجودة في ملفات doc يتم نسخ الدليل الفرعي دون تنازلي
بشكل متكرر.

-مستثنى من ذلك الاسم:الاسم: ...
لا تقم بنسخ بعض الدلائل مباشرة تحت ملفات doc الدلائل الفرعية عندما
تنازلي بشكل متكرر.

يجب أن تكون الوسيطة لهذا الخيار عبارة عن قائمة بأسماء الدلائل مفصولة بنقطتين.

يكون هذا الخيار منطقيًا فقط إذا -docfilesubdirs محدد أيضا. في هذه الحالة ، أي
الدليل الفرعي الموجود أسفل ملف ملفات doc تم حذف الدليل إذا تم إدراجه.

Custom توثيق الاوسمة (تاج)

-المسار قائمة المسار
بحث قائمة المسار عند تحميل فئات Taglet اللاحقة المحددة باستخدام -تاج.

قائمة المسار يجب أن يكون مسارًا واحدًا أو أكثر إلى دليل أو ملف جرة ، مفصولاً بامتداد
فاصل مسار النظام الأساسي (عادةً : or ;).

-تاج اسم_الفئة
تسجيل تاجليت.

اسم_الفئة يجب أن يكون الاسم المؤهل بالكامل لتطبيق فئة Java
com.sun.tools.doclets.

سيتم تحميل فئات Taglet من classpath المحدد باستخدام -المسار، من
classpath المحدد باستخدام - كلاسباث ومن مسار الفصل الافتراضي.

انظر وثائق com.sun.tools.doclets لمزيد من المعلومات.

لاحظ أنه بالنسبة للعلامات البسيطة ، يوجد أيضًا -بطاقة شعار.

-بطاقة شعار com.tagspec
تسجيل Taglet عام.

شكل com.tagspec يجب أن تكون : : " ".

اسم العلامة هو اسم العلامة المراد مطابقته ، بدون علامة @ البادئة.

الأعلام هو واحد أو أكثر من الأحرف التالية ، حيث يحدد كل حرف a
سياق التعليمات البرمجية المصدر حيث يتم التعرف على العلامة.

a كل السياقات

c الصانعين

f الحقول

m طرق

o نظرة عامة

p حزم

t أنواع (فئات ، واجهات ، استثناءات ، أخطاء)

X حرفًا خاصًا يؤدي إلى تعطيل Taglet تمامًا مؤقتًا.

تاجهيد هي السلسلة التي يتم عرضها في رأس القسم المخصص للعلامة في
سؤال.

على سبيل المثال ، لتحديد علامة مطابقة تضمين التغريدة الذي يتم قبوله في نظرة عامة ،
حزمة واكتب الصفحات والتي يتم تسميتها بالرأس CVS ID، انت ترغب
حدد:

-tag cvsid: tpo: "معرف CVS"

لنفترض أن تعليق جافادوك للفصل يحتوي على

cvsid $ Id: cp-tools.texinfo، v 1.9 2012-03-07 15:27:27 gnu_andrew Exp $

ثم سيحتوي إخراج HTML على شيء مثل

معرّف CVS:
$ Id: cp-tools.texinfo، v 1.9 2012-03-07 15:27:27 gnu_andrew Exp $

الركض أخرى دوكليتس

-docletpath قائمة المسار
بحث قائمة المسار عند تحميل فئات Doclet المحددة باستخدام -دوكليت.

قائمة المسار يجب أن يكون مسارًا واحدًا أو أكثر إلى دليل أو ملف جرة ، مفصولاً بامتداد
فاصل مسار النظام الأساسي (عادةً : or ;).

-دوكليت اسم_الفئة
قم بتشغيل doclet المحدد بدلاً من HtmlDoclet القياسي.

اسم_الفئة يجب أن يكون اسمًا مؤهلًا بالكامل لفئة ذات قيمة افتراضية عامة
منشئ وتحتوي على طريقة بالتوقيع التالي:

استيراد com.sun.javadoc.RootDoc ​​؛
البداية المنطقية العامة الثابتة (RootDoc ​​rootDoc)

سيتم تحميل فئات Doclet من classpath المحدد باستخدام -docletpath، من
classpath المحدد باستخدام - كلاسباث ومن مسار الفصل الافتراضي.

• بداية يجب أن تعالج الطريقة المعلومات التي تعرضها Doclet API عبر rootDoc
والعودة صحيح على النجاح ، زائف عند الفشل.

إذا كنت تستخدم مستندًا تابعًا لجهة خارجية ، فارجع إلى وثائقه لمزيد من المعلومات
تعليمات. لاحظ أن دعم مستندات الجهات الخارجية هو دعم تجريبي. لو سمحت
الإبلاغ عن أي مشاكل تواجهها ، أو تقديم ملاحظات عند التشغيل بنجاح
تطبيقات الطرف الثالث.

يمكن تحديد هذا الخيار عدة مرات ، وفي هذه الحالة يتم تنفيذ جميع المستندات
مع عرض شجرة المعلومات نفسها عبر Doclet API لكل تشغيل Doclet.

إضافة معلومات إلى ال الناتج

-windowtitle نص
استعمل نص كبادئة عنوان نافذة المتصفح.

عند التحديد ، سيبدأ عنوان نافذة المتصفح لكل صفحة بـ نص
بدلاً من السلسلة الافتراضية ولدت API توثيق.

نص يجب أن يكون نصًا عاديًا (يجب ألا يحتوي على علامات HTML).

- العنوان نص
قم بتعيين نص رأس صفحة النظرة العامة على نص.

نص يجب أن تكون سلسلة نصية قصيرة.

عند إنشاء وثائق لحزمة واحدة ، يفرض تحديد هذا الخيار
إنشاء صفحة النظرة العامة.

-رأس html نص
أضف html نص في الزاوية العلوية اليمنى من كل صفحة تم إنشاؤها. html نص عادة ما يكون
تعيين اسم المشروع الجاري توثيقه.

-تذييل html نص
أضف html نص إلى الركن السفلي الأيمن من كل صفحة تم إنشاؤها. html نص في كثير من الأحيان
لتعيين نفس القيمة مثل -رأس.

-قاع html نص
أضف html نص إلى أسفل كل صفحة تم إنشاؤها ، بما في ذلك العرض الكامل لـ
الصفحة. عند التحديد ، html نص يتكون عادةً من إشعار حقوق النشر و / أو
روابط لصفحات المشروع الأخرى.

- إضافة نمط ملف
عزز أوراق أنماط CSS الافتراضية بورقة الأنماط المحددة من قبل المستخدم ملف.

يتم تحميل ورقة الأنماط المحددة ببساطة بواسطة كل صفحة HTML بالإضافة إلى الصفحة الافتراضية
منها ، باعتبارها آخر ورقة أنماط.

لاحظ أنه يتم تطبيق قواعد CSS المتتالية. وهذا يعني أن خصائص أسلوبك ستكون فقط
تم تعيينه إذا كان لديهم ترتيب متتالي أعلى من com.gjdocالنمط الافتراضي لـ. واحد بسيط
طريقة التأكد من أن هذا هو الحال هو إعلان التجاوزات الخاصة بك ! هامة.

نرىhttp://www.w3.org/TR/REC-CSS2/cascade.html# ترتيب متتالي>.

-مجموعة عنوان pkgwildcard:pkgwildcard: ...
رتب الحزم المحددة في مجموعة منفصلة في صفحة النظرة العامة.

يجب أن تكون الوسيطة الأولى عبارة عن نص قصير عادي يتم استخدامه كعنوان لملف
مجموعة الحزمة. يجب أن تكون الوسيطة الثانية عبارة عن قائمة حزمة مفصولة بنقطتين
البدل. ستتألف المجموعة من جميع الحزم في مجموعة التوثيق باسمها
يطابق أيًا من أحرف البدل المحددة.

لا يوجد سوى حرف بدل واحد ، *، والذي يطابق كلا الحرفين في اسم الحزمة
المكونات و . فصل مكونات اسم الحزمة. على سبيل المثال، ي * regex سوف
حزمة المباراة java.util.regex. سيكون المثال الأكثر فائدة هو javax.swing * لمطابقة
javax.swing وجميع حزمها الفرعية.

يمكن إعطاء هذا الخيار عدة مرات.

FIXME: معلومات حول التعشيش الجماعي هنا.

gjdoc -group "الفئات الأساسية" 'java *' \
-مجموعة "Swing" 'javax.swing *' \
-مجموعة "XML APIs" 'javax.xml *' \
-مجموعة "ملحقات أخرى" javax * \


-نظرة عامة ملف
أضف جزء نص XHTML من ملف إلى صفحة النظرة العامة.

ملف يجب أن يحتوي على جزء XHTML مع HTML الجسدي علامة كعقدة جذر.

يمكن استخدام هذا الخيار لتوفير وصف لمجموعة الوثائق ككل.

عند التحديد ، سيتم وضع الجملة الأولى من الجزء فوق الجداول
سرد الحزم الموثقة ، مع رابط للنسخة الكاملة للجزء
التي توضع تحت الجداول.

عند إنشاء وثائق لحزمة واحدة ، يفرض تحديد هذا الخيار
إنشاء صفحة النظرة العامة.

-ملف الأنماط ملف
استخدم ورقة أنماط CSS بتنسيق ملف بدلاً من أوراق أنماط CSS الافتراضية.

إذا كنت تريد فقط تجاوز أجزاء من أوراق الأنماط الافتراضية ، فاستخدم - إضافة نمط
بدلا من ذلك.

-لقب نص
إهمال. استعمل - العنوان نص بدلا من ذلك.

-ملف المساعدة ملف
هذا الخيار تم تجاهله حاليا.

عند تنفيذه ، سيستخدم جزء XHTML بتنسيق ملف لمحتويات صفحة المساعدة
بدلاً من نص التعليمات الافتراضي.

السيطرة ال انتاج.

-d دليل
ضع كل ملفات الإخراج في دليل (والأدلة الفرعية). دليل سيتم إنشاؤه
إذا لم يكن موجودًا ، بما في ذلك جميع الدلائل الرئيسية غير الموجودة وكل ما هو مطلوب
الدلائل الفرعية.

إذا لم يتم تحديده ، سيتم وضع الإخراج في الدليل الحالي.

-محدد الاسم
استخدم اللغة الاسم بدلاً من الإعدادات المحلية الافتراضية لجميع الأغراض.

الاسم يجب أن يكون محدد الإعدادات المحلية في النموذج ll_CC [_VAR] أين ll هو حرف صغير اثنان-
حرف رمز لغة ISO-639 ، CC هو بلد اختياري ISO-3166 من حرفين كبيرتين
كود و VAR هو رمز متغير اختياري. على سبيل المثال، en تحدد اللغة الإنجليزية ، en_US
تحدد اللغة الإنجليزية الأمريكية ، و ar_US_WIN يحدد متغيرًا منحرفًا للغة الإنجليزية الأمريكية
المحلية.

لاحظ أن دلالات هذا الخيار تتوافق تمامًا مع دلالات المنشئين
من صنف java.util.Locale.

يحدد هذا الخيار حاليًا فقط أي Collator يتم استخدامه لفرز الإخراج
عناصر. هذا يعني أن الإعدادات المحلية سيكون لها تأثير فقط عندما تستخدم غير-
أحرف ASCII في المعرفات.

-شريحة محارف
إهمال. تجاوز الترميز المحدد في ملفات XHTML الناتجة مع ذلك المعطى
by محارف.

إذا لم يتم توفير هذا الخيار ، يتم اختيار مواصفات الترميز في الإخراج XHTML
تطابق الترميز المستخدم عند كتابة الملف (الترميز المعطى بـ -التوثيق,
أو الترميز الافتراضي لمنصتك).

دلالات ل محارف محددة هنا:
<http://www.w3.org/TR/2000/REC-xml-20001006# NT- EncName>. لجميع الأغراض العملية ،
إنها متطابقة مع الخيارات الأخرى التي تقبل معلمات مجموعة الأحرف.

هذا الخيار موجود هنا للتوافق مع جافادوك وينبغي تجنبها.

-التوثيق محارف
استخدم ترميز مجموعة الأحرف المحدد عند كتابة ملفات الإخراج بدلاً من نظامك الأساسي
التشفير الافتراضي.

أمثلة على محارف . US-ASCII, ISO-8859-1 or UTF-8.

تتوافق دلالات هذا الخيار تمامًا مع دلالات منشئي الفصل
java.util.Locale.

-validhtml
فرض إنشاء كود XHTML صالح. هذا يكسر التوافق مع التقليدية
أداة جافادوك إلى حد ما.

إذا تم تحديد هذا الخيار ، فسيتم تشويه أسماء الارتساء بحيث تكون صالحة
وفقًا لمواصفات XHTML 1.1. ومع ذلك ، تم إنشاء مجموعة وثائق مع
لا يمكن ربط هذا الخيار بالاستخدام الصحيح لأداة Javadoc التقليدية. يمكن
أن تكون مرتبطة على ما يرام باستخدام Gjdoc ، على الرغم من ذلك.

بدون هذا الخيار ، تستخدم أسماء الارتساء لأعضاء الفصل القابل للتنفيذ اسم الملف التقليدي
التنسيق ، على سبيل المثال: "foo (String، int [])". هذا متوافق مع التقليدي
أداة Javadoc ، ولكن وفقًا لمواصفات HTML 4.0 و XHTML 1.0 و 1.1 ،
يتضمن هذا التنسيق أحرفًا غير قانونية. الأقواس والأقواس المربعة والفاصلة
غير مسموح بها في أسماء الارتساء.

-باسيرل URL
Hardwire عنوان URL لصفحة متعلق بـ URL في كل صفحة تم إنشاؤها.

إذا كنت تقوم بإنشاء وثائق ستكون متاحة حصريًا في وقت معين
URL ، يجب عليك استخدام هذا الخيار لتحديد عنوان URL هذا.

يمكن أن يساعد ذلك في تجنب بعض هجمات إعادة التوجيه التي يستخدمها مرسلو البريد العشوائي ، ويمكن أن يكون مفيدًا
لبعض عملاء الويب.

الإسهاب مزيد من الخيارات

-هادئ
قم بإيقاف كل الإخراج باستثناء التحذيرات ورسائل الخطأ.

-إفراط
كن واسعا جدا بشأن ماذا com.gjdoc يقوم به.

هذا الخيار تم تجاهله حاليا.

افتراضي تشمل مزيد من الخيارات

الشمس جافادوك يبدو أن الأداة تعتمد على جافاك وعلى هذا النحو يبدو أنه يعمل على VM
. com.gjdoc، في المقابل ، هو تطبيق Java خالص.

ولذلك، com.gjdoc يمكن فقط تزييف أو محاكاة الخيارات التالية على مستوى VM.

- كلاسباث قائمة المسار
اضبط الجهاز الظاهري com.classpath إلى قائمة المسار.

في معظم الحالات يجب عليك استخدام -docletpath or -المسار بدلا من هذا الخيار.

قائمة المسار يجب أن يكون مسارًا واحدًا أو أكثر إلى دليل أو ملف جرة ، مفصولاً بامتداد
فاصل مسار النظام الأساسي (عادةً : or ;).

إذا لم يتم اعتراض هذا الخيار على مستوى الغلاف ، com.gjdoc تزيفها حاليًا
دعوة System.setProperty ("java.class.path"، قائمة المسار); ويخرج تحذيرًا.

-bootclasspath قائمة المسار
اضبط الجهاز الظاهري com.bootclasspath إلى قائمة المسار.

إذا لم يتم اعتراض هذا الخيار على مستوى الغلاف ، com.gjdoc يخرج تحذير.

-Jvmopt
قم بتمرير معلمة عشوائية إلى الجهاز الظاهري com.gjdoc يعمل على.

إذا لم يتم اعتراض هذا الخيار على مستوى الغلاف ، com.gjdoc يحاول محاكاة
خيار ومخرجات تحذير.

حاليا ، فقط خيار VM -D لضبط خصائص النظام.

استخدم gjdoc-4.8 عبر الإنترنت باستخدام خدمات onworks.net