זוהי הפקודה pasdoc שניתן להריץ בספק האירוח החינמי של OnWorks באמצעות אחת מתחנות העבודה המקוונות החינמיות שלנו כגון Ubuntu Online, Fedora Online, אמולטור מקוון של Windows או אמולטור מקוון של MAC OS.
תָכְנִית:
שֵׁם
PasDoc - כלי תיעוד לקוד מקור של Pascal
תַקצִיר
פסדוק [אפשרויות] [קבצים]
תיאור
PasDoc 0.14.0 [2015-08-09|FPC 2.6.4|Linux|64] מחולל תיעוד עבור קוד המקור של Pascal
זוהי תוכנה חופשית; עיין במקור לתנאי ההעתקה. אין אחריות; לֹא
אפילו לצורך סחירות או התאמה למטרה מסוימת.
תקף אפשרויות הם:
-?, - עזרה
הצג את העזרה הזו
--גִרְסָה
הצג גרסת pasdoc (ומידע קשור)
-v, --מֶלֶל
הגדר את רמת הפירוט של יומן הרישום (0-6) [2]
-D, --לְהַגדִיר
הגדר תנאי
-R, --תיאור
קרא את התיאור מהקובץ הזה
-d, --תנאים
קרא את התנאים מהקובץ הזה
-I, --לִכלוֹל
כולל נתיב חיפוש
-S, --מָקוֹר
קרא שמות קבצי מקור מהקובץ
--html-help-contents
קרא תוכן עבור HtmlHelp מהקובץ
-F, --כותרת תחתונה
כלול קובץ ככותרת תחתונה עבור פלט HTML
-H, --כּוֹתֶרֶת
כלול קובץ ככותרת עבור פלט HTML
-N, --שֵׁם
שם לתיעוד
-T, --כותרת
כותרת התיעוד
-O, --פוּרמָט
פורמט פלט: html, simplexml, latex, latex2rtf או htmlhelp
-E, --תְפוּקָה
נתיב הפלט
-X, --מחולל-הכללה
אי הכללת מידע על גנרטור
--include-creation-time
כלול את זמן היצירה במסמכים
-L, --שפה
שפת פלט. שפות תקפות הן: ba: בוסנית (דף קידוד 1250) br.1252:
ברזילאית (קוד 1252) br.utf8: ברזילאית (קוד UTF-8) bg: בולגרית
(עמוד קוד UTF-8) ct: קטלאנית gb2312: סינית (פשוטה, gb2312) hr: קרואטית dk:
דנית nl: הולנדית en: אנגלית fr: צרפתית (iso-8859-15) fr.utf8: צרפתית (UTF-8) de:
גרמנית: אינדונזית, איטלקית: יוונית, ג'אוואנית, pl.cp1250: פולנית (דף קידוד CP1250)
pl.iso-8859-2: פולנית (קוד ISO 8859-2) ru.1251: רוסית (קוד 1251)
ru.utf8: רוסית (דף קוד UTF-8) ru.866: רוסית (דף קוד 866) ru.koi8r: רוסית
(KOI-8) sk: סלובקית (דף קוד 1250) es: ספרדית se: שוודי hu.1250: הונגרית
(דף קידוד 1250) cz: צ'כית (דף קידוד 1250) cz.iso-8859-2: צ'כית (דף קידוד ISO)
8859-2)
--כוכב בלבד
ניתוח הערות בסגנון {**, (*** ו- //** בלבד
--סַמָן
ניתוח בלבד { , (* ו // הערות. עוקף את הכוכב בלבד
אפשרות, שהיא קיצור דרך עבור '--marker=**'
--סמן-אופציונלי
אין צורך בסמנים המופיעים ב --סַמָן אבל הסירו אותם מהתגובה אם
הם קיימים.
--ignore-מוביל
התעלם מהריווח דמויות בתגובות.
--שמות קבצים מספריים
גורם למחולל ה-HTML ליצור שמות קבצים מספריים
-M, --חברים-נראים
הכללה/אי הכללה של חברי כיתה לפי נראות
--כתיבה-שימושים-רשימת
הכנס רשימת שימושים לפלט
--graphviz-uses
כתוב קובץ GVUses.dot שניתן להשתמש בו עבור תוכנית `dot` מ-GraphViz אל
צור גרף תלות יחידה
--graphviz-classes
כתוב קובץ GVClasses.dot שניתן להשתמש בו עבור תוכנית `dot` מ-GraphViz אל
צור גרף היררכיה של מחלקות
--קישור-gv-משתמש
הוסף קישור ל-GVUses. קובץ שנוצר על ידי תוכנית `dot` שבו
היא כל סיומת ש-`dot` יכול ליצור (למשל jpg). (כרגע רק עבור HTML)
פלט)
--קישור-gv-מחלקות
הוסף קישור ל-GVClasses. קובץ שנוצר על ידי תוכנית `dot` שבו
היא כל סיומת ש-`dot` יכול ליצור (למשל jpg). (כרגע רק עבור
פלט HTML)
--סִימָנֵי קִצוּר
קובץ קיצורים, הפורמט הוא "ערך [שם]", הערך חתוך, קווים שלא
שמות שמתחילים ב-'[' (או רווחים לפני כן) אינם מועברים
--בדיקת איות
הפעל בדיקת איות באמצעות Aspell, ציין שפה באמצעות --שפה אוֹפְּצִיָה
--בדיקת-איות-התעלמות-מילים
בעת בדיקת איות, התעלם מהמילים בקובץ זה. הקובץ צריך להכיל אחת
מילה בכל שורה
--אספל
הוצא משימוש, שימוש --בדיקת איותהפעל בדיקת איות על ידי Aspell, תוך מתן שפה כ
פרמטר
--cache-dir
ספריית מטמון עבור קבצים מנותחים (ברירת מחדל לא מוגדרת)
--מראה-קישור
כיצד מוצגים קישורים בתיעוד: "ברירת מחדל" (הצגת שם הקישור המלא,
כפי שצוין על ידי @link), "full" (הצג את שם הקישור המלא, ונסה להפוך כל אחד
חלק ממנו קישור), או "מוסתר" (הצגת החלק האחרון של הקישור)
--קישור-מלא
שם מיושן עבור --מראה-קישור=מלא
--css קובץ CSS עבור קבצי HTML (הועתק לעץ הפלט)
--תקציר אוטומטי
אם מוגדר, pasdoc ייצור באופן אוטומטי תיאור תקציר של כל פריט מה-
המשפט הראשון בתיאור של פריט זה
--use-tipue-search
השתמש במנוע החיפוש tipue בפלט HTML
--סוג מציין אילו קבוצות של פריטים ממוינות (השאר מוצג באותו סדר)
הם הוכרזו בקבצי המקור שלך)
--מָבוֹא
שם קובץ טקסט עם חומרי מבוא לפרויקט
--מַסְקָנָה
שם קובץ טקסט עם חומרי סיכום לפרויקט
--ראש לטקס
שם קובץ טקסט הכולל שורות שיש להכניס לתוך הקדמה של
קובץ LaTeX
--נראות-מרומזת
כיצד pasdoc צריך לטפל בחברי מחלקה בתוך נראות ברירת המחדל של המחלקה
--ללא מאקרו
כבה את תמיכת המאקרו של FPC
--קישור אוטומטי
צור קישורים באופן אוטומטי, ללא צורך להשתמש במפורש בתגיות @link
--הדרת-קישור-אוטומטי
גם כאשר --קישור אוטומטי מופעל, לעולם אל תיצור אוטומטית קישורים למזהים ב-
קובץ שצוין. הקובץ צריך להכיל מזהה אחד בכל שורה
--היררכיה-מחלקתית-חיצונית
קובץ המגדיר היררכיה של מחלקות שאינן כלולות בקוד המקור שלך, למידע נוסף
דיאגרמות עץ מחלקה מלאות
PasDoc 0.14.0 [2015-08-09|FPC 2.6.4|לינוקס|6 באוגוסט 2015 PASDOC(1)
השתמש ב-pasdoc באופן מקוון באמצעות שירותי onworks.net
