autogsdoc - آنلاین در ابر

برنامه:

نام

autogsdoc - تولید کننده اسناد API GNUstep و مبدل XML->HTML

خلاصه

autogsdoc [-فایل ها نام فایل] [-GenerateHtml بله | خیر] [-تمیز بله|نه] [-CleanTemplates
بله|نه] [-نادیده گرفتن وابستگی ها بله|نه] [-Make Dependencies بله|نه] [-نمایش وابستگی ها بله|نه]
[-HeaderDirectory مسیر] [-DocumentationDirectory مسیر] [-اعلام کرد محل] [-پروژه
عنوان] [-استانداردها بله|نه] [-DocumentAllInstanceVariables بله|نه]
[-DocumentInstanceVariables بله | خیر] [-InstanceVariablesAtEnd بله|نه] [-ConstantsTemplate
نام فایل] [-FunctionsTemplate نام فایل] [-MacrosTemplate نام فایل] [-TypedefsTemplate
نام فایل] [-VariablesTemplate نام فایل] [-پروژه های سیستمی رشته] [پروژه های محلی رشته]
[-پروژه ها dictString] [-وبربس بله|نه] [-اخطار کن بله|نه] [-WordMap dictString] [فایل ها]

شرح

ابزار autogsdoc یک ابزار خط فرمان است که به توسعه دهندگان کمک می کند تا مرجع تولید کنند
اسناد برای API های گنو استپ همچنین توسعه دهندگان را قادر می سازد تا موارد دیگر را بنویسند و نگهداری کنند
مستندات در XML و تبدیل آن به HTML. در جزئیات، autogsdoc:

- استخراج نظرات ویژه برای توصیف رابط های عمومی کلاس ها، دسته ها،
پروتکل ها، توابع و ماکروها از کد منبع Objective C (فایل های هدر و
فایل های منبع اختیاری) به فایل های GSDoc XML.

- تبدیل فایل های GSDoc XML، چه از کد منبع تولید شده باشد و چه به صورت دستی توسط
توسعه دهندگان، به HTML.

- شاخص ها را بر اساس مجموعه فایل های GSDoc XML بسازید و آن ها را نیز به HTML تبدیل کنید.

رایج ترین استفاده از این امر اجرای دستور با یک یا چند نام فایل هدر است
آرگومان های ... ابزار به طور خودکار فایل های منبع مربوطه را در همان تجزیه و تحلیل می کند
دایرکتوری به عنوان سربرگ (یا دایرکتوری فعلی، یا دایرکتوری مشخص شده با استفاده از
DocumentationDirectory پیش فرض)، و فایل های GSDoc و HTML را به عنوان خروجی تولید کنید. برای بهترین
نتایج این حالت باید از دایرکتوری حاوی فایل های منبع اجرا شود. (توجه داشته باشید
از آنجایی که C زیرمجموعه ای از Objective C است، این ابزار می تواند برای مستندسازی توابع و
سایر ساختارهای C در منبع C ساده.)

فایل‌های GSDoc نیز ممکن است مستقیماً یا توسط خودشان داده شوند و تبدیل شوند
به HTML. به مستندات GSDoc HTML یا gsdoc(7) صفحه مرد برای اطلاعات در مورد
فرمت GSDoc

در نهایت، فایل های HTML ممکن است در خط فرمان داده شوند. ارجاعات متقابل به بخش های دیگر
اسناد کد موجود در آنها بر اساس آنچه در آن یافت می شود بازنویسی می شود
پروژه در حال حاضر

SOURCE CODE MARKUP

تجزیه کننده کد منبع به طور خودکار اسناد GSDoc را تولید می کند که روش های موجود را فهرست می کند
کلاس‌های موجود در فایل‌های منبع، و شامل متنی از فرمت‌های خاص می‌شود
نظرات از فایل های منبع

هر نظری که با اسلش و شروع شود دو ستاره به جای اسلش معمولی و تک
ستاره، به عنوان نشانه گذاری GSDoc در نظر گرفته می شود تا به عنوان توصیف کلاس یا روش استفاده شود
دنبال آن این متن نظر دوباره قالب بندی می شود و سپس در خروجی درج می شود.
در جایی که نظرات متعدد با یک مورد مرتبط هستند، آنها با a به یکدیگر متصل می شوند
شکست خط ( ) بین هر کدام در صورت لزوم.

