זוהי הפקודה ldoc שניתן להפעיל בספק האירוח החינמי של OnWorks באמצעות אחת מתחנות העבודה המקוונות המרובות שלנו, כגון Ubuntu Online, Fedora Online, אמולטור מקוון של Windows או אמולטור מקוון של MAC OS
תָכְנִית:
שֵׁם
ldoc - מערכת יצירת תיעוד תואמת LuaDoc
תיאור
LDoc, מחולל תיעוד עבור Lua התואם ל-LuaDoc.
אפשרויות
-ד, --dir
(ברירת המחדל של מסמכים) ספריית פלט
-או, --תְפוּקָה
(ברירת מחדל 'אינדקס') שם פלט
-ב, --מִלוּלִי
להיות מילולי במהלך יצירת מסמכים
-א, --את כל
הצג פונקציות מקומיות וכו' במסמכים
-q, --שֶׁקֶט
לדכא פלט
-M, --מודול
מסמכי מודול כטקסט
-ס, --סִגְנוֹן
(ברירת מחדל!) ספרייה עבור גיליון סגנונות (ldoc.css)
-ל, --תבנית
(ברירת מחדל!) ספרייה עבור תבנית (ldoc.ltp)
-פ, --פּרוֹיֶקט
(ברירת מחדל ldoc) שם הפרויקט
-ט, --כותרת
(ברירת המחדל של הפניה) כותרת העמוד
-ו, --פוּרמָט
עיצוב (ברירת מחדל רגיל), אפשרויות חוקיות הן סימון, הנחה או רגיל
-ב, --חֲבִילָה
(ברירת מחדל.) שם חבילה ברמה עליונה basename (דרוש עבור מודול(...))
-איקס, --שלוחה
(ברירת מחדל html) סיומת קובץ פלט
-ג, --config
(default config.ld) שם תצורה
-אני, --להתעלם
התעלם מכל אזהרות 'ללא הערה למסמך או ללא מודול'
-איקס, --not_luadoc
לשבור את תאימות LuaDoc. התיאורים עשויים להמשיך אחרי התגים.
-ד, --לְהַגדִיר
(ברירת מחדל אין) הגדר דגל לשימוש ב-config.ld
-ג, --המעי הגס
השתמש בסגנון המעי הגס
-ב, --לוחית
התעלם מהערה ראשונה בקבצי המקור
-M, --לְמַזֵג
לאפשר מיזוג מודול
-S, --פָּשׁוּט
ללא החזרה או פרמטרים, ללא סיכום
-או, --אחד
פריסת פלט של עמודה אחת
--מזבלה איתור באגים של dump פלט
--לְסַנֵן
(ברירת מחדל אין) פלט מסנן כנתוני Lua (למשל pl.pretty.dump)
-תגים (ברירת מחדל אין) הצג את כל ההפניות לתגיות נתונות, מופרדות בפסיקים
(מחרוזת) קובץ מקור או ספרייה המכילה מקור
דוגמאות
ldoc . קורא אפשרויות מקובץ config.ld באותה ספרייה
ldoc -c path/to/myconfig.ld .
קורא אפשרויות מ-path/to/myconfig.ld
השתמש ב-ldoc באינטרנט באמצעות שירותי onworks.net
