نام (NAME)

fpdoc - سازنده مستندات یونیت‌های پاسکال FPC

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

fpdoc --input=inputcommand [--output=output] [--format=fmt] [--descr=descriptionfile] [--package=packagename] [گزینه‌ها]

توضیحات (DESCRIPTION)

fpdoc فایل سورس یونیت Free Pascal را پویش کرده و برای آن مستندات تولید می‌کند. مستندات می‌توانند در قالب‌های مختلفی تولید شوند (در حال حاضر HTML و LaTeX). این ابزار می‌تواند فایل‌های توضیحات مختلفی را بخواند که حاوی شرح نمادهای گوناگون موجود در فایل یونیت هستند.

نحوه استفاده (USAGE)

می‌توانید fpdoc را با تنها آرگومان‌های ضروری 'input' و 'package' فراخوانی کنید. این دستور باید دست‌کم حاوی نام فایل یونیتی باشد که باید برای آن مستندات تولید شود و همچنین نام بسته‌ای که یونیت به آن تعلق دارد.

گزینه‌ها (OPTIONS)

fpdoc دارای چندین گزینه است که بیشتر آن‌ها اختیاری هستند و در بیشتر موارد مقادیر پیش‌فرض استفاده می‌شوند.

--content: این گزینه به fpdoc می‌گوید که یک فایل محتوا (content file) تولید کند. یک فایل محتوا شامل فهرستی از تمام لنگرهای (برچسب‌های) ممکن در فایل مستندات تولیدشده است و می‌تواند برای ایجاد پیوندهای متقابل در مستندات یونیت‌های مختلف با استفاده از گزینه --import به کار رود.
--cputarget=value: این گزینه به fpdoc مشخص می‌کند که مستندات برای چه پردازنده‌ای تولید شوند. این کار صرفاً ماکروهای مناسب پردازنده را تعریف می‌کند.
--descr=descfile: این گزینه نام فایل توضیحات descfile را مشخص می‌کند که حاوی مستندات واقعی یونیت است. این گزینه می‌تواند چندین بار برای چندین فایل توضیحات تکرار شود.
--descr-dir=dir: این گزینه نام دایرکتوری حاوی فایل‌های توضیحات XML با نام dir را مشخص می‌کند. این گزینه می‌تواند چندین بار برای چندین دایرکتوری توضیحات تکرار شود. این گزینه معادل با مشخص کردن تمامی فایل‌های موجود در دایرکتوری با گزینه --descr است.
--dont-trim: این گزینه به fpdoc می‌گوید که فاصله‌های خالی (whitespace) را در فایل‌های XML حذف نکند. به‌طور پیش‌فرض، فاصله‌های خالی از ورودی حذف می‌شوند که می‌تواند اثرات نامطلوبی مثلاً در تگ‌های PRE داشته باشد.
--dry-run: این گزینه به fpdoc می‌گوید که هیچ خروجی‌ای تولید نکند، بلکه فقط تمام ورودی‌ها را پردازش و تجزیه کند. از این گزینه می‌توان به همراه گزینه verbose برای بررسی خطاهای باقی‌مانده در مستندات یا موارد جاافتاده استفاده کرد.
--format=fmt: قالبی (فرمت) با نام fmt را مشخص می‌کند که مستندات در آن تولید خواهند شد. در حال حاضر قالب‌های زیر شناخته شده‌اند:

chm: قالب CHM با نام‌گذاری فایل سازگار با 8.3، عمدتاً برای ویندوز.
dxml: خروجی XML سازگار با Delphi.
htm: قالب HTML با نام‌گذاری فایل سازگار با 8.3.
html: قالب HTML با نام‌های فایل طولانی.
ipf: خروجی IPF (قالب OS/2، قابل استفاده با docview از fpGUI).
xhtml: قالب XHTML با نام‌های فایل طولانی.
latex: قالب LaTeX، که از استایل fpc.sty مورد استفاده در مستندات Free Pascal بهره می‌برد.
man: خروجی صفحات راهنمای man (صفحات راهنمای یونیکس، یک صفحه برای هر شناسه).
rtf: خروجی RTF.
txt: خروجی متنی ساده.
xml-struct: قالب XML ساختاریافته.

