autogsdoc - عبر الإنترنت في السحابة

برنامج:

اسم

autogsdoc - مولد وثائق GNUstep API ومحول XML->HTML

موجز

com.autogsdoc [-ملفات اسم الملف] [-إنشاء HTML نعم|لا] [-ينظف نعم|لا] [-قوالب نظيفة
نعم|لا] [-تجاهل التبعيات نعم|لا] [-جعل التبعيات نعم|لا] [-إظهار التبعيات نعم|لا]
[-HeaderDirectory مسار] [- دليل الوثائق مسار] [-معلن موقع] [-مشروع
الاسم] [-المعايير نعم|لا] [-DocumentAllInstanceVariables نعم|لا]
[-DocumentInstanceVariables نعم|لا] [-InstanceVariablesAtEnd نعم|لا] [- قالب الثوابت
اسم الملف] [-FunctionsTemplate اسم الملف] [- قالب وحدات الماكرو اسم الملف] [-TypedefsTemplate
اسم الملف] [-VariablesTemplate اسم الملف] [-مشاريع النظام سلسلة] [-المشاريع المحلية سلسلة]
[- المشاريع dictString] [-فربوز نعم|لا] [-تحذير نعم|لا] [-خريطة الكلمات dictString] [ملفات]

الوصف

أداة autogsdoc هي أداة مساعدة لسطر الأوامر تساعد المطورين على إنتاج مرجع
وثائق واجهات برمجة تطبيقات GNUstep. كما أنه يمكّن المطورين من كتابة وصيانة الآخرين
الوثائق في 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 أو ملف com.gsdoc(7) صفحة الرجل للحصول على معلومات حول
تنسيق جي إس ديوك.

وأخيرا، يمكن تقديم ملفات HTML على سطر الأوامر. إشارات مرجعية إلى أجزاء أخرى من
ستتم إعادة كتابة وثائق التعليمات البرمجية الموجودة داخلها بناءً على ما هو موجود في ملف
المشروع حاليا.

مصدر CODE وضع علامة على

سيقوم محلل الكود المصدري تلقائيًا بإنتاج مستندات GSDoc التي تسرد الطرق الموجودة
الفئات الموجودة في الملفات المصدر، وسوف تتضمن نصًا منسقًا بشكل خاص
التعليقات من الملفات المصدر.

أي تعليق يبدأ بشرطة مائلة و اثنان العلامات النجمية بدلاً من الشرطة المائلة المشتركة والمفردة
تعتبر العلامة النجمية علامة GSDoc لاستخدامها كوصف للفئة أو الطريقة
متابعته. تتم إعادة تنسيق نص التعليق هذا ثم يتم إدراجه في الإخراج.
عندما ترتبط تعليقات متعددة بنفس العنصر، يتم ضمها معًا باستخدام
الخط مقطوع ( ) بين كل إذا لزم الأمر.

يمكن استخدام الأداة بسهولة لتوثيق البرامج والمكتبات، وذلك ببساطة عن طريق إعطائها
اسم الملف المصدر الذي يحتوي على الوظيفة الرئيسية () للبرنامج - فهو يأخذ ملف
تعليقات خاصة من تلك الوظيفة ويتعامل معها بشكل خاص، ويدرجها كملف
القسم الموجود في نهاية الفصل الأول من المستند (يقوم بإنشاء الفصل الأول إذا
ضروري).

مزيد من الخيارات موصوفة في القسم الحجج و الافتراضات أدناه.

EXTRA وضع علامة على

هناك بعض الحالات التي يتم فيها إجراء معالجة إضافية خاصة، خاصة في
تم العثور على التعليق الأول في الملف المصدر، والذي قد تكون منه أجزاء مختلفة من ترميز GSDoc
استخراجها ووضعها في المواقع المناسبة في وثيقة الإخراج -

المصدر التلقائي:
في أي خط حيث المصدر التلقائي: تم العثور عليه، ويتم أخذ باقي السطر كـ a
اسم الملف المصدر الذي سيتم استخدامه بدلاً من افتراض أن كل ملف .h
تستخدم المعالجة ملف .m يحمل نفس الاسم. يمكنك توريد متعددة المصدر التلقائي:
الأسطر التي يعلن فيها ملف الرأس عن العناصر المحددة في ملفات مصدر متعددة.
إذا كان اسم الملف مطلقًا، فسيتم استخدامه تمامًا كما تم توفيره. إذا من ناحية أخرى، فهو أ
المسار النسبي، يبحث البرنامج عن الملف المصدر أولاً بالنسبة إلى الموقع
من ملف الرأس، وإذا لم يتم العثور عليه هناك، نسبة إلى الدليل الحالي الذي
يتم تشغيل autogsdoc، وأخيرًا يتعلق بالدليل المحدد بواسطة ملف
دليل الوثائق افتراضي.