این ابزار به راحتی می تواند برای مستندسازی برنامه ها و همچنین کتابخانه ها، به سادگی با دادن آن استفاده شود
نام فایل منبع حاوی تابع main() برنامه - آن را می گیرد
نظرات خاص از آن تابع و آنها را به طور خاص مدیریت می کند و آنها را به عنوان یک درج می کند
بخش در پایان فصل اول سند (فصل اول را ایجاد می کند اگر
ضروری)

گزینه در بخش توضیح داده شده است استدلال و پیش فرض زیر کلیک کنید.

EXTRA MARKUP

مواردی وجود دارد که پردازش اضافی خاصی عمدتاً در آن انجام می شود
اولین نظر در فایل منبع یافت شد، که ممکن است تکه های مختلفی از نشانه گذاری GSDoc از آن باشد
استخراج شده و در مکان های مناسب در سند خروجی قرار می گیرد -

AutogsdocSource:
در هر خطی که AutogsdocSource: یافت می شود، باقی مانده خط به عنوان a در نظر گرفته می شود
نام فایل منبع به جای این فرض که هر فایل .h استفاده شود
پردازش شده از یک فایل .m به همین نام استفاده می کند. شما ممکن است چندین عرضه کنید AutogsdocSource:
خطوطی که یک فایل هدر مواردی را که در چندین فایل منبع تعریف شده اند را اعلام می کند.
اگر نام فایل مطلق باشد، همانطور که ارائه شده استفاده می شود. اگر از طرف دیگر، یک است
مسیر نسبی، نرم افزار ابتدا فایل منبع را نسبت به مکان جستجو می کند
از فایل هدر، و اگر در آنجا یافت نشد، نسبت به دایرکتوری فعلی که در آن وجود دارد
autogsdoc در حال اجرا است و در نهایت نسبت به دایرکتوری مشخص شده توسط
دایرکتوری اسناد به طور پیش فرض


چکیده ای از محتوای سند ... در سر خروجی GSDoc قرار داده شده است.


شرحی از نویسنده کد - ممکن است برای رسیدگی به مواردی که a
سند دارای چندین نویسنده است در سر خروجی GSDoc قرار می گیرد. به عنوان کمکی برای
خوانایی منبع، برخی از پردازش های اضافی خاص مربوط به انجام می شود
نویسنده سند - هر خطی از فرم "نویسنده: نام". "، یا "توسط:
نام "، یا "نویسنده: نام" یا "توسط: نام" شناسایی خواهد شد و
تبدیل به یک نویسنده عنصر، احتمالاً حاوی یک پست الکترونیک عنصر


درست قبل از پایان متن سند - در نظر گرفته شده در خروجی GSDoc قرار می گیرد
برای ضمائم، فهرست و غیره استفاده می شود.


بلافاصله قبل از هر گونه مستندات کلاس ایجاد شده ... قرار داده شده است
برای ارائه توضیحات کلی از نحوه عملکرد کد در حال مستندسازی. هر
مستندات تابع main() یک برنامه به عنوان یک بخش در پایان درج می شود
از این فصل


حق چاپ محتوای سند ... قرار داده شده در سر خروجی GSDoc.
به عنوان کمکی به خوانایی منبع، برخی از پردازش های اضافی خاص است
انجام شده - هر خطی از فرم "متن حق چاپ (C)" شناسایی و تبدیل می شود
به کپی کنید عنصر


تاریخ بازنگری سند ... قرار داده شده در سر خروجی GSDoc. اگر
این حذف شده است، ابزار سعی می کند یک مقدار از تگ RCS Date بسازد (اگر
در دسترس).


درج شده در سند در ابتدای بدن ... در نظر گرفته شده برای ارائه
صفحات معرفی یا مطالب و غیره


عنوان سند ... قرار داده شده در سر خروجی GSDoc. اگر این مورد حذف شود
این ابزار یک عنوان (احتمالاً ضعیف) برای خود ایجاد می کند - بنابراین شما باید این عنوان را وارد کنید
نشانه گذاری به صورت دستی


شناسه نسخه سند ... در سر خروجی GSDoc قرار داده شده است. اگر
این حذف شده است، ابزار سعی می کند یک مقدار از تگ RCS Revision بسازد (اگر
در دسترس).