--help: نمایش خلاصه گزینه‌های خط فرمان.
--hide-protected: به‌طور پیش‌فرض، مستندات شامل توضیحات و فهرست فیلدها و متدهای محافظت‌شده (protected) در کلاس‌ها یا اشیا هستند. این گزینه این رفتار را تغییر می‌دهد؛ در صورت مشخص شدن، هیچ مستنداتی برای این متدها تولید نخواهد شد. توجه داشته باشید که متدها یا ویژگی‌های عمومی (public) که به این متدهای محافظت‌شده ارجاع می‌دهند، دارای پیوند نامعتبر و معلق خواهند بود.
--html-search=link: مدخلی برای صفحه جستجوی HTML در آدرس link به هدرهای صفحات HTML تولیدشده اضافه می‌کند. هیچ صفحه جستجویی همراه برنامه ارائه نمی‌شود و باید توسط کاربر ایجاد و فراهم گردد.
--import=impfile: یک فایل محتوا به نام impfile را از یک مجموعه مستندات دیگر وارد می‌کند. این کار می‌تواند برای رفع ارجاعات به عناصر درون آن فایل مستندات دیگر به کار رود.
--input=cmd: این گزینه به fpdoc می‌گوید که از چه فایل ورودی استفاده شود. آرگومان cmd می‌تواند صرفاً یک نام فایل باشد، اما می‌تواند یک خط فرمان کامل کامپایلر با گزینه‌های مربوط به پویش سورس پاسکال نیز باشد: تعاریف، فایل‌های include و گزینه‌های نحوی، همان‌گونه که هنگام کامپایل به کامپایلر Free Pascal داده می‌شوند. اگر از یک دستور کامل استفاده شود، باید درون نقل‌قول تکی یا جفتی قرار گیرد تا پوسته آن را تکه‌تکه نکند. امکان تعیین چندین دستور ورودی وجود دارد؛ این دستورات یکی‌یکی بررسی شده و برای هر یک از آن‌ها مستندات تولید خواهد شد.
--input-dir=dir: این گزینه به fpdoc می‌گوید که تمامی فایل‌های .pas و .pp را در دایرکتوری به نام dir به عنوان فایل‌های ورودی به مستندساز اضافه کند. این گزینه معادل با مشخص کردن تمامی فایل‌های موجود در دایرکتوری با دستور --input است.
--lang=language: زبان فایل خروجی را مشخص می‌کند. این گزینه عمدتاً رشته‌های مورد استفاده برای هدرها را در بخش‌های مختلف فایل‌های مستندات تعیین می‌کند (به‌طور پیش‌فرض انگلیسی هستند). در حال حاضر گزینه‌های معتبر عبارتند از:

de: آلمانی.
fr: فرانسوی.
nl: هلندی.

--latex-extension=ext: پسوند مورد استفاده برای فایل LaTeX را روی ext تنظیم می‌کند؛ مقدار پیش‌فرض .tex است (شامل نقطه .).
--latex-highlight: ابزار برجسته‌سازی نحوی داخلی LaTeX را فعال می‌کند. این قابلیت هنوز پیاده‌سازی نشده است. به‌طور پیش‌فرض، برجسته‌سازی نحوی توسط بسته syntax همراه fpc ارائه می‌شود.
--mo-dir=dir: این گزینه به fpdoc می‌گوید که فایل‌های ترجمه مورد استفاده برای بین‌المللی‌سازی خروجی fpdoc را در کجا پیدا کند.
--ostarget=value: این گزینه به fpdoc می‌گوید که مستندات را برای چه سیستم‌عاملی تولید کند. این کار صرفاً ماکروهای مناسب سیستم‌عامل را تعریف می‌کند.
--output=name: این گزینه به fpdoc می‌گوید که فایل خروجی در کجا باید تولید شود. نحوه تفسیر این گزینه بستگی به قالب مورد استفاده دارد. برای latex، نام name به عنوان نام فایل برای فایل tex در نظر گرفته می‌شود. برای تمامی قالب‌های دیگر، name به عنوان دایرکتوری‌ای تفسیر می‌شود که تمام فایل‌های مستندات در آن نوشته خواهند شد. اگر دایرکتوری از قبل وجود نداشته باشد، ایجاد خواهد شد. به‌طور استاندارد این مقدار برابر با نام بسته است.
--package=packagename: نام بسته را تعیین می‌کند. تمام یونیت‌ها به عنوان بخشی از packagename مستندسازی می‌شوند که همچنین نام فایل یا دایرکتوری خروجی پیش‌فرض نیز هست. هنگام مستندسازی، تنها گره‌های مستنداتی که درون یک گره بسته با این نام باشند در نظر گرفته خواهند شد.
--parse-impl: (آزمایشی) تلاش برای تجزیه بخش پیاده‌سازی (implementation) یک یونیت؛ این مورد می‌تواند برای بررسی نحوی استفاده شود.
--project=file: این گزینه به fpdoc می‌گوید که تمامی گزینه‌ها را از یک فایل پروژه بخواند. این فایل یک فایل XML است؛ لطفاً برای اطلاعات بیشتر در مورد فرمت این فایل به مستندات مراجعه کنید.
--show-private: به‌طور پیش‌فرض، هیچ مستنداتی برای متدها یا فیلدهای خصوصی (private) تولید نمی‌شود. این گزینه باعث می‌شود که fpdoc برای این متدها نیز مستندات تولید کند.
--verbose: به‌طور پیش‌فرض، خروجی fpdoc محدود و مختصر است. این گزینه به fpdoc می‌گوید که اطلاعات بیشتری درباره آنچه انجام می‌دهد ارائه دهد.
--warn-no-node: اگر این گزینه مشخص شود، fpdoc در صورتی که گره توضیحی برای شناسه‌ای که در حال مستندسازی آن است پیدا نکند، یک هشدار صادر می‌کند.
--write-project=file: اگر این گزینه مشخص شود، fpdoc یک فایل پروژه fpdoc (در نام فایل مشخص‌شده) متناظر با گزینه‌های خط فرمان داده‌شده می‌نویسد.

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

: ppc386(1) latex(1) makeskel(1)