gjdoc-4.8 - آنلاین در ابر

برنامه:

نام

cp-tools - راهنمای ابزارهای مسیر کلاس گنو

خلاصه

gjdoc [-مسیر منبع لیست مسیر]
[-همه] [-بسته های فرعی pkg:pkg:...] [حذف کردن pkglist]
[-رمزگذاری کاراکتر] [-محلی نام] [منبع آزاد]
[-عمومی] [-حفاظت شده] [بسته بندی] [-خصوصی]
[-عالی متن] [-سرتیتر متن] [پاورقی متن] [پایین متن]
[-ارتباط دادن آدرس] [-لینک آفلاین آدرس مسیر] [-غیر واجد شرایط pkg:pkg:...]
[-tagletpath لیست مسیر] [-تگ نام کلاس] [-تگ برچسب]
[-استفاده کنید] [منبع پیوند] [- splitindex] [-noindex] [نوتره]
[-version] [-نویسنده] [-بیهوده] [-addstylesheet پرونده]
[-d targetdir]
[بسته...] [فایل های منبع...] [@cmdfile]

gjdoc [-مسیر منبع لیست مسیر]
[-همه] [-بسته های فرعی pkg:pkg:...] [حذف کردن pkglist]
[-رمزگذاری کاراکتر] [-محلی نام] [منبع آزاد]
[-عمومی] [-حفاظت شده] [بسته بندی] [-خصوصی]
[-docletpath لیست مسیر] [-دکلت نام کلاس]
[بسته...] [فایل های منبع...] [@cmdfile]
[گزینه های doclet]

gjdoc --کمک

gjdoc - نسخه

فقط مفیدترین گزینه ها در اینجا فهرست شده اند. برای بقیه موارد زیر را ببینید.

شرح

Gjdoc می تواند به دو صورت استفاده شود: به عنوان یک ابزار مستندسازی مستقل، یا به عنوان یک راننده برای a
Doclet مشخص شده توسط کاربر.

در حالت پیش فرض، Gjdoc از استاندارد Doclet استفاده می کند HtmlDoclet برای تولید مجموعه ای از
صفحات HTML کاربرد متعارف عبارت است از:

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

در اینجا، src/java/ ریشه سلسله مراتب کلاس کد منبع شما است، -همه به این معنی که همه معتبر است
فایل‌های جاوا که در این فهرست ریشه یافت می‌شوند باید پردازش شوند و api-docs/ هست
دایرکتوری که باید اسناد تولید شده در آن قرار گیرد.

برای کسب اطلاعات بیشتر در مورد اجرای Doclet غیر از استاندارد Doclet، به دفترچه راهنما مراجعه کنید.

OPTIONS

گزینه خلاصه by نوع

در اینجا خلاصه ای از تمام گزینه های Gjdoc و Standard Doclet، گروه بندی شده بر اساس است
نوع توضیحات در بخش های زیر آمده است.

منبع تنظیم گزینه
-مسیر منبع لیست مسیر -بسته های فرعی pkglist حذف کردن pkglist

منبع قالب گزینه
منبع آزاد -رمزگذاری پشتیبانی می کند -شکن

بهم پیوند دادن گزینه
-ارتباط دادن آدرس -لینک آفلاین آدرس پرونده -غیر واجد شرایط pkg:pkg:...

نسل گزینه
-نویسنده -متن مجوز -استفاده کنید -version - splitindex -noindex
- nodeprecated -nodeprecatedlist -نه کمک -nonnavbar
-بیهوده نوتره -عمومی -حفاظت شده بسته بندی -خصوصی
-docfilessubdirs -excludedocfilessubdir عنوان
منبع پیوند

تولید گزینه
-d -محلی نام - مجموعه حروف کاراکتر کدگذاری کاراکتر
-validhtml -baseurl آدرس

تزیین گزینه
عنوان پنجره متن -عالی متن -عنوان متن
-سرتیتر متن پاورقی متن پایین متن
فایل کمکی پرونده -stylesheetfile پرونده -addstylesheet پرونده
گروه سرگروهی pkgpattern:pkgpattern:...

Taglet گزینه
-tagletpath -تگ نام کلاس -تگ برچسب

دکتر گزینه
-docletpath -دکلت نام کلاس

اصطلاح گزینه
-ساکت کلاهبرداری

مجازی دستگاه گزینه
-مسیر کلاسی -bootclasspath -J vmopt

انتخاب که منبع فایل ها به روند