NB نشانه گذاری که توضیح داده شد ممکن است در مستندات کلاس، دسته یا پروتکل استفاده شود
... اگر چنین است، استخراج شده و به دور بقیه مستندات کلاس پیچیده می شود
به عنوان فصل کلاس بقیه مستندات کلاس معمولاً در درج می شود
پایان فصل، اما ممکن است به جای آن جایگزین شود شبه
عنصر در عنصر

روش MARKUP

در نظراتی که برای ارائه متن برای توضیح روش استفاده می شود، نشانه گذاری زیر است
از متن حذف شده و به طور خاص مدیریت می شود -


این متد به عنوان اولیه ساز تعیین شده برای کلاس علامت گذاری شده است.


این روش به عنوان روشی علامت گذاری می شود که زیر کلاس ها باید لغو شوند (مثلاً یک چکیده
روش).


این روش به عنوان یکی از زیر کلاس‌ها علامت‌گذاری شده است نه لغو کردن


نشانه گذاری از توضیحات حذف شده و قرار می گیرد بعد از آن را در خروجی GSDoc -
به طوری که روش به عنوان منطبق (یا ناسازگار) با مشخص شده توصیف می شود
استانداردها

خودکار MARKUP

به طور کلی، متن در نظرات دوباره قالب بندی می شود تا استاندارد شود و به خوبی آن را تورفتگی ...
قالب بندی مجدد است نه بر روی هر متنی در داخل یک عنصر وقتی متن است
قالب بندی مجدد، به "کلمات" جدا شده با فضای خالی تقسیم می شود که سپس در معرض قرار می گیرند
مقداری پردازش اضافی ...

ثابت های شناخته شده خاصی مانند بله، خیر و صفر در ...
نشانه گذاری

نام آرگومان های متد در توضیحات متد در ...
</ var> نشانه گذاری

نام روش‌ها (با علامت مثبت یا منفی شروع می‌شود) در داخل آن قرار می‌گیرد ...
نشانه گذاری به عنوان مثال "-init" (بدون نقل قول) در یک مرجع GSDoc پیچیده می شود
عنصر برای اشاره به روش init کلاس فعلی یا اگر فقط یک کلاس شناخته شده باشد
یک متد init داشت، به متد آن کلاس اشاره می کرد. به این واقعیت توجه کنید که
نام متد باید با فضای خالی احاطه شود تا شناسایی شود (هر چند یک کاما،
نقطه پایان یا نقطه ویرگول در انتهای مشخص کننده مانند فضای سفید عمل می کند).

تعیین کننده های روش شامل نام کلاس ها (شروع و پایان با براکت مربع)
در محصور شده اند ... نشانه گذاری به عنوان مثال '[NSObject-init]'، یک را ایجاد خواهد کرد
ارجاع به متد init NSObject (یا کلاس مناسب یا هر یک از آن
دسته ها)، در حالی که '[(NSCopying)-copyWithZone:]'، ارجاع به روشی را در
پروتکل NSCopying توجه داشته باشید که هیچ فاصله ای نباید بین پرانتزها ظاهر شود
در این مشخص کننده ها نام پروتکل ها در براکت های گرد قرار می گیرند تا در
براکت های زاویه ای مرسوم، زیرا GSDoc یک زبان XML است و XML زاویه را بررسی می کند
براکت ها مخصوصا

نام توابع (به «()» ختم می‌شود) غیر از «main()» در داخل آن قرار می‌گیرد ...
نشانه گذاری به عنوان مثال "NSLogv()" (بدون نقل قول) در یک GSDoc پیچیده می شود
عنصر مرجع برای اشاره به مستندات تابع NSLog. به این واقعیت توجه کنید
که نام تابع باید با فضای خالی احاطه شود (البته کاما، نقطه پایان یا
نقطه ویرگول در انتهای مشخص کننده نیز به عنوان پایان دهنده فضای خالی عمل می کند).

ادله و پیش فرض ها

این ابزار پیش‌فرض‌های خاص کاربر را می‌پذیرد (که البته می‌توانند به عنوان خط فرمان ارائه شوند
آرگومان‌ها را با اضافه کردن «-» قبل از نام پیش‌فرض و دادن مقدار پس از آن، مانند شکل زیر
-تمیز بله):

