يستخدم
GTK دوك لتوثيق كود C. وعادة ما يتم استخدامه لتوثيق API العام للمكتبات، مثل GTK + والمكتبات GNOME، ولكن يمكن أيضا أن تستخدم لتوثيق رمز التطبيق.
لاحظ أن جتك دوك لم يقصد أصلا ليكون أداة ثائق للأغراض العامة، لذلك يمكن أن يكون محرجا بعض الشيء الإعداد والاستخدام. لأداة ثائق للأغراض العامة أكثر مصقول قد ترغب في النظر في Doxygen (http://www.doxygen.org/). ومع ذلك GTK دوك لديه بعض رمز خاص لتوثيق الإشارات وخصائص GTK + الحاجيات والطبقات GObject الذي قد لا يكون غيرها من الأدوات.
GTK دوك يسمح الوثائق لتكون مكتوبة في 2 طرق:
أ) جزءا لا يتجزأ من داخل شفرة المصدر في تصريحات منسق بشكل خاص.
أو
ب) أضيفت إلى ملفات "قالب" التي مخرجات جتك للوثائق بعد مسح كافة الملفات رأس وتحليل الإعلانات.
من هذه التعليقات شفرة المصدر وملفات قالب GTK دوك يولد دوكبوك XML (أو إس جي إم إل) وثيقة، والتي يتم بعد ذلك تحويلها إلى HTML. يمكن تصفحها وثائق HTML ولدت في متصفح الويب العادي أو باستخدام متصفح API Devhelp خاص (انظر http://developer.imendio.com/wiki/Devhelp).
What هو الجديد في هذا الإصدار :
جتك للوثائق تدعم مجموعة فرعية من تخفيض السعر (عناوين وقوائم) - راجع
http://git.gnome.org/browse/gtk-doc/tree/tests/gobject/src/gobject.c
جتك للوثائق لا تولد devhelp العمر ملفات أكثر من ذلك. هذه التخفيضات وثيقة
الجيل الوقت ويعمل لdevhelp & GT؛ = (أفرج عنه في عام 2005) 0.11.
تسببت التغييرات للخارج المصدر دير بناء الكسر للمشاريع باستخدام
DOC_SOURCE_DIR مع مسار نسبي (لbuilddir). فمن المستحسن استخدام
DOC_SOURCE_DIR = $ (top_srcdir) / SRC / XXX.
التغييرات
590927: دعم AM_SILENT_RULES لDOC-بناء خطوات
617121: / * العلامة & lt؛ خاصة وGT؛ * / الاعلانات في تتضمن التعدادات لا يزال يتم عرض
627758: هناك طريقة لتجاهل رمزا
639145: بناء جملة اختصار للعناوين
644291: التعداد فواصل محلل على تعيين ')'
646870: HTML_IMAGES لم يعد في EXTRA_DIST
648289: gtkdoc-mkdb لا تجمع.
648331: تحديد خيارات متوافقة ل"تسليط الضوء" على الدوام.
649269: gtkdoc-scanobj ينبغي أن تحدد بعض من قواتها الخاصة CFLAGS / LDFLAGS
650407: المباني مستندات حين distchecking تنتج الآلاف من € س لا إعلان founda € ؟؟ تحذيرات، ثم فشل.
652746: توثيق البنيات محاصر سهل كسر
autotools تحديث التكوين قليلا: 652764
655711: تلخيص الانتاج depscan من خلال حزمة
تحسينات الأداء (رقعة): 656453
656658: جتك-doc.make: تثبيت الهدف عدم تثبيت المستندات عند بناء في دليل منفصل
656773: فشل جتك للوثائق العثور على رمز أعلن باسم 'شار * CONST "
656946: جتك للوثائق غير قادر على التعامل مع "كثافة العمليات قصيرة خارجي ..."
657377: srcdir = builddir يبني تجاهل محتويات tmpl
المساهمين
Bakaoukas نيكولاوس
كلود Paroz
دانيال Mustieles
ديفيد Necas
ديفيد نيا ؟؟ كما
خافيير JardA³n
خورخي جونزاليس
ماريو BlA¤ttermann
ماتياس CLASEN
MichaA، GA³rny
شون McCance
ستيفان سوير (KOST)
إرادة طومسون
يعقوب Selkowitz
المتطلبات:
بيرل V5
libxslt وlibxml2 2.3.6
دوكبوك XSL معدات الشكل
دوكبوك XML DTD
دوكبوك إس جي إم إل DTD
اليشم V1.1 أو OpenJade 1.3.1
دوكبوك DSSSL معدات الشكل
لم يتم العثور على التعليقات