-s لیست مسیر
-مسیر منبع لیست مسیر
به دنبال فایل های منبع در دایرکتوری یا دایرکتوری های مشخص شده بگردید.

لیست مسیر باید یک یا چند مسیر دایرکتوری باشد که توسط مسیر پلتفرم شما از هم جدا شده است
جداکننده (معمولا : or ;).

اگر این گزینه داده نشد، gjdoc فایل های منبع را در جریان فعلی جستجو می کند
دایرکتوری.

دایرکتوری های مشخص شده باید از نظر بسته جاوا دایرکتوری های ریشه باشند
سیستم. به عنوان مثال، اگر می خواهید اسنادی را برای کلاس ها در بسته ایجاد کنید
foo.bar، باید دایرکتوری حاوی سطح بالا را مشخص کنید فو دایرکتوری فرعی،
نه دایرکتوری غذا/بار/ که فایل های منبع جاوا در آن قرار دارند.

نام مستعار دست کوتاه -s خاص است gjdoc و با Sun سازگار نیست javadoc.

-همه
[تجربی] تمام فایل های منبع جاوا معتبر موجود در فهرست های فهرست شده را پردازش کنید
مسیر منبع و زیرشاخه های آنها.

این یک گزینه خاص است gjdoc و با Sun سازگار نیست javadoc.

-بسته های فرعی pkg:pkg:...
کلاس‌های بسته‌های جاوا و همه بسته‌های فرعی را به صورت بازگشتی پردازش کنید.
توجه داشته باشید که نام چند بسته باید با دونقطه به جای فضای خالی از هم جدا شوند.

حذف کردن pkg:pkg:...
کلاس ها را در بسته های جاوا و همه بسته های فرعی به صورت بازگشتی پردازش نکنید.
این گزینه را می توان همراه با -همه or -بسته های فرعی به منظور حذف
بسته های فردی یا درخت های فرعی بسته از خروجی.

بسته...
تمام کلاس ها را در بسته های جاوای داده شده پردازش کنید.

فایل های منبع...
کلاس ها را در فایل های منبع جاوا پردازش کنید.

تعیین la قالب of ورودی فایل ها

منبع آزاد
فرض کنید که فایل های منبع در نسخه مشخص شده از پلت فرم جاوا هدف قرار می گیرند.

آزاد باید شماره نسخه انتشار پلتفرم جاوا در قالب باشد
برای مثال MAJOR.MINOR 1.4.

این گزینه در حال حاضر نادیده گرفته شده است، به جز اینکه در صورت شماره انتشار، خطایی ایجاد می شود
به غیر از 1.2, 1.3 or 1.4 مشخص شده است.

-رمزگذاری کاراکتر
فرض کنید فایل های منبع با استفاده از کدگذاری می شوند کاراکتر.

نمونه هایی برای کاراکتر هستند US-ASCII, ISO-8859-1 or UTF-8.

معناشناسی از کاراکتر مشابه هستند
java.nio.charset.charset.forName(string).

-شکن
به جای جمله اول داخلی از java.text.BreakIterator محلی استفاده کنید
ردیاب

به طور پیش فرض، gjdoc از یک الگوریتم داخلی برای تعیین پایان یک جمله استفاده می کند. چه زمانی
این گزینه داده شده است، در عوض از آن استفاده خواهد کرد java.text.BreakIterator به عنوان مثال برای
محلی داده شده با -محلی (یا محلی پیش فرض).

این گزینه باید در هنگام درخواست مشخص شود gjdoc به کد منبع نظر داده شده در یک غیر
زبان لاتین که آشکارساز جمله اول پیش فرض برای آن کار نمی کند. برای همه
در موارد دیگر، پیش‌فرض (از BreakIterator استفاده نکنید) نتایج بهتری را ایجاد می‌کند
زمان این نگارش

بهم پیوند دادن با دیگر مستندات مجموعه

-ارتباط دادن آدرس
به مجموعه اسناد دیگری پیوند ایجاد کنید.

به طور پیش فرض، gjdoc فقط به کلاس های مجموعه منبع پیوند ایجاد می کند. از این استفاده کن
گزینه ای برای ایجاد پیوندهای اضافی به کلاس های تحت پوشش مشخص شده
مجموعه مستندات

آدرس باید URL اصلی مجموعه اسناد دیگر باشد. مثلا برای اضافه کردن
هایپرلینک به GNU Classpath، موارد زیر را مشخص کنید:

-ارتباط دادن http://developer.classpath.org/doc/