تمیزکاری
اگر این مقدار بولی روی YES تنظیم شود، به جای ایجاد مستندات،
ابزار تمام فایل های GSDoc تولید شده در پروژه و تمام فایل های html تولید شده را حذف می کند
از آنها (و همچنین هر چیزی که از فایل های GSDoc لیست شده تولید می شود
به صراحت)، و در نهایت فایل فهرست پروژه را حذف می کند. تنها استثنا در این مورد
آن فایل های GSDoc الگو است (یعنی آنهایی که با استفاده از "-ConstantsTemplate ..." مشخص شده اند،
آرگومان های "-FunctionsTemplate ..." و غیره) حذف نمی شوند مگر اینکه CleanTemplates
پرچم تنظیم شده است

CleanTemplates
این پرچم مشخص می‌کند که آیا فایل‌های GSDoc الگو باید همراه با سایر فایل‌ها حذف شوند
زمانی که گزینه Clean مشخص شده باشد فایل می شود. پیش فرض این است که آنها حذف نشوند
... از آنجایی که ممکن است این الگوها به صورت دستی تولید شده باشند و فقط داده درج شده باشند
در آنها

ConstantsTemplate
نام یک سند الگو را مشخص کنید که در آن مستندات مربوط به ثابت ها وجود دارد
باید از تمام فایل های پروژه درج شود. این مفید است اگر ثابت در
کد منبع در اطراف بسیاری از فایل ها پراکنده شده است، و شما باید آنها را در یک گروه قرار دهید
محل. شما مسئول اطمینان از اینکه سند الگوی اصلی (در آن
مستندات ثابت فردی درج شده است) شامل تمام اطلاعات دیگر شما است
می خواهید، اما به عنوان یک راحتی autogsdoc یک الگوی ساده تولید می کند (که ممکن است
سپس ویرایش) برای شما در صورتی که فایل وجود ندارد. درج بلافاصله انجام می شود
قبل از به عقب عنصر (یا اگر وجود ندارد، بلافاصله قبل از پایان
بدن عنصر) در الگو.

اعلام شد
مشخص کنید که سرصفحه‌ها باید در کجا مستند شوند. نام واقعی تولید شده است
در مستندات با الحاق آخرین جزء نام فایل هدر شکل می گیرد
به مقدار این پیش فرض. اگر این پیش فرض مشخص نشده باشد، نام کامل آن
فایل هدر (همانطور که در خط فرمان ارائه می شود)، با پیش فرض HeaderDirectory
پیش ساخته، استفاده می شود. یک استفاده معمولی از این ممکن است ""-Declared Foundation"" باشد
ایجاد اسناد برای کتابخانه پایه گنو استپ. این منجر به
اسنادی مبنی بر اینکه NSString در "Foundation/NSString.h" اعلام شده است

DocumentAllInstanceVariables
این پرچم به شما امکان می دهد برای همه متغیرهای نمونه اسنادی ایجاد کنید. به طور معمول،
فقط مواردی که صریحاً "عمومی" یا "محافظت شده" اعلام شده اند، مستند خواهند شد.

DocumentInstanceVariables
این پرچم به شما این امکان را می دهد که اسناد را به عنوان مثال متغیرها را به طور کامل خاموش کنید.
معمولاً، متغیرهای نمونه «عمومی» یا «محافظت‌شده» به صراحت اعلام می‌شوند
ثبت شده.

InstanceVariablesAtEnd
این پرچم، اگر تنظیم شود، مولد HTML را هدایت می کند تا مستندات متغیر نمونه را قرار دهد
در پایان کلاس، به جای شروع. اگر زیاد از آن استفاده می کنید این کار مفید است
متغیرهای نمونه محافظت شده ای که فقط مورد توجه ثانویه هستند
کاربران عمومی کلاس

دایرکتوری اسناد
ممکن است برای تعیین دایرکتوری که قرار است اسناد تولید شده در آن قرار گیرد استفاده شود.
اگر این تنظیم نشده باشد، خروجی در دایرکتوری فعلی قرار می گیرد. این دایرکتوری نیز هست
به عنوان آخرین راه حل برای مکان یابی فایل های منبع (نه هدرها) و مهمتر از آن استفاده می شود
به عنوان استفاده می شود اول و فقط به یافتن هر فایل .gsdoc که در آن ارسال می شود متوسل شوید
خط فرمان هر گونه اطلاعات مسیر داده شده برای این فایل ها است حذف و انها هستند
در "DocumentationDirectory" جستجو شده است (حتی اگر اینطور نبوده باشد
خود تولید شده).

