gjdoc-4.8 - מקוון בענן

תָכְנִית:

שֵׁם

cp-tools - GNU Classpath Tools Guide

תַקצִיר

gjdoc [-נתיב מקור רשימת הנתיבים]
[-את כל] [-חבילות משנה pkg:pkg:...] [-לא לכלול pkglist]
[-הַצפָּנָה ערכה] [-מקומי שם] [-מָקוֹר לשחרר]
[-פּוּמְבֵּי] [-מוּגָן] [-חֲבִילָה] [-פְּרָטִי]
[-דוקטורט טֶקסט] [-כּוֹתֶרֶת טֶקסט] [-כותרת תחתונה טֶקסט] [-תַחתִית טֶקסט]
[-קישור כתובת אתר] [-linkoffline כתובת אתר נתיב] [-noqualifier pkg:pkg:...]
[-תגלת שביל רשימת הנתיבים] [-תגלט שם בכיתה] [-תָג מפרט תג]
[-להשתמש] [מקור קישור] [-splitindex] [-noindex] [-לא עץ]
[-הפך] [-מְחַבֵּר] [-לא מאז] [-גיליון סגנונות הוסף פילה]
[-d targetdir]
[חבילות...] [קבצי מקור...] [@קובץ cmd]

gjdoc [-נתיב מקור רשימת הנתיבים]
[-את כל] [-חבילות משנה pkg:pkg:...] [-לא לכלול pkglist]
[-הַצפָּנָה ערכה] [-מקומי שם] [-מָקוֹר לשחרר]
[-פּוּמְבֵּי] [-מוּגָן] [-חֲבִילָה] [-פְּרָטִי]
[-docletpath רשימת הנתיבים] [-דוקלט שם בכיתה]
[חבילות...] [קבצי מקור...] [@קובץ cmd]
[אפשרויות doclet]

gjdoc - עזרה

gjdoc --גִרְסָה

רק האפשרויות השימושיות ביותר מפורטות כאן; ראה להלן לגבי השאר.

תיאור

ניתן להשתמש ב-Gjdoc בשתי דרכים: ככלי תיעוד עצמאי, או כמנהל התקן עבור א
Doclet שצוין על ידי המשתמש.

במצב ברירת המחדל, Gjdoc ישתמש ב-Standard Doclet HTMLDoclet כדי ליצור קבוצה של
דפי HTML. השימוש הקנוני הוא:

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

כאן, src/java/ הוא השורש של היררכיית מחלקות קוד המקור שלך, -את כל אומר שהכל תקף
יש לעבד קבצי Java שנמצאים תחת ספריית שורש זו, ו api-docs/ האם ה
ספרייה שבה יש למקם את התיעוד שנוצר.

למידע נוסף על הפעלת דוקלטים שאינם הדוקלטים הסטנדרטיים, עיין במדריך.

אפשרויות

אפשרות <br> סיכום by סוּג

הנה סיכום של כל האפשרויות של Gjdoc וגם של Standard Doclet, מקובצים לפי
סוּג. הסברים נמצאים בסעיפים הבאים.

מָקוֹר לקבוע אפשרויות
-נתיב מקור רשימת הנתיבים -חבילות משנה pkglist -לא לכלול pkglist

מָקוֹר פוּרמָט אפשרויות
-מָקוֹר לשחרר -הַצפָּנָה הַצפָּנָה -שבירור

קישורים הדדיים אפשרויות
-קישור כתובת אתר -linkoffline כתובת אתר פילה -noqualifier pkg:pkg:...

דור אפשרויות
-מְחַבֵּר -טקסט רישיון -להשתמש -הפך -splitindex -noindex
-הצומת מבוטל -רשימה מבוטלת -אין עזרה -nonavbar
-לא מאז -לא עץ -פּוּמְבֵּי -מוּגָן -חֲבִילָה -פְּרָטִי
-docfilessubdirs -excludedocfilessubdir שם הדירוג
מקור קישור

תְפוּקָה אפשרויות
-d -מקומי שם -תווים ערכה -דוצנקוד ערכה
-validhtml -baseurl כתובת אתר