La -ارتباط دادن گزینه را می توان چندین بار مشخص کرد.

توجه داشته باشید که مشخص کردن -ارتباط دادن هر بار که gjdoc باشد، گزینه باعث دسترسی HTTP می شود
احضار شد. شما می توانید استفاده کنید -لینک آفلاین در عوض برای جلوگیری از این دسترسی.

-لینک آفلاین آدرس پرونده
به مجموعه اسناد دیگری که در فایل محلی نیز وجود دارد، هایپرلینک ایجاد کنید
سیستم.

این گزینه دقیقاً مانند کار می کند -ارتباط دادن، با این تفاوت که به سیستم فایل محلی دسترسی دارد
به جای شبکه برای تعیین اینکه کدام کلاس ها توسط پیوند داده شده پوشش داده می شوند
مجموعه مستندات

هنگام استفاده از -لینک آفلاین مجموعه اسناد از راه دور اصلا قابل دسترسی نیست، که می تواند
به طور قابل توجهی سرعت تولید را بسته به اتصال شبکه شما افزایش می دهد. در
پیوندهای ایجاد شده به مجموعه مستندات، با این حال به مجموعه راه دور اشاره دارد، نه به
محلی، به طوری که شما می توانید اسناد را بدون هیچ چیز دیگری توزیع کنید
وابستگی ها

La -لینک آفلاین گزینه را می توان چندین بار مشخص کرد.

-غیر واجد شرایط pkg:pkg:...
نام کلاس ها را در بسته های داده شده با نام بسته آنها واجد شرایط نکنید.

به‌طور پیش‌فرض، نام کلاس تنها در صورتی بدون شرایط نمایش داده می‌شود که کلاس بخشی از کلاس باشد
مجموعه منبع یا مجموعه اسناد پیوندی، و با نام آن واجد شرایط است
حاوی بسته اگر نباشد. می‌توانید از این گزینه برای اجبار نام‌های غیرمجاز استفاده کنید
برای کلاس ها حتی اگر بخشی از مجموعه مستندات نباشند.

به عنوان مثال، معمولاً یک مرجع به کلاس String کاملاً واجد شرایط به عنوان نشان داده می شود
java.lang.string (مگر اینکه با استفاده از مجموعه اسناد مناسب پیوند دهید -ارتباط دادن)
زیرا بخشی از مجموعه مستندات نیست. می توانید مشخص کنید -غیر واجد شرایط
java.lang برای ارائه همان مراجع درست به عنوان رشته.

توجه داشته باشید که برای همه نام‌های کلاس غیرمجاز، هنگام قرار دادن خود، یک راهنمای ابزار ارائه می‌شود
نشانگر ماوس روی آن در اسناد HTML.

-غیر واجد شرایط تمام
از همه نام‌های کلاس‌ها، واجد شرایط نام بسته را حذف کنید.

برای حذف کامل واجد شرایط نام بسته، این گزینه را مشخص کنید.

انتخاب که اطلاعات به تولید

-عمومی
فقط اعضای عمومی کلاس های عمومی را در خروجی قرار دهید. به طور پیش فرض، محافظت شده است
اعضای کلاس نیز شامل می شوند.

-حفاظت شده
اعضای عمومی یا محافظت شده کلاس های عمومی را در خروجی قرار دهید. این است
به طور پیش فرض

بسته بندی
شامل اعضای عمومی، محافظت شده و بسته-خصوصی عمومی و بسته-خصوصی باشد
کلاس.

-خصوصی
همه کلاس ها و اعضای کلاس را بدون در نظر گرفتن سطح دسترسی آنها شامل شود.

- splitindex
به جای یک صفحه فهرست یکپارچه، یک صفحه فهرست در هر حرف ایجاد کنید.

به طور پیش فرض، نمایه ایجاد شده توسط استاندارد Doclet شامل همه ورودی ها در یک واحد است
صفحه این برای مجموعه های اسناد کوچک خوب است، اما برای مجموعه های بزرگ باید این کار را انجام دهید
این گزینه را مشخص کنید.

-بیهوده
نادیده گرفتن @از آنجا که برچسب ها در نظرات جاوادوک

به طور پیش فرض، خروجی تولید شده شامل بخش هایی است که نسخه API شما را فهرست می کند
از آنجایی که بسته، کلاس یا عضو کلاس مورد نظر در زمانی که این تگ وجود دارد وجود دارد
مواجه شده. برای حذف این اطلاعات این گزینه را مشخص کنید.