فایل ها
نام یک فایل حاوی لیستی از نام فایل ها را به عنوان آرایه لیست خصوصیات مشخص می کند
(نام 1، نام 2، ...) قالب در صورت وجود، نام فایل ها در لیست آرگومان برنامه
نادیده گرفته می شوند و نام های موجود در این فایل به عنوان لیستی از نام ها برای پردازش استفاده می شوند.

قالب توابع
نام یک سند الگو را مشخص کنید که در آن مستندات مربوط به توابع وجود دارد
باید از تمام فایل های پروژه درج شود. اگر منبع تابع باشد، این مفید است
کد در بسیاری از فایل ها پراکنده است و شما باید آن را در یک مکان گروه بندی کنید. شما هستید
مسئول اطمینان از اینکه سند الگوی اصلی (به کدام فرد
مستندات تابع درج شده است) شامل تمام اطلاعات دیگری است که می خواهید، اما
به عنوان یک راحتی autogsdoc یک الگوی ساده ایجاد می کند (که می توانید آن را ویرایش کنید)
برای شما اگر فایل وجود ندارد. درج بلافاصله قبل از به عقب
عنصر (یا اگر وجود ندارد، بلافاصله قبل از پایان بدن عنصر) در
قالب

GenerateHtml
ممکن است برای تعیین اینکه آیا خروجی HTML تولید می شود یا خیر استفاده شود. به طور پیش فرض بله.

HeaderDirectory
ممکن است برای تعیین دایرکتوری مورد جستجو برای فایل‌های هدر استفاده شود. هنگام عرضه،
این مقدار به نام های هدر نسبی اضافه می شود، در غیر این صورت نام های هدر نسبی
نسبت به دایرکتوری فعلی تفسیر می شوند. فایل های سرصفحه به صورت مطلق مشخص شده است
مسیرها تحت تأثیر این پیش فرض قرار نمی گیرند.

نادیده گرفتن وابستگی ها
یک مقدار بولی که ممکن است برای تعیین اینکه برنامه باید فایل را نادیده بگیرد استفاده شود
زمان های اصلاح و به هر حال فایل ها را بازسازی کنید. ارائه شده برای استفاده همراه با
سیستم «ساخت»، که انتظار می رود کنترل وابستگی خود را مدیریت کند.

پروژه های محلی
این مقدار برای کنترل گنجاندن خودکار پروژه های خارجی محلی در آن استفاده می شود
سیستم نمایه سازی برای تولید ارجاعات متقابل در خروجی سند نهایی. اگر
روی "هیچ" تنظیم کنید، سپس هیچ مرجع پروژه محلی انجام نمی شود، در غیر این صورت، "محلی"
دایرکتوری اسناد GNUstep به صورت بازگشتی برای فایل هایی با ".igsdoc" جستجو می شود.
پسوند، و اطلاعات نمایه سازی آن فایل ها استفاده می شود. ارزش این
رشته همچنین برای تولید نام فایل ها در مرجع متقاطع ... در صورتی که یک باشد استفاده می شود
رشته خالی، مسیر مورد استفاده به عنوان یک فایل در همان دایرکتوری فرض می شود که در آن
فایل igsdoc پیدا شد، در غیر این صورت به عنوان پیشوند نام در فهرست استفاده می شود. NB.
پروژه های محلی با همان نام پروژه ای که در حال حاضر مستندسازی می شود نه
تحت این مکانیسم قرار گیرد. اگر مایل به گنجاندن چنین پروژه هایی هستید، باید این کار را انجام دهید
به صراحت با استفاده از -پروژه ها ...

ماکروس قالب
نام یک سند الگو را مشخص کنید که مستندات مربوط به ماکروها باید در آن باشد
از تمام فایل های پروژه درج شود. اگر کد ماکرو پراکنده باشد این کار مفید است
در اطراف بسیاری از فایل ها، و شما باید آن را در یک مکان گروه بندی کنید. شما مسئول هستید
اطمینان از اینکه سند الگوی اصلی (که در آن اسناد کلان فردی وجود دارد
درج شده است) شامل تمام اطلاعات دیگری است که می خواهید، اما برای راحتی
autogsdoc یک الگوی ساده (که می توانید آن را ویرایش کنید) برای شما ایجاد می کند
فایل وجود ندارد. درج بلافاصله قبل از به عقب عنصر (یا اگر
که وجود ندارد، بلافاصله قبل از پایان بدن
عنصر) در الگو.