תפאורה אפשרויות
-כותרת החלון טֶקסט -דוקטורט טֶקסט -כותרת טֶקסט
-כּוֹתֶרֶת טֶקסט -כותרת תחתונה טֶקסט -תַחתִית טֶקסט
-קובץ עזרה פילה -stylesheetfile פילה -גיליון סגנונות הוסף פילה
-קבוצה כותרת קבוצה pkgpattern:pkgpattern:...

Taglet אפשרויות
-תגלת שביל -תגלט שם כיתה -תָג מפרט תג

דוקלט אפשרויות
-docletpath -דוקלט שם כיתה

מֶלֶל אפשרויות
-שֶׁקֶט -שורש

וירטואלי מכונה אפשרויות
-נתיב כיתתי -bootclasspath -J vmopt

בחירה אשר מָקוֹר קבצים ל התַהֲלִיך

-s רשימת הנתיבים
-נתיב מקור רשימת הנתיבים
חפש קבצי מקור בספרייה או בספריות שצוינו.

רשימת הנתיבים צריך להיות נתיב ספרייה אחד או יותר מופרדים על ידי הנתיב של הפלטפורמה שלך
מפריד (בדרך כלל : or ;).

אם אפשרות זו לא ניתנת, gjdoc יחפש קבצי מקור ב-stream
במדריך.

הספריות שצוינו צריכות להיות ספריות שורש מבחינת חבילת Java
מערכת. לדוגמה, אם אתה רוצה ליצור תיעוד עבור שיעורים בחבילה
פו בר, עליך לציין את הספרייה המכילה את הרמה העליונה Foo ספריית משנה,
לא הספריה פו בר/ שבו נמצאים קובצי המקור של Java.

הכינוי הקצר -s הוא ספציפי ל gjdoc ואינו תואם ל-Sun javadoc.

-את כל
[נִסיוֹנִי] עבד את כל קבצי המקור החוקיים של Java שנמצאו בספריות המפורטות ב
נתיב המקור וספריות המשנה שלהם.

זוהי אפשרות ספציפית ל gjdoc ואינו תואם ל-Sun javadoc.

-חבילות משנה pkg:pkg:...
עבד את המחלקות בחבילות Java הנתונות ואת כל חבילות המשנה, באופן רקורסיבי.
שים לב שיש להפריד בין שמות חבילות מרובים באמצעות נקודתיים במקום רווח לבן.

-לא לכלול pkg:pkg:...
אין לעבד מחלקות בחבילות Java הנתונות ובכל חבילות המשנה, באופן רקורסיבי.
ניתן להשתמש באפשרות זו בשילוב עם -את כל or -חבילות משנה על מנת להחריג
חבילות בודדות או תתי עצי חבילה מהפלט.

חבילות...
עבד את כל המחלקות בחבילות ה-Java הנתונות.

קבצי מקור...
עבד את המחלקות בקובצי המקור של Java הנתונים.

מפרט מה היא פוּרמָט of קֶלֶט קבצים

-מָקוֹר לשחרר
נניח שקובצי המקור מכוונים לגרסה הנתונה של פלטפורמת Java.

לשחרר צריך להיות מספר הגרסה של מהדורת פלטפורמת Java בפורמט
MAJOR.MINOR, למשל 1.4.

כרגע מתעלמים מהאפשרות הזו, פרט לכך שהועלתה שגיאה אם ​​מספר שחרור
אחר מאשר 1.2, 1.3 or 1.4 מוגדר.

-הַצפָּנָה ערכה
נניח שקובצי המקור מקודדים באמצעות ערכה.

דוגמאות ל ערכה יש לו ארה"ב-ASCII, ISO-8859-1 or UTF-8.

הסמנטיקה של ערכה זהים לאלו של
java.nio.charset.Charset.forName(String).

-שבירור
השתמש ב-java.text.BreakIterator של המקום במקום המשפט הראשון הפנימי
גַלַאִי.

כברירת מחדל, gjdoc משתמש באלגוריתם פנימי כדי לקבוע היכן משפט מסתיים. מתי
אפשרות זו ניתנת, היא תשתמש במקום זאת ב- java.text.BreakIterator דוגמה עבור
מקומי נתון עם -מקומי (או אזור ברירת המחדל).

