makeskel(1) FPC unit description file generator makeskel(1)

makeskel - تولید فایل توصیف برای fpdoc

makeskel [--descr=filename] [--disable-arguments] [--disable-errors] [--disable-function-results] [--disable-private] [--disable-protected] [--disable-seealso] [--emit-class-separator] [--help] [--lang=language] [--output=filename] [--update] --package=name --input=cmdline

makeskel یک فایل منبع یونیت Free Pascal را پویش کرده و یک فایل توصیف اسکلتی (قالب اولیه) برای آن تولید می‌کند. این برنامه برای تمام شناسه‌های یافت‌شده در بخش interface یونیت، گره‌هایی ایجاد می‌کند؛ هرچند این رفتار با استفاده از برخی گزینه‌ها قابل تنظیم است. همچنین می‌تواند یک فایل XML موجود را به‌روزرسانی کند، که در این صورت تنها برای شناسه‌هایی گره ایجاد می‌کند که تا پیش از آن گره‌ای برایشان وجود نداشته است.

شما می‌توانید makeskel را تنها با آرگومان‌های ضروری input و package فراخوانی کنید. این دستور باید دست‌کم شامل نام فایل یونیتی باشد که باید برای آن مستندات تولید شود، و همچنین نام بسته‌ای که یونیت به آن تعلق دارد. خروجی makeskel به‌طور پیش‌فرض به خروجی استاندارد ارسال خواهد شد.

makeskel گزینه‌های متعددی دارد که اغلب اختیاری هستند و در بیشتر موارد از مقادیر پیش‌فرض استفاده خواهد شد.

این گزینه باید همراه با گزینهٔ update استفاده شود. این گزینه نام یک فایل توصیف descfile را که باید به‌روزرسانی شود، مشخص می‌کند. توجه داشته باشید که فایل باید حاوی XML معتبر باشد، در غیر این صورت به‌روزرسانی با شکست مواجه خواهد شد. این گزینه می‌تواند بیش از یک بار مشخص شود.
اگر این گزینه مشخص شود، makeskel برای آرگومان‌های توابع و رویه‌ها (procedures) گره‌ای ایجاد نخواهد کرد. به‌طور پیش‌فرض، برای توابع و رویه‌ها نیز گره‌های مستندات تولید می‌شوند.
به‌طور پیش‌فرض، هر گره مستندات شامل یک گره errors نیز خواهد بود (به‌جز برای شناسه‌هایی که این مورد برایشان کاربردی ندارد، مانند آرگومان‌های تابع). اگر این گزینه مشخص شود، هیچ گره errors ای تولید نخواهد شد.
به‌طور پیش‌فرض، برای توابع یک گره result جهت توصیف نتیجه تابع تولید می‌شود. اگر این گزینه مشخص شود، هیچ گره نتیجه تابعی تولید نخواهد شد.
به‌طور پیش‌فرض، گره‌های مستندات برای فیلدها یا متدهای خصوصی (private) یک کلاس نیز تولید می‌شوند. اگر این گزینه مشخص شود، از تولید گره برای فیلدها یا متدهای خصوصی صرف‌نظر می‌شود.
به‌طور پیش‌فرض، گره‌های مستندات برای فیلدها یا متدهای حفاظت‌شده (protected) یک کلاس نیز تولید می‌شوند. اگر این گزینه مشخص شود، از تولید گره برای فیلدها یا متدهای حفاظت‌شده صرف‌نظر می‌شود.
اگر این گزینه مشخص شود، یک توضیح (کامنت) قابل مشاهده حاوی نام کلاسی که گره‌های مستندات آن در ادامه می‌آیند، میان گره‌های دو کلاس درج می‌شود تا ناوبری و پیمایش آسان‌تر شود.
یک متن راهنمای کوتاه نمایش داده و خارج می‌شود.
فایل ورودی (منبع) برای پردازش. می‌توان چندین فایل ورودی مشخص کرد. این فرمان می‌تواند شامل گزینه‌های معتبر کامپایلر باشد؛ در حال حاضر گزینه‌های -Fipath (مسیر جستجو) و -dmacro (تعریف ماکرو) شناسایی می‌شوند.
زبان فایل خروجی را تعیین می‌کند. این کار عمدتاً رشته‌های مورد استفاده برای سرآیندها را در بخش‌های گوناگون فایل‌های مستندات تنظیم می‌کند (به‌طور پیش‌فرض انگلیسی هستند). در حال حاضر، گزینه‌های معتبر عبارتند از:
آلمانی.
فرانسوی.
هلندی.
این گزینه به makeskel می‌گوید که خروجی کجا ارسال شود. اگر این گزینه مشخص نشود، خروجی به خروجی استاندارد (صفحه نمایش) فرستاده می‌شود.
این گزینه الزامی است. این گزینه نام بسته را مشخص می‌کند. تمام گره‌ها درون گره‌ای با صفت name برابر با packagename تولید خواهند شد.
حالت به‌روزرسانی را فعال می‌کند. در این حالت، خروجی فایلی خواهد بود که تنها شامل گره‌های ناموجود برای تکمیل مستندات فایل‌های ورودی است. گره‌های موجود باید با آرگومان descr مشخص شوند. توجه داشته باشید که فایل خروجی نباید همان فایل ورودی (توصیف) باشد؛ باید یک فایل جداگانه مشخص شود (یا هیچ فایلی مشخص نشود، که در این حالت خروجی به خروجی استاندارد هدایت می‌شود).

ppc386(1) latex(1) fpdoc(1)
11 November 2004 Free Pascal