این دستور ldoc است که می تواند در ارائه دهنده هاست رایگان OnWorks با استفاده از یکی از چندین ایستگاه کاری آنلاین رایگان مانند Ubuntu Online، Fedora Online، شبیه ساز آنلاین ویندوز یا شبیه ساز آنلاین MAC OS اجرا شود.
برنامه:
نام
ldoc - یک سیستم تولید اسناد سازگار با LuaDoc
شرح
LDoc، یک تولید کننده اسناد برای Lua که با LuaDoc سازگار است.
OPTIONS
-د، -- کارگردان
دایرکتوری خروجی (اسناد پیش فرض).
-و ، -- خروجی
(پیش‌فرض 'شاخص') نام خروجی
-v، -- پرحرف
در طول تولید سند پرحرف باشید
-آ، --همه
توابع محلی و غیره را در اسناد نشان دهید
-q، --ساکت
خروجی را سرکوب کنید
-m، --مدول
اسناد ماژول به عنوان متن
-s ، --سبک
دایرکتوری (پیش‌فرض!) برای شیوه نامه (ldoc.css)
-ل، --قالب
دایرکتوری (پیش‌فرض!) الگو (ldoc.ltp)
-پ، --پروژه
(الدوک پیش فرض) نام پروژه
-t، --عنوان
عنوان صفحه (مرجع پیش فرض).
-f، --قالب
قالب بندی (پیش فرض ساده)، گزینه های معتبر علامت گذاری، تخفیف یا ساده هستند
-ب، --بسته
(پیش‌فرض.) نام پایه بسته سطح بالا (نیاز برای واحد(...))
-ایکس، -- داخلی
پسوند فایل خروجی (پیش فرض html).
-c، - پیکربندی
(پیش‌فرض config.ld) نام پیکربندی
-من، --چشم پوشی
هر گونه هشدار "بدون نظر سند یا بدون ماژول" را نادیده بگیرید
-ایکس، --not_luadoc
شکستن سازگاری LuaDoc. ممکن است توضیحات پس از برچسب ها ادامه یابد.
-دی، --تعريف كردن
(پیش‌فرض هیچ کدام) پرچمی را برای استفاده در config.ld تنظیم کنید
-C ، - دو نقطه
از سبک کولون استفاده کنید
-ب، --تکرار واضحات
نادیده گرفتن اولین نظر در فایل های منبع
-M، --ادغام
اجازه ادغام ماژول را می دهد
-S، --ساده
بدون بازگشت یا پارامتر، بدون خلاصه
-اوه --یک
طرح خروجی تک ستونی
--زباله رفع اشکال خروجی
-- فیلتر
(هیچ پیش فرض) خروجی را به عنوان داده Lua فیلتر کنید (به عنوان مثال pl.pretty.dump)
-- برچسب ها (پیش‌فرض هیچکدام) همه ارجاعات به برچسب‌های داده شده را با کاما از هم جدا نشان می‌دهد
(رشته) فایل منبع یا دایرکتوری حاوی منبع
مثال ها
ldoc . گزینه ها را از یک فایل config.ld در همان دایرکتوری می خواند
ldoc -c path/to/myconfig.ld .
گزینه ها را از path/to/myconfig.ld می خواند
با استفاده از خدمات onworks.net از ldoc به صورت آنلاین استفاده کنید