יש לציין אפשרות זו בעת הגשת הבקשה gjdoc לקוד המקור שהגיב ב-non-
שפה לטינית שעבורה גלאי המשפט הראשון לא עובד. לכולם
במקרים אחרים, ברירת המחדל (אל תשתמש ב-BreakIterator) מייצרת תוצאות טובות יותר ב-
זמן הכתיבה הזה.

קישורים הדדיים עם אַחֵר תיעוד סטים

-קישור כתובת אתר
צור היפר-קישורים לקבוצת תיעוד אחרת.

כברירת מחדל, gjdoc תיצור רק היפר-קישורים למחלקות בערכת המקור. השתמש בזה
אפשרות ליצור בנוסף היפר-קישורים לשיעורים המכוסים על ידי המפורט
ערכת תיעוד.

כתובת אתר צריכה להיות כתובת הבסיס של ערכת התיעוד האחרת. למשל, להוסיף
היפר-קישורים ל-GNU Classpath, ציין את הדברים הבאים:

-קישור http://developer.classpath.org/doc/

אל האני -קישור ניתן לציין את האפשרות מספר פעמים.

שים לב שציינת ה -קישור האפשרות תגרום לגישה ל-HTTP בכל פעם ש- gjdoc
מופעל. אתה יכול להשתמש -linkoffline במקום זאת כדי להימנע מגישה זו.

-linkoffline כתובת אתר פילה
צור היפר-קישורים לקבוצת תיעוד אחרת הקיימת גם בקובץ המקומי
מערכת.

אפשרות זו פועלת בדיוק כמו -קישור, אלא שהוא ניגש למערכת הקבצים המקומית
במקום הרשת כדי לקבוע אילו מחלקות מכוסות על ידי המקושרים
ערכת תיעוד.

כשמשתמש -linkoffline לערכת התיעוד המרוחק אין גישה כלל, מה שכן
להאיץ משמעותית את זמן היצירה בהתאם לחיבור הרשת שלך. ה
היפר-קישורים שנוצרו לערכת התיעוד, אולם מתייחסים לסט המרוחק, לא למערכת
המקומי, כך שתוכל להפיץ את התיעוד ללא כל המשך
תלות.

אל האני -linkoffline ניתן לציין את האפשרות מספר פעמים.

-noqualifier pkg:pkg:...
אין להגדיר שמות של כיתות בחבילות הנתונות עם שם החבילה שלהם.

כברירת מחדל, שם מחלקה מוצג ללא כשיר רק אם המחלקה היא חלק מה-
ערכת מקור או ערכת תיעוד מקושרת, ומתאימה עם השם שלה
מכיל חבילה אם לא. אתה יכול להשתמש באפשרות זו כדי לאלץ שמות לא מתאימים
לשיעורים גם אם הם אינם חלק ממערך התיעוד.

לדוגמה, בדרך כלל הפניה למחלקה String מיוצגת כשירה מלאה כ
מיתר (אלא אם כן אתה מקשר לערכת התיעוד המתאימה באמצעות -קישור)
כי זה לא חלק ממערך התיעוד. אתה יכול לציין -noqualifier
java.lang להציג את אותן הפניות בדיוק כמו מחרוזת.

שים לב שלכל שמות המחלקות הבלתי מסויגים, הסבר כלים מסופק כאשר אתה מציב את שלך
מצביע על זה בתיעוד HTML.

-noqualifier את כל
השמט את הסמכה של שם החבילה מכל שמות המחלקות.

ציין אפשרות זו כדי להשמיט לחלוטין את שמות החבילה,

בחירה אשר מֵידָע ל ליצור

-פּוּמְבֵּי
כלול רק חברי ציבור מכיתות ציבוריות בפלט. כברירת מחדל, מוגן
חברי הכיתה נכללים גם כן.

-מוּגָן
כלול בפלט חברים ציבוריים או מוגנים של כיתות ציבוריות. זה
ברירת המחדל.

-חֲבִילָה
כלול חברים ציבוריים, מוגנים וחבילים פרטיים של ציבור וחבילה פרטית
שיעורים.

