זוהי הפקודה דאדock שניתן להפעיל בספק האירוח החינמי של OnWorks באמצעות אחת מתחנות העבודה המקוונות המרובות שלנו, כגון Ubuntu Online, Fedora Online, אמולטור מקוון של Windows או אמולטור מקוון של MAC OS
תָכְנִית:
שֵׁם
Haddock - כלי תיעוד עבור קוד מקור מוער של Haskell
תַקצִיר
חמור ים [אפשרויות] פילה...
תיאור
דף מדריך זה מתעד בקצרה את חמור ים פקודה. תיעוד נרחב הוא
זמין בפורמטים שונים אחרים כולל DVI, PostScript ו-HTML; ראה למטה.
פילה הוא שם קובץ המכיל מודול מקור Haskell. כל המודולים המצוינים ב-
שורת הפקודה תעובד יחד. כאשר מודול אחד מתייחס לישות באחרת
מודול בעיבוד, התיעוד יקשר ישירות לאותה ישות.
ישויות שלא ניתן למצוא, למשל בגלל שהן נמצאות במודול שאינו נמצא
מעובד כחלק מהאצווה הנוכחית, פשוט לא יקושר היפר-קישור בקובץ שנוצר
תיעוד. חמור ים ישלח אזהרות המפרטות את כל המזהים שלא יכלו
לִפְתוֹר.
המודולים לא צריכים להיות רקורסיביים הדדית, כמו חמור ים לא אוהב לשחות פנימה
מעגלים.
אפשרויות
התוכניות עוקבות אחר תחביר שורת הפקודה הרגיל של GNU, עם אפשרויות ארוכות שמתחילות בשניים
מקפים (`--'). סיכום האפשרויות כלול להלן. לתיאור מלא, ראה
התיעוד האחר.
-o DIR, --אודיר=DIR
ספרייה שבה שמים את קבצי הפלט
-i קובץ, --read-interface=קובץ
לקרוא ממשק מ קובץ.
-D קובץ, --dump-interface=קובץ
לזרוק ממשק עבור המודולים האלה פנימה קובץ.
-l DIR, --lib=DIR
מיקום קבצי העזר של האדוק
-h, --html
הפקת תיעוד בפורמט HTML. ייווצרו מספר קבצים לתוך
הספרייה הנוכחית (או הספרייה שצוינה אם -o ניתנת אפשרות), כולל
הבא:
index.html
הדף ברמה העליונה של התיעוד: מפרט את המודולים הזמינים, באמצעות
הזחה כדי לייצג את ההיררכיה אם המודולים הם היררכיים.
haddock.css
גיליון הסגנונות המשמש את ה-HTML שנוצר. אתה מוזמן לשנות את זה ל
שנה את הצבעים או הפריסה, או אפילו ציין את גיליון הסגנונות שלך באמצעות
--css אוֹפְּצִיָה.
module.html
דף HTML לכל מודול.
doc-index.html, doc-index-XX.html
האינדקס, מחולק לשניים (פונקציות/בנאים וסוגים/מחלקות, לפי
מרחבי השמות של Haskell) ופיצול נוסף לפי אלפביתי.
--הולה
פלט עבור Hoogle
--html-help=פוּרמָט
לייצר אינדקס ותוכן עניינים בפורמט mshelp, mshelp2 או devhelp (עם -h)
--source-base=כתובת האתר
כלול קישורים לקובצי המקור בתיעוד שנוצר, כאשר כתובת האתר היא
כתובת האתר הבסיסית שבה ניתן למצוא את קבצי המקור.
-s כתובת אתר, --source-module=כתובת האתר
כלול קישורים לקובצי המקור בתיעוד שנוצר, כאשר כתובת האתר היא א
קישור קוד מקור עבור כל מודול (באמצעות ה-%{FILE} או %{MODULE} vars).
--מקור-ישות=כתובת האתר
כלול קישורים לקובצי המקור בתיעוד שנוצר, כאשר כתובת האתר היא א
קישור קוד מקור עבור כל ישות (באמצעות ה-%{FILE}, %{MODULE} או %{NAME} vars).
--comments-base=כתובת האתר
כתובת URL לקישור הערות בדפי התוכן והאינדקס.
--comments-module=כתובת האתר
כתובת אתר לקישור הערות עבור כל מודול (באמצעות ה-%{MODULE} var).
--comments-entity=כתובת האתר
כתובת אתר לקישור הערות עבור כל ישות (באמצעות %{FILE}, %{MODULE} או %{NAME}
vars).
--css=קובץ
השתמש ב- CSS קובץ במקום גיליון הסגנונות המוגדר כברירת מחדל שמגיע עם חמור ים עבור HTML
תְפוּקָה. זה צריך לציין מחלקות מסוימות: עיין בגיליון הסגנונות המוגדר כברירת מחדל לפרטים.
-p קובץ, --פרולוג=קובץ
ציין קובץ המכיל טקסט פרולוג.
-t כותרת, --title=כותרת
השתמש כותרת ככותרת העמוד עבור כל עמוד בתיעוד. זה יהיה
בדרך כלל הוא שם הספרייה המתועדת.
הכותרת צריכה להיות מחרוזת פשוטה (ללא סימון בבקשה!).
-k שֵׁם, --חבילה=שֵׁם
ציין את שם החבילה (אופציונלי).
-n, --ללא-הקדמה-מרומזת
אל תניח שהפרלוד מיובא
-d, --לנפות
אפשר פלט ניפוי באגים נוסף.
-?, - עזרה
הצג עזרה.
-V, --גִרְסָה
גרסת תצוגה.
-v, --מִלוּלִי
דיווח מצב מפורט.
--use-contents=כתובת האתר
השתמש בדף תוכן HTML שנוצר בנפרד.
--gen-תוכן
צור תוכן HTML מממשקים שצוינו.
--use-index=כתובת האתר
השתמש באינדקס HTML שנוצר בנפרד.
--gen-index
צור אינדקס HTML מממשקים שצוינו.
--התעלם מכל היצוא
התנהג כאילו לכל המודולים יש את התכונה ignore-exports
--הסתיר=מודול
תתנהג כאילו מודול יש את התכונה hide.
--use-package=חֲבִילָה
המודולים המעובדים תלויים חֲבִילָה.
השתמש ב-Haddock באינטרנט באמצעות שירותי onworks.net