ملخص لمحتوى الوثيقة... يوضع في رأس مخرجات GSDoc.


وصف مؤلف الكود - يمكن تكراره للتعامل مع الحالة التي يكون فيها أ
تحتوي الوثيقة على مؤلفين متعددين. وضعت في رأس إخراج GSDoc. كمساعدة ل
سهولة قراءة المصدر، يتم إجراء بعض المعالجة الإضافية الخاصة المتعلقة به
مؤلف الوثيقة - أي سطر من النموذج "المؤلف: الاسم". '، او بواسطة:
اسم سيتم التعرف على "أو" المؤلف: الاسم "أو" بواسطة: الاسم "و
تحويلها إلى المؤلفة عنصر، ربما يحتوي على البريد الإلكتروني جزء.


تم وضعه في مخرجات GSDoc قبل نهاية نص المستند مباشرةً - وهو المقصود
لاستخدامها في الملاحق والفهرس وما إلى ذلك.


يتم وضعها مباشرة قبل أي وثائق فئة تم إنشاؤها... مخصصة للاستخدام
لتقديم وصف عام لكيفية عمل الكود الذي يتم توثيقه. أي
يتم إدراج وثائق الوظيفة الرئيسية () للبرنامج كقسم في النهاية
من هذا الفصل.


حقوق الطبع والنشر لمحتوى المستند ... موضوعة في رأس مخرجات GSDoc.
للمساعدة في سهولة قراءة المصدر، يتم إجراء بعض المعالجة الإضافية الخاصة
تم تنفيذه - سيتم التعرف على أي سطر من النموذج "نص حقوق الطبع والنشر (C)" وتحويله
ل نسخة جزء.


تاريخ مراجعة الوثيقة... يوضع في رأس مخرجات GSDoc. لو
تم حذف هذا، وستحاول الأداة إنشاء قيمة من علامة تاريخ RCS (if
متاح).


أدرجت في الوثيقة في بداية النص... المقصود منها توفيرها
صفحات المقدمة أو المحتويات وما إلى ذلك.


عنوان الوثيقة... يوضع في رأس مخرجات GSDoc. إذا تم حذف هذا
ستقوم الأداة بإنشاء عنوان خاص بها (ربما سيئًا) - لذا يجب عليك تضمين هذا
الترميز يدويا.


معرف إصدار المستند ... يوضع في رأس مخرجات GSDoc. لو
تم حذف هذا، وستحاول الأداة إنشاء قيمة من علامة مراجعة RCS (if
متاح).

NB يمكن استخدام العلامات الموصوفة للتو ضمن وثائق الفئة أو الفئة أو البروتوكول
... إذا كان الأمر كذلك، فسيتم استخراجه وتغليفه حول بقية الوثائق الخاصة بالفئة
كفصل الفصل. عادةً ما يتم إدراج بقية وثائق الفصل في ملف
نهاية الفصل، ولكن يمكن استبداله بدلاً من ذلك مستعار-
عنصر داخل عنصر.

METHOD وضع علامة على

في التعليقات المستخدمة لتوفير نص لوصف الطريقة، تكون العلامات التالية هي:
تمت إزالته من النص والتعامل معه بشكل خاص -


تم وضع علامة على الطريقة باعتبارها المُهيئ المعين للفئة.


تم وضع علامة على الطريقة باعتبارها إحدى الفئات الفرعية التي يجب أن تتجاوزها (على سبيل المثال، Abstract
طريقة).


تم وضع علامة على الطريقة على أنها إحدى الفئات الفرعية التي يجب أن تكون عليها لا تجاوز.


تتم إزالة العلامات من الوصف ووضعها بعد في إخراج GSDoc -
بحيث توصف الطريقة بأنها مطابقة (أو غير مطابقة) للمحدد
المعايير.

الآلي وضع علامة على

