זוהי הפקודה dh_ocamldoc שניתן להריץ בספק האירוח החינמי של OnWorks באמצעות אחת מתחנות העבודה המקוונות החינמיות שלנו כגון Ubuntu Online, Fedora Online, אמולטור מקוון של Windows או אמולטור מקוון של MAC OS.
תָכְנִית:
שֵׁם
dh_ocamldoc - יוצר תיעוד עבור ספריות OCaml
תַקצִיר
dh_ocamldoc [12 formal אפשרויות]
תיאור
dh_ocamldoc מחפש את כל הקבצים התואמים ל-"debian/$package.ocamldoc*" שם הוא יכול למצוא את
דגלים שיינתנו ל-ocamldoc, אשר ייקרא עם כל קבצי ה-.mli (או .ml)
אם לא נמצא קובץ .mli) תואם ב-debian/package/usr/lib/ocaml. כל קובץ ".ocamldoc*"
קובץ משמש ליצירת תיעוד שונה שבו החלק שמגיע אחרי "ocamldoc"
בשם הקובץ משמש כמזהה מסמך בקובץ doc-base.
ניתן לכלול מספר דגלים בכל שורה. שורות המתחילות ב-"--include" כוללות סמל מיוחד.
כלומר: כל מה שיבוא אחרי "--include" ייחשב כרשימה של ספריות שבהן
יחפשו קבצי .mli או .ml לצורך יצירת תיעוד. הספריות יתבצעו
ניתן להוסיף גם לנתיב החיפוש של ספריית ocamldoc. זה יכול להיות שימושי ליצירת
תיעוד בחבילה בינארית משלו. שימו לב, לשם כך עליכם לוודא ש
החבילה המשלוחת את התיעוד מטופלת על ידי dh_ocamldoc לאחר החבילה
משלוח החפצים בפועל.
הדגל "-d" מזוהה ומשמש ליצירת קובץ ה-doc-base המתאים. הוא מכיל
הנתיב של ספריית התיעוד והוא יחסי ל-"/usr/share/doc/$package/". ה-
ערך ברירת המחדל הוא "html/api".
dh_ocamldoc מזהה אוטומטית אם יש לקרוא ל-"ocamlfind ocamldoc" במקום
"ocamldoc" פשוט (הוא עושה זאת על ידי חיפוש אפשרויות ocamlfind נפוצות כגון: -package,
-נשואים וכו').
שורות המתחילות ב-"#" בקבצי *ocamldoc הן הערות ולכן הן מתעלמות מהן.
אם ברצונך להתקין את התיעוד הקיים בקובץ tarball של upstream (אם קיים), תוכל...
הוסף "--doc-base-generate" לקובץ ה-.ocamldoc שלך כדי להורות ל-dh_ocamldoc ליצור את
קובץ מבוסס .doc בלבד.
אפשרויות
-X קבצים
אל תכלול קבצים בעיבוד תיעוד.
-u דגלים
דגלים נוספים ל-"ocamldoc" או "ocamlfind ocamldoc".
השתמש ב- dh_ocamldoc באופן מקוון באמצעות שירותי onworks.net