-פְּרָטִי
כלול את כל הכיתות וחברי הכיתה ללא קשר לרמת הגישה שלהם.

-splitindex
צור עמוד אינדקס אחד לכל אות במקום דף אינדקס יחיד ומונוליטי.

כברירת מחדל, האינדקס שנוצר על ידי ה-Standard Doclet מכיל את כל הערכים ביחיד
עמוד. זה בסדר עבור ערכות תיעוד קטנות, אבל עבור ערכות גדולות אתה צריך
ציין אפשרות זו.

-לא מאז
להתעלם @מאז תגיות בתגובות javadoc.

כברירת מחדל, הפלט שנוצר מכיל קטעים המפרטים את גרסת ה-API שלך
מאז קיים החבילה, המחלקה או חבר הכיתה המדובר כאשר תג זה
נתקל ב. ציין אפשרות זו כדי להשמיט מידע זה.

-לא עץ
אל תיצור דפי עץ.

כברירת מחדל, הפלט שנוצר כולל עץ ירושה אחד לכל חבילה, וכן - אם
ערכת התיעוד מורכבת ממספר חבילות - עמוד עם הירושה המלאה
עֵץ. ציין אפשרות זו כדי להשמיט את היצירה של דפים אלה.

-noindex
אל תוציא את האינדקס האלפביתי.

כברירת מחדל, gjdoc מייצר אינדקס אלפביתי של כל רכיבי התוכנית ב-
ערכת תיעוד (חבילות, מחלקות, מחלקות פנימיות, בנאים, שיטות ועוד
שדות). ציין אפשרות זו כדי להשמיט מידע זה.

-אין עזרה
אל תיצור את דף העזרה.

כרגע מתעלמים מהאפשרות הזו מכיוון שהמסמך הסטנדרטי אינו מספק דף עזרה.

-הצומת מבוטל
אל תוציא מידע מוטבע על חבילות, שיעורים או חברי כיתה שהוצאו משימוש.

כברירת מחדל, ה-Standard Doclet מוסיף פסקה מודגשת עם הוצאה משימוש
מידע לתיאור של כל רכיב תוכנית שהוצא משימוש. ציין זאת
אפשרות להשמיט מידע זה.

-רשימה מבוטלת
אל תוציא את דף הסיכום עבור רכיבי API שהוצאו משימוש.

כברירת מחדל, ה-Standard Doclet יוצר דף המפרט את כל רכיבי ה-API שהוצאו משימוש
יחד עם תיאור הוצאה משימוש הכולל בדרך כלל את הסיבה להוצאה משימוש
וחלופות אפשריות. ציין אפשרות זו כדי להשמיט מידע זה.

-nonavbar
אל תוציא את סרגל הניווט, הכותרת העליונה והתחתונה.

כברירת מחדל, כל דף פלט מצויד בסרגל ניווט עליון (שעשוי לכלול
כותרת שצוינה על ידי משתמש) וסרגל ניווט תחתון (שעשוי לכלול משתמש-
כותרת תחתונה שצוינה). ציין אפשרות זו כדי להשמיט עיטור זה.

-אין תגובה
השמט את כל טקסט התיעוד מהקבצים שנוצרו והוציא רק הצהרות ו
קשרי רכיבי תוכנית.

אפשרות זו כאן עבור תאימות עם javadoc. אם אתה מתכנן לחלץ
מידע על הפרויקט שלך באמצעות gjdoc, כדאי לשקול להשתמש ב-Doclet אחר
למטרות שלך במקום זאת, למשל XmlDoclet. אתה יכול גם להשתמש ב-Doclet API
ישירות על ידי הטמעת מסמך חדש.

מקור קישור
צור דף עם קוד מקור מודגש תחביר עבור כל מחלקה. כברירת מחדל, זה
הדף לא נוצר.

ניתן לגשת לקוד המקור על ידי לחיצה על הכפתור שכותרתו "מקור" ב-
סרגל הניווט, או על ידי לחיצה על שם של בנאי, שדה, שיטה או פנימי
כיתה בחלק הפרטים של דף תיעוד כיתה.

-להשתמש
צור דף עם מידע הצלבה. כברירת מחדל, דף זה אינו
נוצר.

