זוהי הפקודה ocamldoc.opt שניתן להריץ בספק האירוח החינמי של OnWorks באמצעות אחת מתחנות העבודה המקוונות המרובות שלנו בחינם, כגון Ubuntu Online, Fedora Online, אמולטור מקוון של Windows או אמולטור מקוון של MAC OS
תָכְנִית:
שֵׁם
ocamldoc - מחולל התיעוד של OCaml
תַקצִיר
ocamldoc [ אפשרויות ] שם הקובץ ...
תיאור
מחולל התיעוד של OCAml ocamldoc(1) מייצר תיעוד ממיוחד
הערות המוטמעות בקבצי מקור. ההערות בשימוש על ידי ocamldoc הם בצורה (** ...
*) ופעל לפי הפורמט המתואר ב- השמיים Ocaml של המשתמש מדריך ל.
ocamldoc יכול לייצר תיעוד בפורמטים שונים: HTML, LaTeX, TeXinfo, Unix man
דפים, וכן נקודה(1) גרפי תלות. יתר על כן, משתמשים יכולים להוסיף גנרטורים מותאמים אישית משלהם.
ב-manpage זה, אנו משתמשים במילה אלמנט להתייחס לכל אחד מהחלקים הבאים של an
קובץ מקור Ocaml: הצהרת סוג, ערך, מודול, חריג, סוג מודול, א
סוג בנאי, שדה רשומה, מחלקה, סוג מחלקה, שיטת מחלקה, ערך מחלקה או
סעיף ירושה מעמדי.
אפשרויות
אפשרויות שורת הפקודה הבאות קובעות את הפורמט עבור התיעוד שנוצר
נוצר באמצעות ocamldoc(1).
אפשרויות ל בחירה מה היא תפוקה פוּרמָט
-html צור תיעוד בפורמט ברירת המחדל של HTML. דפי HTML שנוצרו מאוחסנים
בספרייה הנוכחית, או בספרייה שצוינה עם ה- -d אוֹפְּצִיָה. אתה יכול
התאם אישית את הסגנון של הדפים שנוצרו על ידי עריכת הדפים שנוצרו style.css קובץ,
או על ידי מתן גיליון סגנונות משלך באמצעות אפשרות -סגנון css. הקובץ style.css
לא נוצר אם הוא כבר קיים.
-שרף גומי צור תיעוד בפורמט ברירת המחדל של LaTeX. מסמך ה-LaTeX שנוצר הוא
נשמר בקובץ ocamldoc.out, או בקובץ שצוין עם ה- -o אוֹפְּצִיָה. ה
המסמך משתמש בקובץ הסגנון ocamldoc.sty. קובץ זה נוצר בעת שימוש ב-
-שרף גומי אפשרות, אם היא עדיין לא קיימת. אתה יכול לשנות את הקובץ הזה להתאמה אישית
הסגנון של תיעוד ה-LaTeX שלך.
-טקסי צור תיעוד בפורמט ברירת המחדל של TeXinfo. מסמך ה-LaTeX שנוצר הוא
נשמר בקובץ ocamldoc.out, או בקובץ שצוין עם ה- -o אוֹפְּצִיָה.
-איש צור תיעוד כקבוצה של דפי אדם של Unix. הדפים שנוצרו מאוחסנים
בספרייה הנוכחית, או בספרייה שצוינה עם ה- -d אוֹפְּצִיָה.
-נְקוּדָה צור גרף תלות עבור המודולים ברמה העליונה, בפורמט המתאים ל
הצגה ועיבוד על ידי נקודה(1). ה נקודה(1) הכלי זמין מ
http://www.research.att.com/sw/tools/graphviz/. הייצוג הטקסטואלי של ה
גרף נכתב לקובץ ocamldoc.out, או לקובץ שצוין עם ה- -o
אוֹפְּצִיָה. להשתמש נקודה ocamldoc.out כדי להציג אותו.
-g פילה
טען באופן דינמי את הקובץ הנתון (שהסיומת היא בדרך כלל .cmo או .cma), אשר
מגדיר מחולל תיעוד מותאם אישית. אם הקובץ הנתון הוא פשוט ו
לא קיים בספרייה הנוכחית, אם כן ocamldoc מחפש את זה במנהג
ספריית ברירת המחדל של גנרטורים, ובספריות המצוינות עם -i אוֹפְּצִיָה.
-dir
הצג את ספריית ברירת המחדל של מחוללים מותאמים אישית.
-i בספרייה
הוסף את הספרייה הנתונה לנתיב שבו לחפש גנרטורים מותאמים אישית.
כללי אפשרויות
-d dir צור קבצים בספרייה dir, במקום הספרייה הנוכחית.
-מזבלה פילה
לזרוק מידע שנאסף לתוך פילה. מידע זה ניתן לקרוא עם - טען
אופציה בהפעלה שלאחר מכן של ocamldoc(1).
-להתחבא מודולים
הסתר את שמות המודולים המלאים בתיעוד שנוצר. מודולים הוא
רשימה של שמות מודולים מלאים מופרדים בפסיקים (,), ללא ריק. ל
למשל: מתפשט,M2.M3.
-inv-merge-ml-mli
הפוך את קדימות ההטמעות והממשקים בעת מיזוג. את כל
רכיבים בקבצי יישום נשמרים, וה -m אפשרות מציינת אילו חלקים
מההערות בקובצי הממשק מתמזגים עם ההערות ביישום
קבצים.
-שמור-קוד
שמור תמיד את קוד המקור עבור ערכים, שיטות ומשתני מופע, מתי
זמין. קוד המקור נשמר תמיד כאשר ניתן קובץ .ml, אבל הוא על ידי
ברירת המחדל נמחקת כאשר ניתנת .mli. אפשרות זו מאפשרת לקוד המקור להיות
תמיד נשמר.
- טען פילה
טען מידע מ פילה, אשר הופק על ידי ocamldoc -מזבלה. כמה
- טען ניתן לתת אפשרויות.
-m דגלים
ציין אפשרויות מיזוג בין ממשקים והטמעות. דגלים יכול להיות אחד או
כמה מהדמויות הבאות:
d מיזוג תיאור
a מיזוג @author
v מיזוג @version
l מיזוג @see
s מיזוג @מאז
o מיזוג @ הוצא משימוש
p מיזוג @param
e מיזוג @raise
r מיזוג @return
A למזג הכל
-ללא-תגים מותאמים אישית
אל תאפשר תגי @-מותאמים אישית.
-אין עצירה
שמור אלמנטים ממוקמים אחרי (**/**) הערה מיוחדת.
-o פילה
פלט את התיעוד שנוצר ל פילה במקום ocamldoc.out. אפשרות זו היא
משמעותי רק בשילוב עם -שרף גומי, -טקסי, או -נְקוּדָה אפשרויות.
-עמ הפקודה
צינור מקורות דרך מעבד קדם הפקודה.
-ppx הפקודה
צנרת עץ תחביר מופשט דרך מעבד קדם הפקודה.
-סוג מיין את רשימת המודולים ברמה העליונה לפני יצירת התיעוד.
כוכבים הסר תווים ריקים עד הכוכבית הראשונה ('*') בכל שורה של הערות.
-t כותרת
השתמש כותרת ככותרת לתיעוד שנוצר.
-הקדמה פילה
השתמש בתוכן של פילה as ocamldoc טקסט לשימוש כהקדמה (HTML, LaTeX ו
TeXinfo בלבד). עבור HTML, הקובץ משמש ליצירת כל הקובץ "index.html".
-v מצב מילולי. הצג מידע על התקדמות.
-הפך
מחרוזת גרסת הדפסה ויציאה.
-vnum הדפס מספר גרסה קצר וצא.
-אזהרה-שגיאה
לטפל ocamldoc אזהרות כשגיאות.
- הסתר אזהרות
אל תדפיס ocamldoc אזהרות.
עזרה or - עזרה
הצג סיכום שימוש קצר וצא.
בדיקת סוגים אפשרויות
ocamldoc(1) קורא לבודק הסוג OCAml כדי לקבל מידע על הסוג. האפשרויות הבאות
להשפיע על שלב בדיקת הסוג. יש להם אותה משמעות כמו ל-
ocamlc(1) ו ocamlopt(1) פקודות.
-I בספרייה
להוסיף בספרייה לרשימת הספריות חפש קובצי ממשק מהול (.cmi
קבצים).
-נולבלים
התעלם מתוויות לא אופציונליות בסוגים.
-טיפוסים
אפשר סוגים רקורסיביים שרירותיים. (ראה את -טיפוסים אפשרות ל ocamlc(1).)
אפשרויות ל יצירת HTML דפים
האפשרויות הבאות חלות בשילוב עם -html אפשרות:
-כל הפרמטרים
הצג את רשימת הפרמטרים המלאה עבור פונקציות ושיטות.
-סגנון css שם הקובץ
השתמש שם הקובץ כקובץ גיליון סגנונות מדורגים.
-קוד לצבוע
צבע את קוד ה-OCaml המוקף ב-[ ] ו-\{[ ]\}, תוך שימוש בצבעים כדי להדגיש
מילות מפתח וכו'. אם קטעי הקוד אינם נכונים מבחינה תחבירית, אין צבע
הוסיף.
-אינדקס בלבד
צור רק קבצי אינדקס.
-קצרים-פונקטורים
השתמש בטופס קצר כדי להציג פונקציות: מודול M : פונקציה (ת: מודול) -> פונקציה
(B:Module2) -> sig .. סוף מוצג כ מודול M (ת: מודול) (B:Module2) : sig ..
סוף.
אפשרויות ל יצירת LaTeX קבצים
האפשרויות הבאות חלות בשילוב עם -שרף גומי אפשרות:
-latex-value-prefix קידומת
תן קידומת לשימוש עבור התוויות של הערכים במסמך LaTeX שנוצר.
קידומת ברירת המחדל היא המחרוזת הריקה. אתה יכול גם להשתמש באפשרויות -סוג לטקס-
קידומת, -latex-exception-prefix, -latex-module-prefix, -latex-module-type-prefix,
-latex-class-prefix, -latex-class-type-prefix, -latex-attribute-prefix, ו -שרף גומי-
שיטה-תחילית.
אפשרויות אלה שימושיות כאשר יש לך, למשל, סוג וערך עם ה
אותו שם. אם לא תציין קידומות, LaTeX יתלונן על ריבוי
תוויות מוגדרות.
-כותרת לטקס n,סגנון
מספר סגנון שייך n לפקודת החתך הנתונה של LaTeX סגנוןלמשל
סעיףorסעיף קטן. (LaTeX בלבד.) זה שימושי כאשר כוללים את שנוצר
מסמך במסמך LaTeX אחר, ברמת חתך נתונה. ברירת המחדל
האגודה היא 1 עבור סעיף, 2 עבור סעיף קטן, 3 עבור תת-סעיף, 4 עבור
פסקה ו-5 עבור סעיף משנה.
-ללא כותרת
הדחק כותרת בתיעוד שנוצר.
-notoc אל תיצור תוכן עניינים.
-נוטריילר
דיכוי טריילר בתיעוד שנוצר.
-קבצי קבצים
צור קובץ tex אחד לכל מודול ברמה העליונה, במקום הגלובלי ocamldoc.out
קובץ.
אפשרויות ל יצירת TeXinfo קבצים
האפשרויות הבאות חלות בשילוב עם -טקסי אפשרות:
-esc8 בריחה מדמויות מודגשות בקבצי מידע.
-כניסת מידע
ציין ערך ספריית מידע.
-מדור מידע
ציין חלק בספריית המידע.
-ללא כותרת
הדחק כותרת בתיעוד שנוצר.
-noindex
אל תבנה אינדקס עבור קבצי מידע.
-נוטריילר
דיכוי טריילר בתיעוד שנוצר.
אפשרויות ל יצירת נקודה גרפים
האפשרויות הבאות חלות בשילוב עם -נְקוּדָה אפשרות:
-נקודות-צבעים צבעים
ציין את הצבעים לשימוש בקוד הנקודה שנוצר. בעת יצירת מודול
תלות, ocamldoc(1) משתמש בצבעים שונים עבור מודולים, בהתאם ל
ספריות שבהן הם שוכנים. בעת יצירת תלות סוגים, ocamldoc(1)
משתמש בצבעים שונים לסוגים, בהתאם למודולים שבהם הם נמצאים
מוּגדָר. צבעים היא רשימה של שמות צבעים מופרדים בפסיקים (,), כמו ב
אדום, כחול, ירוק. הצבעים הזמינים הם אלה הנתמכים על ידי נקודה(1) כלי.
-נקודה-כלול-הכל
כלול את כל המודולים ב- נקודה(1) פלט, לא רק מודולים שניתנו בפקודה
קו או טעון עם - טען אוֹפְּצִיָה.
-הקטנת נקודות
בצע הפחתה טרנזיטיבית של גרף התלות לפני הפלט של הנקודה
קוד. זה יכול להיות שימושי אם יש הרבה תלות טרנזיטיבית שמבלבלת
הגרף.
-סוגי נקודות
פלט קוד נקודה המתאר את גרף התלות בסוג במקום המודול
גרף תלות.
אפשרויות ל יצירת איש קבצים
האפשרויות הבאות חלות בשילוב עם -איש אפשרות:
-גבר-מיני
צור דפי אדם רק עבור מודולים, סוגי מודולים, מחלקות וסוגי מחלקות, במקום זאת
של דפים עבור כל האלמנטים.
-סיומת אדם סִיוֹמֶת
הגדר את הסיומת המשמשת עבור שמות קבצים שנוצרו. ברירת המחדל היא o, כמו ב רשימה.o.
-מדור-אדם סעיף
הגדר את מספר הקטע המשמש עבור שמות קבצים שנוצרו. ברירת המחדל היא 3.
השתמש ב-ocamldoc.opt באינטרנט באמצעות שירותי onworks.net