بشكل عام، تتم إعادة تنسيق النص الموجود في التعليقات لتوحيده ووضع مسافة بادئة له بشكل جيد ...
إعادة التنسيق هي ليست يتم تنفيذها على أي نص داخل عنصر. عندما يكون النص
بعد إعادة تنسيقها، يتم تقسيمها إلى "كلمات" مفصولة بمسافات بيضاء والتي يتم بعد ذلك إخضاعها لها
بعض المعالجة الإضافية ...

يتم تضمين بعض الثوابت المعروفة مثل نعم، لا، ولا شيء في ...
وضع علامة على.

يتم تضمين أسماء وسيطات الطريقة ضمن أوصاف الطريقة في ...
</ فار> العلامات.

يتم تضمين أسماء الطرق (التي تبدأ بعلامة زائد أو ناقص). ...
وضع علامة على. على سبيل المثال، سيتم تغليف "-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
تم تعيين العلم.

قوالب نظيفة
تحدد هذه العلامة ما إذا كان سيتم إزالة ملفات القالب GSDoc مع الملفات الأخرى
الملفات عند تحديد خيار التنظيف. الافتراضي هو عدم إزالتها
... نظرًا لأن هذه القوالب ربما تم إنتاجها يدويًا وتم إدراج البيانات للتو
فيها.

ConstantsTemplate
حدد اسم مستند القالب الذي سيتم تضمين الوثائق المتعلقة بالثوابت فيه
يجب إدراجها من جميع الملفات في المشروع. وهذا مفيد إذا كانت الثوابت في
التعليمات البرمجية المصدر متناثرة حول العديد من الملفات، وتحتاج إلى تجميعها في ملف واحد
مكان. أنت مسؤول عن التأكد من أن مستند القالب الأساسي (الذي
يتم إدراج الوثائق الثابتة الفردية) تحتوي على جميع المعلومات الأخرى التي تخصك
تريد، ولكن كوسيلة راحة، سيقوم autogsdoc بإنشاء قالب بسيط (والذي يمكنك استخدامه
ثم تحرير) لك إذا كان الملف غير موجود. يتم الإدراج على الفور
أمام الى الخلف العنصر (أو إذا لم يكن موجودا، مباشرة قبل نهاية
الجسد العنصر) في القالب.

معلن
حدد المكان الذي سيتم فيه توثيق الرؤوس عند العثور عليها. الاسم الفعلي المنتج
في الوثائق يتم تشكيله عن طريق إلحاق المكون الأخير من اسم ملف الرأس
إلى قيمة هذا الافتراضي. إذا لم يتم تحديد هذا الإعداد الافتراضي، فسيظهر الاسم الكامل لـ
header (كما هو موضح في سطر الأوامر)، مع الإعداد الافتراضي HeaderDirectory
مُسبقًا، يُستخدم. قد يكون الاستخدام النموذجي لهذا هو ""-المؤسسة المعلنة"" عندما
إنشاء وثائق لمكتبة GNUstep الأساسية. وهذا من شأنه أن يؤدي إلى
تشير الوثائق إلى أنه تم الإعلان عن NSString في "Foundation/NSString.h"

DocumentAllInstanceVariables
تسمح لك هذه العلامة بإنشاء وثائق لجميع متغيرات المثيلات. عادة،
سيتم توثيق فقط تلك التي تم الإعلان عنها صراحةً على أنها "عامة" أو "محمية".

DocumentInstanceVariables
تسمح لك هذه العلامة بإيقاف تشغيل التوثيق لمتغيرات المثال بشكل كامل.
عادة، سيتم الإعلان بشكل صريح عن متغيرات المثيلات "العامة" أو "المحمية".
الموثقة.

InstanceVariablesAtEnd
هذه العلامة، إذا تم تعيينها، توجه منشئ HTML لوضع وثائق متغير المثيل
في نهاية الصف، بدلا من البداية. وهذا مفيد إذا كنت تستخدم الكثير من
متغيرات المثيلات المحمية والتي ستكون ذات أهمية ثانوية فقط
المستخدمين العامين للفئة.

دليل الوثائق
يمكن استخدامه لتحديد الدليل الذي سيتم وضع الوثائق التي تم إنشاؤها فيه.
إذا لم يتم تعيين هذا، يتم وضع الإخراج في الدليل الحالي. وهذا الدليل أيضاً
يتم استخدامه كحل أخير لتحديد موقع الملفات المصدر (وليس الرؤوس)، والأهم من ذلك، أنه
يستخدم ك أول و فقط اللجوء لتحديد موقع أي ملفات .gsdoc التي تم تمريرها
سطر الأوامر. أي معلومات المسار المقدمة لهذه الملفات هي إزالة و هم
تم البحث عنها في "DocumentationDirectory" (على الرغم من أنها ربما لم تكن كذلك
يستخرج تلقائيا).