ניתן לגשת למידע ההצלבה על ידי לחיצה על הכפתור המסומן
'השתמש' בסרגל הניווט.

הדף 'שימוש' מפרט את כל המחלקות/הממשקים בערכת התיעוד
להרחיב/ליישם את המחלקה (הסוג) המדוברת; שדות מהסוג; שיטות או
בנאים המקבלים פרמטר מהסוג; שיטות להחזרת הסוג; ו
שיטות או בנאים זורקים את הסוג.

-מְחַבֵּר
כלול מידע מחבר בפלט.

כאשר צוין, מידע המחבר כפי שצוין באמצעות ה- @מְחַבֵּר תג ב-javadoc
הערות משולבות בפלט. כברירת מחדל, @מְחַבֵּר מתעלמים מהתגים.

-הפך
כלול מידע גרסה בפלט.

כאשר צוין, מידע הגרסה כפי שצוין באמצעות ה- @גִרְסָה תג ב-javadoc
הערות משולבות בפלט. כברירת מחדל, @גִרְסָה מתעלמים מהתגים.

-טקסט רישיון
נניח שההערה הראשונה בכל קובץ מקור מכילה את טקסט הרישיון, והוסיפו
פרטי רישיון לכותרת התחתונה של כל דף מחלקה שנוצר.

זוהי אפשרות ספציפית ל gjdoc ואינו תואם ל-Sun javadoc.

אפשרות זו מיועדת לשימוש עם פרויקטים חינמיים וקוד פתוח שבהם קוד מקור
בדרך כלל מופיעה קידומת של הערת רישיון לוחית, כאשר יש סיבות משפטיות
על הכללת הרישיון בתיעוד.

-docfilessubdirs
העתק באופן רקורסיבי את כל הקבצים ב- קבצי doc ספריית משנה של כל ספריית חבילה.

בדרך כלל, רק הקבצים ב- קבצי doc ספריית המשנה מועתקת ללא ירידה
רקורסיבית.

-excludedocfilessubdir שם:שם: ...
אל תעתיק מספר ספריות ישירות מתחת ל- קבצי doc ספריות משנה מתי
יורד באופן רקורסיבי.

הארגומנט לאפשרות זו צריך להיות רשימה מופרדת בנקודתיים של שמות ספריות.

אפשרות זו הגיונית רק אם -docfilessubdirs מצוין גם. במקרה זה, כל
ספריית משנה הממוקמת ישירות מתחת ל-a קבצי doc ספרייה מושמטת אם רשומה.

מותאם אישית תיעוד תגים

-תגלת שביל רשימת הנתיבים
חיפוש רשימת הנתיבים בעת טעינת מחלקות Taglet עוקבות שצוינו באמצעות -תגלט.

רשימת הנתיבים צריך להיות נתיב אחד או יותר לספרייה או לקובץ jar, מופרדים על ידי שלך
מפריד הנתיבים של הפלטפורמה (בדרך כלל : or ;).

-תגלט שם כיתה
רשום Taglet.

שם כיתה צריך להיות השם המלא של מחלקת Java המיישמת
com.sun.tools.doclets.Taglet.

מחלקות ה-Taglet ייטענו מנתיב הכיתה שצוין באמצעות -תגלת שביל, מ
ה-classpath שצוין באמצעות -נתיב כיתתי ומתוך ה-classpath ברירת המחדל.

עיין בתיעוד של com.sun.tools.doclets.Taglet למידע נוסף.

שימו לב שלתגים פשוטים, יש גם -תָג.

-תָג מפרט תג
רשום Taglet גנרי.

הפורמט של מפרט תג חייב להיות : :" ".

תג שם הוא שם התג שיש להתאים, ללא סימן @ המוביל.

דגלים הוא אחד או יותר מהתווים הבאים, כאשר כל תו מציין א
ההקשר של קוד המקור שבו יש לזהות את התג.

a כל ההקשרים

c בנאים

f שדות

m שיטות

o סקירה

p חבילות

t סוגים (מחלקות, ממשקים, חריגים, שגיאות)

X תו מיוחד אשר משבית באופן זמני את ה-Taglet לחלוטין.