نوتره
هیچ صفحه درختی ایجاد نکنید.

به طور پیش فرض، خروجی تولید شده شامل یک درخت وراثت در هر بسته و - if است
مجموعه مستندات شامل چندین بسته است - یک صفحه با ارث کامل
درخت برای حذف تولید این صفحات، این گزینه را مشخص کنید.

-noindex
نمایه حروف الفبا را خروجی نکنید.

به طور پیش‌فرض، gjdoc یک فهرست الفبایی از تمام عناصر برنامه در برنامه ایجاد می‌کند
مجموعه مستندات (بسته ها، کلاس ها، کلاس های داخلی، سازنده ها، روش ها و
زمینه های). برای حذف این اطلاعات این گزینه را مشخص کنید.

-نه کمک
صفحه راهنما را ایجاد نکنید.

این گزینه در حال حاضر نادیده گرفته شده است زیرا استاندارد Doclet صفحه راهنما ارائه نمی دهد.

- nodeprecated
اطلاعات درون خطی بسته‌ها، کلاس‌ها یا اعضای کلاس منسوخ را خروجی نگیرید.

به‌طور پیش‌فرض، استاندارد Doclet یک پاراگراف برجسته شده با منسوخ شدن اضافه می‌کند
اطلاعات مربوط به توضیحات هر عنصر برنامه منسوخ شده. این را مشخص کنید
گزینه حذف این اطلاعات

-nodeprecatedlist
از صفحه خلاصه برای عناصر API منسوخ شده خروجی نگیرید.

به طور پیش فرض، استاندارد Doclet صفحه ای ایجاد می کند که تمام عناصر API منسوخ شده را فهرست می کند
همراه با شرح انحلال که معمولاً دلیل انحلال را در بر می گیرد
و جایگزین های احتمالی برای حذف این اطلاعات این گزینه را مشخص کنید.

-nonnavbar
نوار پیمایش، سرصفحه و پاورقی را خروجی ندهید.

به‌طور پیش‌فرض، هر صفحه خروجی مجهز به نوار پیمایش بالایی است (که ممکن است شامل
یک هدر مشخص شده توسط کاربر) و یک نوار پیمایش پایین (که ممکن است شامل یک کاربر باشد
پاورقی مشخص شده). این گزینه را برای حذف این دکوراسیون مشخص کنید.

-بدون شرح
تمام متن مستندات را از فایل های تولید شده حذف کنید و فقط اعلان ها را خروجی بگیرید
روابط عناصر برنامه

این گزینه برای سازگاری با javadoc. اگر قصد استخراج دارید
اطلاعات مربوط به پروژه شما از طریق gjdoc، باید از Doclet دیگری استفاده کنید
در عوض برای اهداف شما، به عنوان مثال XmlDoclet. همچنین می توانید از Doclet API استفاده کنید
به طور مستقیم با اجرای یک Doclet جدید.

منبع پیوند
برای هر کلاس صفحه ای با کد منبع برجسته شده با نحو ایجاد کنید. به طور پیش فرض، این
صفحه ایجاد نمی شود

کد منبع را می توان با کلیک کردن بر روی دکمه با عنوان "منبع" در دسترسی پیدا کرد
نوار پیمایش یا با کلیک بر روی نام سازنده، فیلد، روش یا درونی
کلاس در بخش جزئیات یک صفحه مستندات کلاس.

-استفاده کنید
صفحه ای با اطلاعات ارجاع متقابل ایجاد کنید. به طور پیش فرض، این صفحه نیست
تولید شده

با کلیک بر روی دکمه برچسب گذاری شده می توان به اطلاعات ارجاع متقابل دسترسی پیدا کرد
«استفاده» در نوار پیمایش.

صفحه «استفاده» همه کلاس‌ها/اینترفیس‌ها را در مجموعه مستندات فهرست می‌کند
گسترش/اجرای کلاس (نوع) مورد نظر؛ فیلدهای نوع؛ روش ها یا
سازنده هایی که یک پارامتر از نوع را می پذیرند. روش های برگرداندن نوع؛ و
روش ها یا سازنده هایی که نوع را پرتاب می کنند.

-نویسنده
اطلاعات نویسنده را در خروجی قرار دهید.

وقتی مشخص شد، اطلاعات نویسنده همانطور که با استفاده از @نویسنده تگ در جاوادوک
نظرات در خروجی گنجانده شده است. به صورت پیش فرض، @نویسنده برچسب ها نادیده گرفته می شوند