ملفات
يحدد اسم الملف الذي يحتوي على قائمة بأسماء الملفات كمصفوفة قائمة خصائص
(الاسم 1، الاسم 2،...) شكل. إذا كان هذا موجودا، أسماء الملفات في قائمة وسيطة البرنامج
يتم تجاهلها ويتم استخدام الأسماء الموجودة في هذا الملف كقائمة أسماء للمعالجة.

وظائف القالب
حدد اسم مستند القالب الذي سيتم تضمين الوثائق المتعلقة بالوظائف فيه
يجب إدراجها من جميع الملفات في المشروع. وهذا مفيد إذا كان مصدر الوظيفة
الكود منتشر حول العديد من الملفات، وتحتاج إلى تجميعه في مكان واحد. أنت
مسؤول عن التأكد من أن مستند القالب الأساسي (في أي فرد
يتم إدراج وثائق الوظيفة) يحتوي على كافة المعلومات الأخرى التي تريدها، ولكن
كوسيلة راحة، سيقوم autogsdoc بإنشاء قالب بسيط (والذي يمكنك تحريره بعد ذلك)
لك إذا كان الملف غير موجود. يتم الإدراج مباشرة قبل الى الخلف
العنصر (أو إذا لم يكن موجودا، مباشرة قبل نهاية الجسد عنصر) في
القالب.

إنشاء HTML
يمكن استخدامه لتحديد ما إذا كان سيتم إنشاء مخرجات HTML. الإعدادات الافتراضية هي نعم.

دليل الرأس
يمكن استخدامه لتحديد الدليل الذي سيتم البحث فيه عن ملفات الرأس. عند توريدها،
يتم إضافة هذه القيمة مسبقًا إلى أسماء الرؤوس النسبية، وإلا فإن أسماء الرؤوس النسبية
يتم تفسيرها بالنسبة إلى الدليل الحالي. ملفات الرأس المحددة على أنها مطلقة
لا تتأثر المسارات بهذا الافتراضي.

تجاهل التبعيات
قيمة منطقية يمكن استخدامها لتحديد أن البرنامج يجب أن يتجاهل الملف
أوقات التعديل وإعادة إنشاء الملفات على أي حال. المقدمة للاستخدام جنبا إلى جنب مع
نظام "الصنع"، والذي من المتوقع أن يدير فحص التبعية بنفسه.

المشاريع المحلية
يتم استخدام هذه القيمة للتحكم في التضمين التلقائي للمشاريع الخارجية المحلية في
نظام الفهرسة لتوليد المراجع التبادلية في مخرجات الوثيقة النهائية. لو
اضبط على "لا شيء"، فلن يتم إجراء أي مراجع للمشروع المحلي، وإلا فإن "المحلي"
يتم البحث بشكل متكرر في دليل وثائق GNUstep عن الملفات ذات الامتداد ".igsdoc"
ملحق، ويتم استخدام معلومات الفهرسة من تلك الملفات. قيمة هذا
يتم استخدام السلسلة أيضًا لإنشاء أسماء الملفات في المرجع الترافقي ... إذا كان ملفًا
سلسلة فارغة، من المفترض أن يكون المسار المطلوب استخدامه عبارة عن ملف في نفس الدليل حيث يوجد ملف
تم العثور على ملف igsdoc، وإلا فسيتم استخدامه كبادئة للاسم الموجود في الفهرس. ملحوظة:
سيتم تنفيذ المشاريع المحلية التي تحمل نفس اسم المشروع الذي يتم توثيقه حاليًا ليست
أن تشملها هذه الآلية. إذا كنت ترغب في تضمين مثل هذه المشاريع، فيجب عليك القيام بذلك
صراحة باستخدام - المشاريع

