نام (NAME)

valadoc - ابزار مستندسازی Vala

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

valadoc [OPTION]... FILE...

توضیحات (DESCRIPTION)

برنامه Valadoc یک تولیدکننده مستندات برای تولید مستندات API از کد منبع Vala بر پایه libvala است.

کاربرد:

: valadoc [OPTION???] FILE... - ابزار مستندسازی Vala

گزینه‌های راهنما:

-h, --help: نمایش گزینه‌های راهنما

گزینه‌های برنامه:

-o, --directory=DIRECTORY: دایرکتوری خروجی
-b, --basedir=DIRECTORY: دایرکتوری پایه کد منبع
-D, --define=SYMBOL...: تعریف SYMBOL
--profile=PROFILE: حداقل وابستگی زمان اجرا: 'gobject' (پیش‌فرض) یا 'posix' (حداقل libc)
--enable-experimental: فعال‌سازی ویژگی‌های آزمایشی
--enable-experimental-non-null: فعال‌سازی بهبودهای آزمایشی برای انواع غیر تهی (non-null)
--metadatadir=DIRECTORY...: جستجو برای فایل‌های .metadata مربوط به GIR در DIRECTORY
--girdir=DIRECTORY...: جستجو برای فایل‌های .gir در DIRECTORY
--vapidir=DIRECTORY...: جستجو برای اتصالات (bindings) بسته در DIRECTORY
--pkg=PACKAGE...: شامل کردن اتصال (binding) برای PACKAGE
--driver: نام یک درایور یا مسیر به درایور سفارشی (منسوخ و نادیده گرفته شده)
--importdir=DIRECTORY...: جستجو برای مستندات خارجی در DIRECTORY
--import=PACKAGE...: شامل کردن اتصال (binding) برای PACKAGE
--alternative-resource-dir=DIRECTORY...: دایرکتوری‌های منابع جایگزین
--wiki=DIRECTORY: دایرکتوری ویکی
--deps: افزودن بسته‌ها به مستندات
--doclet=PLUGIN: نام یک doclet موجود یا مسیر به doclet سفارشی
-X, --doclet-arg=ARG: ارسال آرگومان‌ها به doclet
--no-protected: عناصر محافظت‌شده (protected) را از مستندات حذف می‌کند
--internal: عناصر داخلی (internal) را به مستندات می‌افزاید
--private: عناصر خصوصی (private) را به مستندات می‌افزاید
--use-svg-images: تولید نمودارهای تصویری SVG به‌جای PNG
--package-name=NAME: نام بسته
--package-version=VERSION: نسخه بسته
--gir=NAME-VERSION.gir: نام فایل مخزن GObject-Introspection
--version: نمایش شماره نسخه
--force: اجبار در بازنویسی
--fatal-warnings: در نظر گرفتن هشدارها به‌عنوان خطای مهلک
--verbose: نمایش تمام هشدارها
--no-color: غیرفعال کردن خروجی رنگی
--target-glib='MAJOR.MINOR' یا 'auto': نسخه هدف glib برای تولید کد

گزارش باگ‌ها (BUGS)

https://gitlab.gnome.org/GNOME/vala/issues

صفحه خانگی یا تماس (HOMEPAGE OR CONTACT)

https://docs.vala.dev

نویسندگان (AUTHORS)

Florian Brosch