-version
اطلاعات نسخه را در خروجی قرار دهید.

وقتی مشخص شد، اطلاعات نسخه همانطور که با استفاده از مشخص شده است @نسخه تگ در جاوادوک
نظرات در خروجی گنجانده شده است. به صورت پیش فرض، @نسخه برچسب ها نادیده گرفته می شوند

-متن مجوز
فرض کنید اولین نظر در هر فایل منبع حاوی متن مجوز است و اضافه کنید
اطلاعات مجوز به پاورقی هر صفحه کلاس تولید شده.

این یک گزینه خاص است gjdoc و با Sun سازگار نیست javadoc.

این گزینه برای استفاده با پروژه های رایگان و منبع باز در نظر گرفته شده است که دارای کد منبع هستند
در صورت وجود دلایل قانونی، معمولاً با یک نظر مجوز دیگ بخار پیشوند می شود
برای گنجاندن مجوز در اسناد.

-docfilessubdirs
به صورت بازگشتی همه فایل‌ها را کپی کنید فایل های doc دایرکتوری فرعی هر دایرکتوری بسته.

معمولا فقط فایل های موجود در فایل های doc دایرکتوری فرعی بدون نزول کپی می شود
بازگشتی

-excludedocfilessubdir نام:نام: ...
برخی از دایرکتوری ها را مستقیماً در زیر کپی نکنید فایل های doc دایرکتوری های فرعی وقتی
نزولی بازگشتی

آرگومان این گزینه باید لیستی از نام دایرکتوری های جدا شده با دو نقطه باشد.

این گزینه فقط در صورتی منطقی است که -docfilessubdirs نیز مشخص شده است. در این مورد، هر
دایرکتوری فرعی که مستقیماً در زیر a فایل های doc دایرکتوری در صورت لیست حذف می شود.

سفارشی مستندات گزينه ها

-tagletpath لیست مسیر
جستجو لیست مسیر هنگام بارگیری کلاس های Taglet بعدی مشخص شده با استفاده از -تگ.

لیست مسیر باید یک یا چند مسیر به یک فهرست یا فایل jar باشد که با شما از هم جدا شده باشد
جداکننده مسیر پلت فرم (معمولا : or ;).

-تگ نام کلاس
ثبت یک Taglet

نام کلاس باید نام کاملاً واجد شرایط اجرای کلاس جاوا باشد
com.sun.tools.doclets.Taglet.

کلاس های Taglet از مسیر کلاسی که با استفاده از آن مشخص شده است بارگذاری می شوند -tagletpath، از
مسیر کلاس مشخص شده با استفاده از -مسیر کلاسی و از مسیر کلاس پیش فرض.

مستندات را ببینید com.sun.tools.doclets.Taglet برای اطلاعات بیشتر.

توجه داشته باشید که برای برچسب های ساده نیز وجود دارد -تگ.

-تگ برچسب
یک Taglet عمومی ثبت کنید.

قالب برچسب باید : :" ".

نام برچسب نام برچسبی است که باید مطابقت داشته باشد، بدون علامت @ پیشرو.

پرچم ها یک یا چند کاراکتر از کاراکترهای زیر است که هر کاراکتر a را مشخص می کند
زمینه کد منبع که در آن برچسب باید شناسایی شود.

a همه زمینه ها

c سازندگان

f زمینه

m روش

o مروری

p بسته

t انواع (کلاس ها، رابط ها، استثناها، خطاها)

X کاراکتر ویژه که به طور موقت Taglet را به طور کلی غیرفعال می کند.

سربرگ رشته ای است که در سربرگ بخش اختصاص داده شده به تگ نمایش داده می شود
درخواست.

به عنوان مثال، برای تعریف تطبیق تگ @cvsid که باید به صورت کلی پذیرفته شود،
بسته و صفحات را تایپ کنید و با هدر برچسب گذاری شده است CVS ID، شما می خواهید
مشخص كردن:

-تگ cvsid:tpo:"CVS ID"

بیایید بگوییم که یک نظر javadoc کلاس شامل

@cvsid $Id: cp-tools.texinfo,v 1.9 2012/03/07 15:27:27 gnu_andrew Expand $

سپس خروجی HTML حاوی چیزی شبیه به این خواهد بود

شناسه CVS:
$ID: cp-tools.texinfo,v 1.9 2012/03/07 15:27:27 gnu_andrew Exp $

محل دویدن و پیاده روی دیگر Doclets