MacrosTemplate
حدد اسم مستند القالب الذي يجب تضمين الوثائق المتعلقة بوحدات الماكرو فيه
يتم إدراجها من جميع الملفات في المشروع. يعد هذا مفيدًا إذا كان كود الماكرو متناثرًا
حول العديد من الملفات، وتحتاج إلى تجميعها في مكان واحد. أنت مسؤول عن
التأكد من أن مستند القالب الأساسي (الذي يتم فيه توثيق وثائق الماكرو الفردية).
(يتم إدراجه) يحتوي على كافة المعلومات الأخرى التي تريدها، ولكن من باب التيسير
سيقوم autogsdoc بإنشاء قالب بسيط (والذي يمكنك تحريره بعد ذلك) لك إذا كان
الملف غير موجود. يتم الإدراج مباشرة قبل الى الخلف العنصر (أو إذا
هذا غير موجود، مباشرة قبل نهاية الجسد
العنصر) في القالب.

MakeDependeency
اسم الملف الذي سيتم استخدامه لإخراج معلومات التبعية للتكوين. هذا سوف يستغرق
نموذج لإدراج جميع ملفات الرأس والمصدر المعروفة للمشروع باعتبارها تبعيات لـ
اسم المشروع (انظر "المشروع").

مشروع
يمكن استخدامه لتحديد اسم هذا المشروع... يحدد اسم الفهرس
تم إنتاج الملف المرجعي كجزء من الوثائق لتوفير المعلومات التمكينية
مشاريع أخرى للإشارة إلى العناصر الموجودة في هذا المشروع.

مشاريع الشركة
قد يتم توفير هذه القيمة كقاموس يحتوي على المسارات إلى ملف igsdoc
ملفات الفهرس/المرجع التي تستخدمها المشاريع الخارجية، بالإضافة إلى القيم التي سيتم استخدامها للتعيين
أسماء الملفات الموجودة في الفهارس. على سبيل المثال، إذا كان ملف فهرس المشروع (igsdoc).
يقول أن الفئة "Foo" موجودة في الملف "Foo"، والمسار المرتبط بها
فهرس المشروع هذا هو "/usr/share/doc/proj"، ثم قد يشير مخرجات html التي تم إنشاؤها
الفصل موجود في '/usr/share/doc/prj/Foo.html' . لاحظ أنه قد يكون القاموس
المعطى في سطر الأوامر باستخدام تنسيق PropertyList القياسي (وليس XML
تنسيق OS X)، باستخدام الفواصل المنقوطة كفواصل أسطر، وإحاطتها بمفردة
يقتبس.

إظهار التبعيات
قيمة منطقية يمكن استخدامها لتحديد أن البرنامج يجب أن يسجل الملفات
يتم تجديدها بسبب اعتمادها على ملفات أخرى.

المعايير
قيمة منطقية تستخدم لتحديد ما إذا كان يجب على البرنامج إدراج معلومات حوله
الامتثال للمعايير في الوثائق. يجب استخدام هذا فقط عندما
توثيق مكتبات وأدوات GNUstep نفسها حيث تفترض أن الكود
يعد التوثيق جزءًا من GNUstep وربما يتوافق مع معيار OpenStep
أو يطبق أساليب متوافقة مع MacOS-X.

مشاريع النظام
يتم استخدام هذه القيمة للتحكم في التضمين التلقائي لمشاريع النظام الخارجية في
نظام الفهرسة لتوليد المراجع التبادلية في مخرجات الوثيقة النهائية. لو
تم ضبطه على "لا شيء"، فلن يتم إجراء أي مراجع لمشروع النظام، وإلا فإن "النظام"
يتم البحث بشكل متكرر في دليل وثائق GNUstep عن الملفات ذات الامتداد ".igsdoc"
ملحق، ويتم استخدام معلومات الفهرسة من تلك الملفات. قيمة هذا
يتم استخدام السلسلة أيضًا لإنشاء أسماء الملفات في المرجع الترافقي ... إذا كان ملفًا
سلسلة فارغة، من المفترض أن يكون المسار المطلوب استخدامه عبارة عن ملف في نفس الدليل حيث يوجد ملف
تم العثور على ملف igsdoc، وإلا فسيتم استخدامه كبادئة للاسم الموجود في الفهرس. ملحوظة:
سيتم تنفيذ مشاريع النظام التي تحمل نفس اسم المشروع الذي يتم توثيقه حاليًا ليست
أن تشملها هذه الآلية. إذا كنت ترغب في تضمين مثل هذه المشاريع، فيجب عليك القيام بذلك
صراحة باستخدام - المشاريع