ראש תג היא המחרוזת להצגה בכותרת של הקטע המוקדש לתג ב
שְׁאֵלָה.

לדוגמה, כדי להגדיר התאמת תג @cvsid שאמור להתקבל בסקירה כללית,
עמודי חבילה והקלדה ואשר מסומן עם הכותרת CVS IDהיית
לפרט:

-tag cvsid:tpo:"CVS ID"

נניח שהערת javadoc מחלקה מכילה

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

אז פלט HTML יכיל משהו כמו

מזהה קורות חיים:
$Id: cp-tools.texinfo,v 1.9 2012-03-07 15:27:27 gnu_andrew Exp $

ריצה אחר דוקלטים

-docletpath רשימת הנתיבים
חיפוש רשימת הנתיבים בעת טעינת שיעורים עבור ה-Doclet שצוין באמצעות -דוקלט.

רשימת הנתיבים צריך להיות נתיב אחד או יותר לספרייה או לקובץ jar, מופרדים על ידי שלך
מפריד הנתיבים של הפלטפורמה (בדרך כלל : or ;).

-דוקלט שם בכיתה
הפעל את ה-doclet שצוין במקום ה-HtmlDoclet הסטנדרטי.

שם בכיתה צריך להיות השם המלא של מחלקה שיש לה ברירת מחדל ציבורית
בנאי ומכילים שיטה עם החתימה הבאה:

ייבוא ​​com.sun.javadoc.RootDoc;
התחלה בוליאנית סטטית ציבורית (RootDoc ​​rootDoc)

מחלקות Doclet ייטענו מנתיב הכיתה שצוין באמצעות -docletpath, מ
ה-classpath שצוין באמצעות -נתיב כיתתי ומתוך ה-classpath ברירת המחדל.

אל האני התחלה השיטה צריכה לעבד את המידע שנחשף על ידי Doclet API באמצעות rootDoc
ותחזור נָכוֹן על הצלחה, שקר על כישלון.

אם אתה משתמש ב-doclet של צד שלישי, עיין בתיעוד שלו להמשך
הוראות. שים לב שהתמיכה במסמכים של צד שלישי היא ניסיונית. אנא
דווח על כל בעיה שנתקלת בה, או ספק משוב כאשר פועל בהצלחה
יישומונים של צד שלישי.

ניתן לציין אפשרות זו מספר פעמים, ובמקרה זה כל המסמכים מבוצעים
עם אותו עץ מידע שנחשף דרך ה-API של Doclet עבור כל הפעלת Doclet.

מוסיף מֵידָע ל מה היא תְפוּקָה

-כותרת החלון טֶקסט
השתמש טֶקסט בתור קידומת כותרת חלון הדפדפן.

כאשר צוין, כותרת חלון הדפדפן עבור כל עמוד תהיה קידומת טֶקסט
במקום מחרוזת ברירת המחדל מחולל API תיעוד.

טֶקסט צריך להיות טקסט רגיל (הוא לא צריך להכיל תגיות HTML).

-דוקטורט טֶקסט
הגדר את טקסט הכותרת של דף הסקירה ל טֶקסט.

טֶקסט צריכה להיות מחרוזת טקסט רגיל קצרה.

בעת יצירת תיעוד עבור חבילה בודדת, ציון אפשרות זו מאלץ
יצירת דף הסקירה הכללית.

-כּוֹתֶרֶת טקסט html
להוסיף טקסט html לפינה הימנית העליונה של כל עמוד שנוצר. טקסט html הוא בדרך כלל
מוגדר לשם הפרויקט המתועד.

-כותרת תחתונה טקסט html
להוסיף טקסט html לפינה הימנית התחתונה של כל עמוד שנוצר. טקסט html לעיתים קרובות
מוגדר לאותו ערך כמו עבור -כּוֹתֶרֶת.

-תַחתִית טקסט html
להוסיף טקסט html לחלק התחתון של כל עמוד שנוצר, על פני כל הרוחב של
העמוד. כאשר צוין, טקסט html בדרך כלל מורכבת מהודעת זכויות יוצרים ו/או
קישורים לדפי פרויקט אחרים.

