نام (NAME)

doxygen - سامانه مستندسازی برای زبان‌های مختلف برنامه‌نویسی

توضیحات (DESCRIPTION)

Doxygen یک سامانه مستندسازی برای C++، C، Java، Objective-C، IDL (گونه‌های CORBA و Microsoft)، Fortran، Python، VHDL و تا حدودی PHP، C# و D است.

شما می‌توانید از Doxygen به چند روش استفاده کنید:

1) تولید یک فایل پیکربندی الگو*:

: doxygen [-s] -g [configName]

2) به‌روزرسانی یک فایل پیکربندی موجود*:

: doxygen [-s] -u [configName]

3) تولید مستندات با استفاده از یک فایل پیکربندی موجود*:

: doxygen [configName]

4) تولید یک فایل الگو که ساختار و چیدمان مستندات تولیدشده را کنترل می‌کند:

: doxygen -l [layoutFileName]

اگر layoutFileName حذف شود، از DoxygenLayout.xml به عنوان نام فایل استفاده خواهد شد.
اگر از - برای layoutFileName استفاده شود، Doxygen در خروجی استاندارد می‌نویسد.

5) تولید یک فایل شیوه‌نامه (style sheet) الگو برای RTF، HTML یا LaTeX:

: RTF: doxygen -w rtf styleSheetFile
: HTML: doxygen -w html headerFile footerFile styleSheetFile [configFile]
: LaTeX: doxygen -w latex headerFile footerFile styleSheetFile [configFile]

6) تولید یک فایل افزونه‌های RTF:

: RTF: doxygen -e rtf extensionsFile

اگر از - برای extensionsFile استفاده شود، Doxygen در خروجی استاندارد می‌نویسد.

7) مقایسه فایل پیکربندی استفاده‌شده با فایل پیکربندی الگو:

: doxygen -x [configFile]

مقایسه فایل پیکربندی استفاده‌شده با فایل پیکربندی الگو

بدون جایگزینی متغیرهای محیطی یا متغیرهای جایگزین از نوع CMake:

: doxygen -x_noenv [configFile]

8) نمایش فهرستی از ایموجی‌های داخلی (built-in).

: doxygen -f emoji outputFileName

اگر از - برای outputFileName استفاده شود، Doxygen در خروجی استاندارد می‌نویسد.

*) اگر -s مشخص شود، کامنت‌های موارد پیکربندی در فایل تنظیمات حذف خواهند شد.
اگر configName حذف شود، به‌طور پیش‌فرض از 'Doxyfile' استفاده می‌شود.
اگر از - برای configFile استفاده شود، Doxygen پیکربندی را در خروجی استاندارد می‌نویسد یا از ورودی استاندارد می‌خواند.

اگر -q برای اجرای مستندسازی Doxygen استفاده شود، Doxygen آن را به‌گونه‌ای در نظر می‌گیرد که گویی QUIET=YES تنظیم شده است.

-v چاپ رشته نسخه، -V چاپ اطلاعات تکمیلی نسخه

-h،-? چاپ اطلاعات راهنمای استفاده

doxygen -d پرچم‌های اضافی کاربرد را برای اهداف اشکال‌زدایی چاپ می‌کند

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

Doxygen نسخه 1.18.0، حق نشر Dimitri van Heesch 1997-2026

همچنین ببینید (SEE ALSO)

doxywizard(1).