نام (NAME)

gi-docgen - ابزار تولید مستندات با استفاده از gobject-introspection

خلاصه دستور (SYNOPSIS)

gi-docgen COMMAND [OPTION...] GIR_FILE

توضیحات (DESCRIPTION)

‏GI-DocGen یک ابزار تولید مستندات برای کتابخانه‌های مبتنی بر GObject است. سامانهٔ GObject سیستم نوع پایه (base type system) پروژهٔ GNOME است. GI-DocGen از داده‌های درون‌نگری (introspection) ماشین‌خوان ارائه‌شده توسط کتابخانه‌های مبتنی بر GObject برای تولید مرجع API این کتابخانه‌ها و سایر مستندات تکمیلی استفاده می‌کند.

فایل اجرایی اصلی gi-docgen زیردستورهای گوناگونی را برای دسترسی به تمام عملکردهای خود ارائه می‌دهد.

گزینه‌های عمومی (COMMON OPTIONS)

همهٔ دستورها گزینه‌های زیر را دارند:

--quiet: عدم چاپ جزئیات عملیات جاری
--fatal-warnings: تبدیل هشدارها به خطاهای مهلک
--help: چاپ راهنمای خط فرمان

دستور generate (THE GENERATE COMMAND)

دستور generate قابلیت اصلی gi-docgen را ارائه می‌دهد.

gi-docgen generate [ OPTIONS ] [ GIR_FILE ]

دستور generate فایل GIR داده‌شده و وابستگی‌های آن را تجزیه کرده و یک مرجع API برای فضای نام یافت‌شده در داده‌های درون‌نگری ایجاد می‌کند. پروژه‌ها می‌توانند از یک فایل پیکربندی برای کنترل جنبه‌های خروجی و همچنین ارائهٔ محتوای اضافی که باید در مستندات گنجانده شود، استفاده کنند.

گزینه‌ها:

--config=FILE: استفاده از فایل پیکربندی پروژه داده‌شده
--content-dir=PATH: مشخص کردن دایرکتوری‌ای که فایل‌های محتوای فهرست‌شده در فایل پیکربندی پروژه در آن قرار دارند
--templates-dir=PATH: مشخص کردن دایرکتوری‌ای که قالب‌های مورداستفاده برای تولید مستندات در آن قرار دارند
--theme-name=NAME: مشخص کردن نام قالب مورداستفاده هنگام تولید مستندات، که بر پیکربندی پروژه برتری خواهد داشت
--output-dir=PATH: ایجاد مستندات در دایرکتوری داده‌شده
--no-namespace-dir: تولید مستقیم تمام فایل‌های مستندات در دایرکتوری خروجی، به جای ایجاد دایرکتوری با استفاده از نام و نسخهٔ فضای نام
--add-include-path=PATH: افزودن یک دایرکتوری به مسیری که پویشگر (scanner) برای یافتن فایل‌های GIR از آن استفاده می‌کند. می‌تواند چندین بار برای مشخص کردن چندین دایرکتوری استفاده شود
--section=NAME: تولید مستندات تنها برای بخش داده‌شده. می‌تواند چندین بار برای مشخص کردن چندین بخش استفاده شود. بخش‌های پشتیبانی‌شده عبارتند از aliases، bitfields، classes، domains، enums، interfaces، structs و unions. مقادیر ویژه عبارتند از all به معنای همهٔ بخش‌ها (پیش‌فرض)؛ و none به معنای هیچ بخشی
--dry-run: تجزیهٔ GIR_FILE بدون تولید مستندات

دستور gen-index (THE GEN-INDEX COMMAND)

دستور gen-index نمایه‌ای از نمادها و اصطلاحات تولید می‌کند که می‌تواند برای جستجو در مستندات تولیدشده توسط gi-docgen استفاده شود.

gi-docgen gen-index [ OPTIONS ] [ GIR_FILE ]

نمایهٔ تولیدشده فایلی با قالب JSON به نام index.json است.

گزینه‌ها:

--config=FILE: استفاده از فایل پیکربندی پروژه داده‌شده
--content-dir=PATH: مشخص کردن دایرکتوری‌ای که فایل‌های محتوای فهرست‌شده در فایل پیکربندی پروژه در آن قرار دارند
--output-dir=PATH: ایجاد نمایه در دایرکتوری داده‌شده
--add-include-path=PATH: افزودن یک دایرکتوری به مسیری که پویشگر برای یافتن فایل‌های GIR از آن استفاده می‌کند. می‌تواند چندین بار برای مشخص کردن چندین دایرکتوری استفاده شود
--dry-run: تجزیهٔ GIR_FILE بدون تولید مستندات

دستور check (THE CHECK COMMAND)

دستور check مجموعه‌ای از بررسی‌ها را روی فایل درون‌نگری اجرا می‌کند تا اطمینان حاصل شود که API عمومی به‌درستی مستندسازی شده است. این دستور می‌تواند به عنوان بخشی از یک مجموعه آزمون استفاده شود.

gi-docgen check [ OPTIONS ] [ GIR_FILE ]

گزینه‌ها:

--config=FILE: استفاده از فایل پیکربندی پروژه داده‌شده
--add-include-path=PATH: افزودن یک دایرکتوری به مسیری که پویشگر برای یافتن فایل‌های GIR از آن استفاده می‌کند. می‌تواند چندین بار برای مشخص کردن چندین دایرکتوری استفاده شود

دستور serve (THE SERVE COMMAND)

دستور serve یک مرجع API تولید کرده و آن را با استفاده از یک کارساز محلی HTTP ارائه می‌دهد.

gi-docgen serve [ OPTIONS ] [ GIR_FILE ]

دستور serve فایل GIR داده‌شده و وابستگی‌های آن را تجزیه کرده و یک مرجع API برای فضای نام موجود در داده‌های درون‌نگری می‌سازد. پس از ساخت موفقیت‌آمیز مرجع، gi-docgen یک کارساز محلی HTTP را که به دایرکتوری خروجی اشاره دارد، راه‌اندازی می‌کند.

گزینه‌ها:

--bind=ADDRESS: استفاده از آدرس داده‌شده برای کارساز HTTP؛ مقدار پیش‌فرض 127.0.0.1 است
--port=PORT: استفاده از درگاه داده‌شده برای کارساز HTTP؛ مقدار پیش‌فرض 8080 است

دستور help (THE HELP COMMAND)

دستور help راهنمای خط فرمان را چاپ می‌کند. اگر هنگام فراخوانی gi-docgen هیچ دستور یا گزینه‌ای را مشخص نکنید، دستور help به‌طور ضمنی اجرا خواهد شد.

gi-docgen help [ OPTIONS ] [ COMMAND ]

اگر هیچ دستوری مشخص نشود، help فهرست دستورها را چاپ می‌کند.

اگر دستوری مشخص شود، help راهنمای خط فرمان آن برنامه را چاپ می‌کند.