-גיליון סגנונות הוסף פילה
הגדל את גיליונות הסגנונות המוגדרים כברירת מחדל של CSS עם גיליון הסגנונות שצוין על ידי המשתמש פילה.

גיליון הסגנונות הנתון פשוט נטען על ידי כל דף HTML בנוסף לברירת המחדל
אלה, בתור גיליון הסגנונות האחרון.

שים לב שחלים כללי ה-CSS מדורגים. כלומר, מאפייני הסגנון שלך יהיו רק
מוקצים אם יש להם סדר מדורג גבוה יותר מאשר gjdocסגנון ברירת המחדל של. אחד פשוט
הדרך לוודא שזה המקרה היא להכריז על הדרישות שלך ! חשוב.

לִרְאוֹתhttp://www.w3.org/TR/REC-CSS2/cascade.html#סדר מדורג>.

-קבוצה כּוֹתֶרֶת pkgwildcard:pkgwildcard: ...
סדר את החבילות הנתונות בקבוצה נפרדת בדף הסקירה הכללית.

הטיעון הראשון צריך להיות טקסט רגיל קצר המשמש ככותרת של
קבוצת חבילות. הארגומנט השני צריך להיות רשימה של חבילות מופרדות בנקודתיים
תווים כלליים. הקבוצה תורכב מכל החבילות בערכת התיעוד ששמה
תואם לכל אחד מהתווים הכלליים הנתונים.

יש רק תו כללי אחד, *, התואם את שתי האותיות בשם החבילה
רכיבים ו . הפרדת רכיבי שם החבילה. לדוגמה, j*רגקס היה
חבילת התאמה java.util.regex. דוגמה שימושית יותר תהיה javax.swing* כדי להתאים
javax.swing וכל חבילות המשנה שלו.

אפשרות זו יכולה להינתן מספר פעמים.

FIXME: מידע על קינון קבוצתי כאן.

gjdoc -group "שיעורי ליבה" 'java*' \
-קבוצה "נדנדה" 'javax.swing*' \
-קבוצה "ממשקי API של XML" 'javax.xml*' \
-קבוצה "הרחבות אחרות" javax* \
...

-סקירה כללית פילה
הוסף את קטע גוף XHTML מ פילה לדף הסקירה הכללית.

פילה צריך להכיל קטע XHTML עם ה-HTML גוּף תג כצומת השורש.

ניתן להשתמש באפשרות זו כדי לספק תיאור של מערך התיעוד בכללותו.

כאשר צוין, המשפט הראשון של הפרגמנט יופיע מעל הטבלאות
פירוט החבילות המתועדות, יחד עם קישור לעותק המלא של הפרגמנט
אשר מונח מתחת לטבלאות.

בעת יצירת תיעוד עבור חבילה בודדת, ציון אפשרות זו מאלץ
יצירת דף הסקירה הכללית.

-stylesheetfile פילה
השתמש בגיליון הסגנונות של CSS ב פילה במקום גיליונות הסגנונות של ברירת המחדל של CSS.

אם ברצונך לעקוף רק חלקים מגיליונות הסגנונות המוגדרים כברירת מחדל, השתמש -גיליון סגנונות הוסף
במקום.

-כותרת טֶקסט
הוצא משימוש. השתמש -דוקטורט טֶקסט במקום.

-קובץ עזרה פילה
אפשרות זו מתעלמת כרגע.

כאשר ייושם, הוא ישתמש בקטע XHTML ב פילה עבור תוכן דף העזרה
במקום טקסט העזרה המוגדר כברירת מחדל.

שליטה מה היא פלט.

-d בספרייה
הכנס את כל קבצי הפלט לתוך בספרייה (ותתי ספריות). בספרייה יווצר
אם זה לא קיים, כולל כל ספריות האב שלא קיימות וכל הנדרש
ספריות משנה.

אם לא צוין, הפלט ימוקם בספרייה הנוכחית.

-מקומי שם
השתמש במיקום שם במקום מקום ברירת המחדל לכל המטרות.