Make Dependencies
نام فایلی که برای خروجی اطلاعات وابستگی ساخت استفاده می شود. این را خواهد گرفت
فرمی از فهرست کردن همه فایل‌های سربرگ و منبع شناخته شده برای پروژه به عنوان وابستگی
نام پروژه (به "پروژه" مراجعه کنید).

پروژه
ممکن است برای تعیین نام این پروژه استفاده شود ... نام شاخص را تعیین می کند
فایل مرجع تولید شده به عنوان بخشی از مستندات برای ارائه اطلاعات قادر می سازد
پروژه های دیگر برای ارجاع متقابل به موارد موجود در این پروژه.

پروژه ها
این مقدار ممکن است به عنوان یک فرهنگ لغت حاوی مسیرهای igsdoc ارائه شود
فایل‌های فهرست/مرجع مورد استفاده توسط پروژه‌های خارجی، همراه با مقادیری که برای نقشه‌برداری استفاده می‌شوند
نام فایل های موجود در فهرست ها به عنوان مثال، اگر یک فایل فهرست پروژه (igsdoc).
می گوید که کلاس "Foo" در فایل "Foo" و مسیر مرتبط با آن یافت می شود
که شاخص پروژه '/usr/share/doc/proj' است، سپس خروجی html تولید شده ممکن است به
کلاس در '/usr/share/doc/prj/Foo.html' قرار دارد. توجه داشته باشید که یک فرهنگ لغت ممکن است باشد
در خط فرمان با استفاده از قالب استاندارد PropertyList (نه XML
فرمت OS X)، با استفاده از نقطه ویرگول به عنوان جداکننده خط، و محصور کردن آن در تک
نقل قول ها

Show Dependencies
یک مقدار بولی که ممکن است برای مشخص کردن اینکه برنامه باید کدام فایل‌ها را ثبت کند استفاده شود
به دلیل وابستگی آنها به فایل های دیگر در حال بازسازی هستند.

استانداردها
یک مقدار بولی که برای تعیین اینکه آیا برنامه باید اطلاعاتی درباره آن درج کند یا خیر استفاده می شود
مطابقت با استانداردها در مستندات این فقط زمانی باید استفاده شود که
مستندسازی خود کتابخانه‌ها و ابزارهای گنو استپ با فرض اینکه کد
مستند بودن بخشی از GNUstep است و احتمالاً با استاندارد OpenStep مطابقت دارد
یا روش های سازگار با MacOS-X را پیاده سازی می کند.

پروژه های سیستمی
این مقدار برای کنترل گنجاندن خودکار پروژه های خارجی سیستم در آن استفاده می شود
سیستم نمایه سازی برای تولید ارجاعات متقابل در خروجی سند نهایی. اگر
روی "هیچ" تنظیم کنید، سپس هیچ مرجع پروژه سیستم انجام نمی شود، در غیر این صورت، "سیستم"
دایرکتوری اسناد GNUstep به صورت بازگشتی برای فایل هایی با ".igsdoc" جستجو می شود.
پسوند، و اطلاعات نمایه سازی آن فایل ها استفاده می شود. ارزش این
رشته همچنین برای تولید نام فایل ها در مرجع متقاطع ... در صورتی که یک باشد استفاده می شود
رشته خالی، مسیر مورد استفاده به عنوان یک فایل در همان دایرکتوری فرض می شود که در آن
فایل igsdoc پیدا شد، در غیر این صورت به عنوان پیشوند نام در فهرست استفاده می شود. NB.
پروژه های سیستمی با همان نام پروژه ای که در حال حاضر مستند شده است نه
تحت این مکانیسم قرار گیرد. اگر مایل به گنجاندن چنین پروژه هایی هستید، باید این کار را انجام دهید
به صراحت با استفاده از -پروژه ها ...

