שפת Java - חלק ראשון

4.6. הפעלת Javadoc

את תכנית ה-Javadoc מפעילים בשורת הפקודה באופן הבא:

javadoc [options] [package | source.java]

כלומר, מייד לאחר שכותבים בשורת הפקודה “Javadoc” יש לרשום את שם (שמות) ה-package

(ה-packages) שעבורם ייווצרו מסמכי HTML. מסמכי ה-HTML שייווצרו כוללים תיעוד של המרכיבים שהרשאת הגישה שלהם היא public או protected בלבד. מסמכים אלה כוללים מסמך תיעוד לכל מחלקה ומסמך תיעוד לכל package. בנוסף, תכנת ה-Javadoc גם יוצרת מסמך HTML אשר מתאר את היררכית המחלקות אשר נוצרת (tree.html) ומערך מסמכי HTML אשר מהווה index לכל האלמנטים אשר תועדו.

חלק מה-options שניתן לשלב לפני שמו/שמם של קובץ קוד המקור/קבצי קוד המקור (או שמו/שמם של ה-package\packages) הינם:

-public

מסמכי ה-HTML יכללו תיעוד של מחלקות ורכיבי מחלקות שהרשאות הגישה שלהם היא public בלבד.

-protected

מסמכי ה-HTML יכללו תיעוד של מחלקות ורכיבי מחלקות שהרשאות הגישה שלהם הן public או protected.

-package

מסמכי ה-HTML יכללו תיעוד של מחלקות ורכיבי מחלקות שהרשאות הגישה שלהם הן public, protected או package friendly בלבד.

-private

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

-author

כדי שמסמכי ה-HTML יכללו את תוצאותיהן של התגיות @author יש להשתמש באפשרות זו. בברירת המחדל תגיות אלה לא נלקחות בחשבון בעת יצירת מסמכי ה-HTML.

-d directory

כדי לקבוע את הספרייה שבה יישמרו מסמכי ה-HTML אשר ייווצרו.

-sourcepath path

באמצעות אפשרות זו ניתן לציין את ה-path למיקום שבו נמצאת ספרית ה-package  העליונה ביותר בהיררכית הספריות אשר מייצגות את ה-packages השונים (אם ה-Javadoc מופעל כדי לייצור תיעוד לפרוייקט כולו) או את ה-path למיקום שבו נמצאים קבצי ה-source code  המסוימים שאותם רוצים לתעד בהערות javadoc. בדרך כלל אין כל צורך להשתמש באפשרות זו כיוון שנהוג להפעיל את javadoc בספריה שבה נמצאת הספרייה אשר מייצגת את ה-package העיקרי (ה-package שבראש היררכית ההורשה).