שם צריך להיות מפרט מיקום בטופס ll_CC[_VAR] איפה ll הוא אותיות קטנות של שתיים-
קוד שפה של האות ISO-639, CC היא מדינה אופציונלית של שתי אותיות ISO-3166
קוד, ו VAR הוא קוד גרסה אופציונלי. לדוגמה, en מפרט אנגלית, en_US
מציין אנגלית אמריקאית, ו en_US_WIN מציין גרסה סוטה של ​​האנגלית בארה"ב
אזור.

שימו לב שהסמנטיקה של אפשרות זו מתאימה בדיוק לאלו של הבנאים
של הכיתה java.util.Locale.

אפשרות זו קובעת כרגע רק באיזה Collator נעשה שימוש למיון הפלט
אלמנטים. משמעות הדבר היא שהמקום ישפיע רק כאשר אתה משתמש ללא
תווי ASCII במזהים.

-תווים ערכה
הוצא משימוש. תעקוף את הקידוד שצוין בקובצי XHTML פלט עם זה שניתן
by ערכה.

אם אפשרות זו לא ניתנת, מפרט הקידוד בפלט XHTML נבחר ל
להתאים את הקידוד המשמש בעת כתיבת הקובץ (הקידוד שניתן עם -דוצנקוד,
או ברירת המחדל של קידוד הפלטפורמה שלך).

הסמנטיקה עבור ערכה מצוינים כאן:
<http://www.w3.org/TR/2000/REC-xml-20001006#NT-EncName>. לכל מטרה מעשית,
הם זהים לאלו של האפשרויות האחרות המקבלות פרמטרים של ערכת תווים.

אפשרות זו כאן עבור תאימות עם javadoc וצריך להימנע.

-דוצנקוד ערכה
השתמש בקידוד ערכת התווים הנתון בעת ​​כתיבת קבצי פלט במקום של הפלטפורמה שלך
קידוד ברירת מחדל.

דוגמאות ל ערכה יש לו ארה"ב-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, עליך להשתמש באפשרות זו כדי לציין כתובת אתר זו.

זה יכול לעזור למנוע התקפות מסוימות של הפניה מחדש המשמשות שולחי דואר זבל, וזה יכול להיות מועיל
עבור לקוחות אינטרנט מסוימים.

מֶלֶל אפשרויות

-שֶׁקֶט
דחק את כל הפלט מלבד אזהרות והודעות שגיאה.

-שורש
היו מאוד מילוליים לגבי מה gjdoc עושה.

אפשרות זו מתעלמת כרגע.

וירטואלי מכונה אפשרויות

שמש javadoc הכלי נראה מבוסס על ג'אוואק וככזה נראה שהוא פועל על ה-VM
רָמָה. gjdoc, לעומת זאת, הוא יישום Java טהור.

לכן, gjdoc יכול רק לזייף, או לדמות, את האפשרויות הבאות ברמת ה-VM.

-נתיב כיתתי רשימת הנתיבים
הגדר את המכונה הוירטואלית מסלול כיתה ל רשימת הנתיבים.

ברוב המקרים כדאי להשתמש -docletpath or -תגלת שביל במקום אפשרות זו.

רשימת הנתיבים צריך להיות נתיב אחד או יותר לספרייה או לקובץ jar, מופרדים על ידי שלך
מפריד הנתיבים של הפלטפורמה (בדרך כלל : or ;).

אם אפשרות זו לא יורטה ברמת העטיפה, gjdoc כרגע מזייף את זה על ידי
קוראים System.setProperty("java.class.path", רשימת הנתיבים); ומוציא אזהרה.

-bootclasspath רשימת הנתיבים
הגדר את המכונה הוירטואלית bootclasspath ל רשימת הנתיבים.

אם אפשרות זו לא יורטה ברמת העטיפה, gjdoc מוציא אזהרה.

-Jvmopt
העבר פרמטר שרירותי למכונה הוירטואלית gjdoc רץ הלאה.

אם אפשרות זו לא יורטה ברמת העטיפה, gjdoc מנסה לחקות את
אפשרות ומוציא אזהרה.

כרגע, רק אפשרות VM -D להגדרת מאפייני מערכת הוא חיקוי.

השתמש ב- gjdoc-4.8 באינטרנט באמצעות שירותי onworks.net