TypedefsTemplate
نام یک سند الگو را مشخص کنید که مستندات مربوط به typedefs باید در آن گنجانده شود
از تمام فایل های پروژه درج شود. اگر کد منبع typedef باشد این کار مفید است
در بسیاری از فایل ها پراکنده شده است، و شما باید آن را در یک مکان گروه بندی کنید. شما هستید
مسئول اطمینان از اینکه سند الگوی اصلی (به کدام فرد
اسناد typedef درج شده است) شامل تمام اطلاعات دیگری است که می خواهید، اما به عنوان
یک autogsdoc یک الگوی ساده (که می توانید آن را ویرایش کنید) برای آن ایجاد می کند
اگر فایل وجود نداشته باشد. درج بلافاصله قبل از به عقب
عنصر (یا اگر وجود ندارد، بلافاصله قبل از پایان بدن عنصر) در
قالب

Up رشته ای برای تهیه نامی که در پیوند «بالا» از GSDoc تولید شده استفاده می شود
اسناد. این معمولاً باید نام فایلی باشد که حاوی فهرستی از فایل است
محتویات یک پروژه اگر این وجود ندارد یا روی یک رشته خالی تنظیم شده است، «بالا» وجود ندارد
لینک در اسناد ارائه خواهد شد.

VariablesTemplate
نام یک سند الگو را مشخص کنید که در آن مستندات مربوط به متغیرها وجود دارد
باید از تمام فایل های پروژه درج شود. اگر منبع متغیر باشد این مفید است
کد در بسیاری از فایل ها پراکنده است و شما باید آن را در یک مکان گروه بندی کنید. شما هستید
مسئول اطمینان از اینکه سند الگوی اصلی (به کدام فرد
مستندات متغیر درج شده است) شامل تمام اطلاعات دیگری است که می خواهید، اما
به عنوان یک راحتی autogsdoc یک الگوی ساده ایجاد می کند (که می توانید آن را ویرایش کنید)
برای شما اگر فایل وجود ندارد. درج بلافاصله قبل از به عقب
عنصر (یا اگر وجود ندارد، بلافاصله قبل از پایان بدن عنصر) در
قالب

لفظ
یک بولی برای تعیین اینکه آیا می خواهید خروجی اشکال زدایی/اخطار کامل باشد یا خیر استفاده می شود
تولید شده.

هشدار
یک بولی برای تعیین اینکه آیا می خواهید خروجی هشدار استاندارد (مثلا گزارش از
روش های غیر مستند) تولید شده است.

WordMap
این مقدار یک فرهنگ لغت است که برای ترسیم شناسه ها/کلمات کلیدی موجود در فایل های منبع استفاده می شود
به کلمات دیگر به طور کلی شما مجبور به استفاده از این نخواهید بود، اما گاهی اوقات مفید است
برای جلوگیری از سردرگمی تجزیه کننده با استفاده از ماکروهای پیش پردازنده C. تو می توانی
به طور موثر کلان را به چیزی کمتر گیج کننده دوباره تعریف کنید. ارزشی که شما از آن ترسیم می کنید
شناسه to باید یکی از - یک شناسه دیگر، یک رشته خالی - مقدار باشد
نادیده گرفته شد، دو اسلش ('//') - بقیه خط نادیده گرفته می شود. توجه داشته باشید که یک فرهنگ لغت
ممکن است با استفاده از قالب استاندارد PropertyList در خط فرمان داده شود (نه
فرمت XML OS X)، با استفاده از نقطه ویرگول به عنوان جداکننده خط، و محصور کردن آن در تک
نقل قول ها

INTER-DOCUMENT پیوند

پیش‌فرض «Up» برای تعیین نام سندی که باید به‌عنوان سند استفاده شود، استفاده می‌شود
پیوند "بالا" برای سایر اسناد استفاده شده. این نام نباید شامل مسیر یا پسوند باشد.
به طور کلی، سندی که با این پیش‌فرض به آن اشاره می‌شود باید یک سند GSDoc با دست ویرایش شده باشد
که باید یک بخش پشتی حاوی نمایه پروژه داشته باشد. به عنوان مثال


<!DOCTYPE gsdoc PUBLIC "-//GNUstep//DTD gsdoc 1.0.3//EN"
"http://www.gnustep.org/gsdoc-1_0_3.xml">


مرجع پروژه من




مرجع پروژه من

از autogsdoc به صورت آنلاین با استفاده از خدمات onworks.net استفاده کنید