-docletpath لیست مسیر
جستجو لیست مسیر هنگام بارگیری کلاس ها برای Doclet مشخص شده با استفاده از -دکلت.

لیست مسیر باید یک یا چند مسیر به یک فهرست یا فایل jar باشد که با شما از هم جدا شده باشد
جداکننده مسیر پلت فرم (معمولا : or ;).

-دکلت نام کلاس
به جای HtmlDoclet استاندارد، doclet مشخص شده را اجرا کنید.

نام کلاس باید نام کاملاً واجد شرایط کلاسی باشد که پیش‌فرض عمومی دارد
سازنده و حاوی متدی با امضای زیر است:

وارد کردن com.sun.javadoc.RootDoc;
شروع بولین استاتیک عمومی (RootDoc ​​rootDoc)

کلاس های Doclet از مسیر کلاسی که با استفاده از آن مشخص شده است بارگذاری می شوند -docletpath، از
مسیر کلاس مشخص شده با استفاده از -مسیر کلاسی و از مسیر کلاس پیش فرض.

La شروع روش باید اطلاعات افشا شده توسط Doclet API را از طریق پردازش کند rootDoc
و برگشت درست در مورد موفقیت، غلط در مورد شکست

اگر از یک سند شخص ثالث استفاده می کنید، برای اطلاعات بیشتر به مستندات آن مراجعه کنید
دستورالعمل ها. توجه داشته باشید که پشتیبانی از اسناد شخص ثالث آزمایشی است. لطفا
هر گونه مشکلی را که با آن روبرو می شوید گزارش دهید یا در هنگام اجرای موفقیت آمیز بازخورد ارائه دهید
اپلت های شخص ثالث

این گزینه را می توان چندین بار مشخص کرد که در این صورت تمام doclet ها اجرا می شوند
با همان درخت اطلاعاتی که از طریق Doclet API برای هر اجرای Doclet در معرض دید قرار می گیرد.

اضافه کردن اطلاعات به la تولید

عنوان پنجره متن
استفاده کنید متن به عنوان پیشوند عنوان پنجره مرورگر.

وقتی مشخص شد، عنوان پنجره مرورگر برای هر صفحه با پیشوند اضافه می شود متن
به جای رشته پیش فرض تولید API مستندات.

متن باید متن ساده باشد (نباید حاوی برچسب های HTML باشد).

-عالی متن
متن سرصفحه صفحه نمای کلی را روی آن تنظیم کنید متن.

متن باید یک رشته متن ساده کوتاه باشد.

هنگام تولید اسناد برای یک بسته واحد، مشخص کردن این گزینه نیرو می گیرد
تولید صفحه نمای کلی

-سرتیتر متن html
اضافه کردن متن html در گوشه سمت راست بالای هر صفحه ایجاد شده. متن html معمولا
روی نام پروژه در حال مستندسازی تنظیم کنید.

پاورقی متن html
اضافه کردن متن html در گوشه پایین سمت راست هر صفحه ایجاد شده. متن html اغلب است
به همان مقدار برای تنظیم کنید -سرتیتر.

پایین متن html
اضافه کردن متن html تا انتهای هر صفحه ایجاد شده، که تمام عرض آن را در بر می گیرد
صفحه. وقتی مشخص شد، متن html معمولاً شامل یک اعلامیه حق چاپ و/یا است
پیوند به صفحات دیگر پروژه

-addstylesheet پرونده
شیوه نامه های پیش فرض CSS را با شیوه نامه مشخص شده توسط کاربر تقویت کنید پرونده.

شیوه نامه داده شده به سادگی توسط هر صفحه HTML علاوه بر حالت پیش فرض بارگذاری می شود
آنهایی که به عنوان آخرین شیوه نامه.

توجه داشته باشید که قوانین آبشاری CSS اعمال می شود. یعنی ویژگی های سبک شما فقط خواهد بود
در صورتی که ترتیب آبشاری بالاتری داشته باشند، اختصاص داده می شود gjdocسبک پیش فرض یکی ساده
راه برای اطمینان از اینکه این مورد است این است که override های خود را اعلام کنید !مهم.

دیدنhttp://www.w3.org/TR/REC-CSS2/cascade.html#ترتیب آبشاری>.

گروه عنوان pkgwildcard:pkgwildcard: ...
بسته های داده شده را در یک گروه جداگانه در صفحه نمای کلی بچینید.

