نام (NAME)

edoc - تولید مستندات به‌شکل HTML یا قطعه‌های مستندات EEP-48

توضیحات (DESCRIPTION)

این برنامه یک نقطه ورود خط فرمانی به هر دو تابع edoc:application/2 و edoc:files/2 است. همچنین امکان تولید صرفاً قطعه‌های مستندات (doc chunks) بر اساس EEP-48 را (با استفاده از پرچم -chunks) به‌جای مستندات کامل HTML فراهم می‌کند.

edoc -app <app> [-chunks]

ابزار EDoc از طریق edoc:application/2 با مجموعه‌ گزینه‌های پیش‌فرض فراخوانی می‌شود. در صورت تعیین -chunks، تنها قطعه‌های مستندات تولید خواهند شد، نه مستندات کامل HTML.

برای دریافت فهرست کامل گزینه‌ها، این اسکریپت را بدون هیچ آرگومانی اجرا کنید.

edoc -files <erl_file>... [-chunks]

ابزار EDoc از طریق edoc:files/2 با مجموعه‌ گزینه‌های پیش‌فرض فراخوانی می‌شود. در صورت تعیین -chunks، تنها قطعه‌های مستندات تولید خواهند شد، نه مستندات کامل HTML.

برای دریافت فهرست کامل گزینه‌ها، این اسکریپت را بدون هیچ آرگومانی اجرا کنید.