TypedefsTemplate
حدد اسم مستند القالب الذي يجب تضمين الوثائق المتعلقة بتعريفات الكتابة فيه
يتم إدراجها من جميع الملفات في المشروع. يعد هذا مفيدًا إذا كان كود مصدر typedef كذلك
متناثرة حول العديد من الملفات، وتحتاج إلى تجميعها في مكان واحد. أنت
مسؤول عن التأكد من أن مستند القالب الأساسي (في أي فرد
يتم إدراج وثائق typedef) على كافة المعلومات الأخرى التي تريدها، ولكن كما
سيقوم autogsdoc الملائم بإنشاء قالب بسيط (والذي يمكنك تحريره بعد ذلك) له
لك إذا كان الملف غير موجود. يتم الإدراج مباشرة قبل الى الخلف
العنصر (أو إذا لم يكن موجودا، مباشرة قبل نهاية الجسد عنصر) في
القالب.

Up سلسلة تُستخدم لتوفير الاسم الذي سيتم استخدامه في الرابط "up" من GSDoc الذي تم إنشاؤه
وثائق. يجب أن يكون هذا عادةً اسم الملف الذي يحتوي على فهرس الملف
محتويات المشروع. إذا كان هذا مفقودًا أو تم ضبطه على سلسلة فارغة، فلا يوجد "up"
سيتم توفير الرابط في الوثائق.

VariablesTemplate
حدد اسم مستند القالب الذي سيتم تضمين الوثائق المتعلقة بالمتغيرات فيه
يجب إدراجها من جميع الملفات في المشروع. وهذا مفيد إذا كان مصدر متغير
الكود منتشر حول العديد من الملفات، وتحتاج إلى تجميعه في مكان واحد. أنت
مسؤول عن التأكد من أن مستند القالب الأساسي (في أي فرد
يتم إدراج وثائق المتغير) يحتوي على كافة المعلومات الأخرى التي تريدها، ولكن
كوسيلة راحة، سيقوم autogsdoc بإنشاء قالب بسيط (والذي يمكنك تحريره بعد ذلك)
لك إذا كان الملف غير موجود. يتم الإدراج مباشرة قبل الى الخلف
العنصر (أو إذا لم يكن موجودا، مباشرة قبل نهاية الجسد عنصر) في
القالب.

مطنب
قيمة منطقية تُستخدم لتحديد ما إذا كنت تريد إخراج تصحيح/تحذير مطول
أنتجت.

حذر
قيمة منطقية تُستخدم لتحديد ما إذا كنت تريد إخراج تحذير قياسي (على سبيل المثال، تقرير عن
طرق غير موثقة).

خريطة الكلمات
هذه القيمة عبارة عن قاموس يستخدم لتعيين المعرفات/الكلمات الرئيسية الموجودة في الملفات المصدر
إلى كلمات أخرى. بشكل عام، لن تضطر إلى استخدام هذا، ولكنه مفيد في بعض الأحيان
لتجنب الخلط بين المحلل اللغوي واستخدام وحدات الماكرو للمعالج المسبق للغة C. أنت تستطيع
إعادة تعريف الماكرو بشكل فعال إلى شيء أقل إرباكًا. القيمة التي قمت بتعيينها
يجب أن يكون المعرف واحدًا من - معرف آخر، سلسلة فارغة - القيمة
تم التجاهل، شرطتان مائلتان ('//') - يتم تجاهل بقية السطر. لاحظ أن القاموس
يمكن تقديمها في سطر الأوامر باستخدام تنسيق PropertyList القياسي (وليس تنسيق
XML لنظام OS X)، باستخدام الفواصل المنقوطة كفواصل أسطر، وإحاطتها بمفردة
يقتبس.

وثيقة مشتركة إرتباط

يتم استخدام الإعداد الافتراضي "Up" لتحديد اسم المستند الذي يجب استخدامه كملف
رابط "أعلى" لأية مستندات أخرى مستخدمة. يجب ألا يتضمن هذا الاسم مسارًا أو ملحقًا.
بشكل عام، يجب أن تكون الوثيقة المشار إليها بهذا الإعداد الافتراضي وثيقة GSDoc تم تحريرها يدويًا
والتي يجب أن تحتوي على قسم خلفي يحتوي على فهرس المشروع. على سبيل المثال


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


مرجع مشروعي




مرجع مشروعي

استخدم autogsdoc عبر الإنترنت باستخدام خدمات onworks.net