آرگومان اول باید یک متن ساده کوتاه باشد که به عنوان عنوان استفاده می شود
گروه بسته آرگومان دوم باید لیستی از بسته جدا شده با کولون باشد
حروف عام این گروه شامل تمام بسته‌های موجود در مجموعه مستندات است که نام آنها وجود دارد
با هر یک از حروف عام داده شده مطابقت دارد.

فقط یک کاراکتر عام وجود دارد، *، که با هر دو حرف در نام بسته مطابقت دارد
اجزا و . جداسازی اجزای نام بسته مثلا، j*regex خواهد بود
بسته کبریت java.util.regex. یک مثال مفیدتر می تواند باشد javax.swing* برای مطابقت با
javax.swing و تمامی بسته های فرعی آن

این گزینه را می توان چندین بار داد.

FIXME: اطلاعاتی در مورد تودرتوی گروهی در اینجا.

gjdoc -گروه "کلاسهای اصلی" 'java*' \
-گروه "Swing" 'javax.swing*' \
-گروه "XML APIs" 'javax.xml*' \
-گروه "افزونه های دیگر" javax* \
...

-بررسی اجمالی پرونده
قطعه بدنه XHTML را اضافه کنید پرونده به صفحه نمای کلی

پرونده باید شامل یک قطعه XHTML با HTML باشد بدن به عنوان گره ریشه تگ کنید.

از این گزینه می توان برای ارائه توضیحاتی درباره مجموعه مستندات به عنوان یک کل استفاده کرد.

وقتی مشخص شد، اولین جمله از قطعه در بالای جداول قرار می گیرد
لیست بسته های مستند، همراه با پیوند به کپی کامل قطعه
که در زیر جداول قرار داده شده است.

هنگام تولید اسناد برای یک بسته واحد، مشخص کردن این گزینه نیرو می گیرد
تولید صفحه نمای کلی

-stylesheetfile پرونده
از شیوه نامه CSS در استفاده کنید پرونده به جای شیوه نامه های پیش فرض CSS.

اگر می‌خواهید فقط بخش‌هایی از شیوه نامه‌های پیش‌فرض را لغو کنید، از آن استفاده کنید -addstylesheet
به جای آن.

-عنوان متن
منسوخ. استفاده کنید -عالی متن به جای آن.

فایل کمکی پرونده
این گزینه در حال حاضر نادیده گرفته شده است.

هنگامی که پیاده سازی شد، از قطعه XHTML در آن استفاده می کند پرونده برای محتویات صفحه راهنما
به جای متن راهنما پیش فرض.

کنترل la خروجی

-d فهرست راهنما
همه فایل های خروجی را در آن قرار دهید فهرست راهنما (و زیر دایرکتوری ها). فهرست راهنما ایجاد خواهد شد
اگر وجود نداشته باشد، از جمله تمام دایرکتوری های والد غیر موجود و همه موارد مورد نیاز
دایرکتوری های فرعی

اگر مشخص نشده باشد، خروجی در دایرکتوری فعلی قرار می گیرد.

-محلی نام
از زبان محلی استفاده کنید نام به جای محلی پیش فرض برای همه اهداف.

نام باید یک مشخص کننده محلی در فرم باشد ll_CC[_VAR] جایی که ll حروف کوچک دو است
کد زبان نامه ISO-639، CC یک کشور ISO-3166 با دو حرف بزرگ اختیاری است
کد، و VAR یک کد نوع اختیاری است. مثلا، en انگلیسی را مشخص می کند، En_US نوع
انگلیسی ایالات متحده را مشخص می کند و en_US_WIN یک نوع انحرافی از انگلیسی ایالات متحده را مشخص می کند
محلی است.

توجه داشته باشید که معنای این گزینه دقیقاً با سازنده ها مطابقت دارد
از کلاس java.util.Locale.

این گزینه در حال حاضر فقط تعیین می کند که کدام جمع کننده برای مرتب سازی خروجی استفاده می شود
عناصر. این به این معنی است که محلی فقط زمانی تأثیر می گذارد که از غیر
کاراکترهای ASCII در شناسه ها.

- مجموعه حروف کاراکتر
منسوخ. رمزگذاری مشخص شده در فایل های XHTML خروجی را با کد داده شده لغو کنید
by کاراکتر.

اگر این گزینه داده نشود، مشخصات رمزگذاری در خروجی XHTML انتخاب می شود
با کدگذاری مورد استفاده در هنگام نوشتن فایل مطابقت داشته باشد (کدگذاری داده شده با کدگذاری,
یا رمزگذاری پیش فرض پلت فرم شما).

