זוהי הפקודה kgenapidox שניתן להפעיל בספק האירוח החינמי של OnWorks באמצעות אחת מתחנות העבודה המקוונות המרובות שלנו, כגון Ubuntu Online, Fedora Online, אמולטור מקוון של Windows או אמולטור מקוון של MAC OS
תָכְנִית:
שֵׁם
kgenapidox - צור תיעוד API בסגנון KDE
גִרְסָה
5.13.0
נוהג
שימוש: kgenapidox [-h] [--dependency-diagram-dir DEPENDENCY_DIAGRAM_DIR]
[--title TITLE] [--man-pages] [--qhp] [--מנוע חיפוש]
[--api-searchbox] [-o OUTPUT] [--qtdoc-dir QTDOC_DIR]
[--qtdoc-link QTDOC_LINK] [--qtdoc-flatten-links]
[--kdedoc-dir KDEDOC_DIR] [--kdedoc-link KDEDOC_LINK]
[--doxygen DOXYGEN] [--qhelpgenerator QHELPGENERATOR]
[--doxdatadir DOXDATADIR] [--keep-temp-dirs]
[moduledir]
טיעונים אופציונליים:
-h, - עזרה להציג את הודעת העזרה הזו ולצאת ממנה
מקורות:
moduledir מיקום המודול לבניית תיעוד API עבורו;
הוא צריך להכיל קובץ README.md וקובץ src/
ספריית משנה.ברירת מחדל לתיקיה הנוכחית.
--dependency-diagram-dir DEPENDENCY_DIAGRAM_DIR
מיקום של דיאגרמת המסגרת; "תלות"
הדף ייכלל בתיעוד המסגרת
אם מסופק.
אפשרויות פלט:
--title TITLE מחרוזת לשימוש עבור כותרות עמודים.
--man-pages צור תיעוד של דף אדם.
--qhp צור תיעוד עזרה דחוס Qt.
--searchengine הפעל את תכונת מנוע החיפוש של Doxygen.
--api-searchbox הפעל את תיבת החיפוש של API (שימושי רק עבור
api.kde.org).
-o OUTPUT, --output OUTPUT
מיקום שבו יופק התיעוד.
ברירת המחדל ל-apidocs.
תיעוד Qt:
--qtdoc-dir QTDOC_DIR
מיקום תיעוד Qt (מקומי); מחפשים את זה
עבור קבצי תג ליצירת קישורים לשיעורי Qt.
--qtdoc-link QTDOC_LINK
עוקף את מיקום התיעוד של Qt עבור הקישורים ב
קבצי ה-html. יכול להיות נתיב או כתובת אתר.
--qtdoc-flaten-links
האם יש להניח שכל קבצי ה-html של תיעוד Qt הם
מיד תחת QTDOC_LINK (שימושי אם אתה מגדיר
QTDOC_LINK לתיעוד Qt המקוון). התעלמו אם
QTDOC_LINK לא מוגדר.
תיעוד KDE:
--kdedoc-dir KDEDOC_DIR
מיקום התיעוד (מקומי) של KDE; זה
חיפש קבצי תג ליצירת קישורים למחלקות KDE.
--kdedoc-link KDEDOC_LINK
עוקף את מיקום התיעוד של KDE עבור הקישורים ב
קבצי ה-html. יכול להיות נתיב או כתובת אתר.
נתיבים:
--doxygen DOXYGEN (נתיב אל) קובץ ההפעלה של doxygen.
--qhelpgenerator QHELPGENERATOR
(נתיב) לקובץ ההפעלה של qhelpgenerator.
שונות:
--doxdatadir DOXDATADIR
מיקום קובצי כותרות HTML ותמיכה
גרפיקה.
--keep-temp-dirs אל תמחק קבצים זמניים, שימושי לניפוי באגים.
מחברים
גרסה זו של קפידוקס נכתב על ידי Aurélien Gâteau [מוגן בדוא"ל].
דף אדם זה נוצר על ידי סקוט קיטרמן[מוגן בדוא"ל]>.
2015-07-11 קגנאפידוקס(1)
השתמש ב-kgenapidox באינטרנט באמצעות שירותי onworks.net