معناشناسی برای کاراکتر در اینجا مشخص شده اند:
<http://www.w3.org/TR/2000/REC-xml-20001006#NT-EncName> برای تمام اهداف عملی،
آنها با گزینه های دیگر که پارامترهای مجموعه نویسه را می پذیرند یکسان هستند.

این گزینه برای سازگاری با javadoc و باید اجتناب شود

کدگذاری کاراکتر
هنگام نوشتن فایل های خروجی به جای فایل های پلت فرم خود، از رمزگذاری مجموعه نویسه داده شده استفاده کنید
رمزگذاری پیش فرض

نمونه هایی برای کاراکتر هستند US-ASCII, ISO-8859-1 or UTF-8.

معنای این گزینه دقیقاً با سازنده های کلاس مطابقت دارد
java.util.Locale.

-validhtml
تولید اجباری کد XHTML معتبر. این امر سازگاری را با سنت ها می شکند
ابزار Javadoc تا حدودی.

اگر این گزینه مشخص شده باشد، نام‌های لنگر مخدوش می‌شوند تا معتبر باشند
مطابق با مشخصات XHTML 1.1. با این حال، یک مجموعه مستندات تولید شده با
این گزینه را نمی توان به درستی با استفاده از ابزار سنتی Javadoc پیوند داد. می تواند
با این حال، به خوبی با استفاده از Gjdoc مرتبط شود.

بدون این گزینه، نام های لنگر برای اعضای کلاس اجرایی از حالت سنتی استفاده می کنند
قالب، به عنوان مثال: "foo(String,int[])". این با سنتی سازگار است
ابزار Javadoc، اما مطابق با مشخصات HTML 4.0 و XHTML 1.0 و 1.1،
این قالب شامل شخصیت های غیرقانونی است. پرانتز، پرانتز، و کاما
در نام های لنگر مجاز نیستند.

-baseurl آدرس
یک URL صفحه نسبت به آن را سیم کشی کنید آدرس در هر صفحه تولید شده

اگر در حال تولید اسنادی هستید که به طور انحصاری در یک مکان خاص در دسترس خواهند بود
URL، برای تعیین این URL باید از این گزینه استفاده کنید.

این می تواند به جلوگیری از برخی حملات تغییر مسیر مورد استفاده توسط هرزنامه ها کمک کند و می تواند مفید باشد
برای مشتریان وب خاص

اصطلاح گزینه

-ساکت
تمام خروجی ها به جز هشدارها و پیام های خطا را سرکوب کنید.

کلاهبرداری
در مورد چه چیزی بسیار پرحرف باشید gjdoc انجام می دهد

این گزینه در حال حاضر نادیده گرفته شده است.

مجازی دستگاه گزینه

خورشید javadoc ابزار به نظر می رسد بر اساس جاواک و به این ترتیب به نظر می رسد که روی VM کار می کند
سطح. gjdocدر مقابل، یک برنامه جاوای خالص است.

از این رو، gjdoc فقط می تواند گزینه های سطح VM زیر را جعل یا شبیه سازی کند.

-مسیر کلاسی لیست مسیر
ماشین مجازی را تنظیم کنید مسیر کلاس به لیست مسیر.

در بیشتر موارد باید استفاده کنید -docletpath or -tagletpath به جای این گزینه

لیست مسیر باید یک یا چند مسیر به یک فهرست یا فایل jar باشد که با شما از هم جدا شده باشد
جداکننده مسیر پلت فرم (معمولا : or ;).

اگر این گزینه در سطح بسته بندی متوقف نشد، gjdoc در حال حاضر آن را جعل می کند
فراخوانی System.setProperty("java.class.path", لیست مسیر); و یک اخطار خروجی می دهد.

-bootclasspath لیست مسیر
ماشین مجازی را تنظیم کنید bootclasspath به لیست مسیر.

اگر این گزینه در سطح بسته بندی متوقف نشد، gjdoc یک اخطار خروجی می دهد

-Jvmopt
یک پارامتر دلخواه را به ماشین مجازی منتقل کنید gjdoc اجرا می شود

اگر این گزینه در سطح بسته بندی متوقف نشد، gjdoc سعی در تقلید از
گزینه و خروجی یک هشدار.

در حال حاضر فقط گزینه VM -D برای تنظیم ویژگی های سیستم شبیه سازی شده است.

با استفاده از خدمات onworks.net از gjdoc-4.8 به صورت آنلاین استفاده کنید