در GTK-فیلم کارگردان تهیه کننده استفاده می شود به سند کد C. این است که به طور معمول استفاده می شود به سند API عمومی کتابخانه ها، مانند GTK + و کتابخانه GNOME، اما همچنین می تواند مورد استفاده قرار گیرد به سند کد برنامه.
توجه داشته باشید که GTK-فیلم کارگردان تهیه کننده بود ابتدا در نظر گرفته نمی شود یک ابزار مستندات منظوره، پس از آن می تواند یک کمی بی دست و پا برای راه اندازی و استفاده کنید. برای یک ابزار مستندات منظوره جلا تر شما ممکن است بخواهید به در Doxygen (http://www.doxygen.org/) نگاه کنید. با این حال GTK-فیلم کارگردان تهیه کننده تا به برخی از کد های ویژه به سند سیگنال و خواص ویدجت GTK + و کلاس های GObject که ابزارهای دیگر ممکن است داشته باشد.
GTK-فیلم کارگردان تهیه کننده اجازه می دهد تا اسناد و مدارک خود را به در 2 راه نوشته شود:
الف) جاسازی شده در داخل کد منبع در نظر خاص فرمت شده باشد.
یا
ب) پس از اسکن تمام فایل های هدر و تجزیه ی اظهارات به الگو فایل های که خروجی GTK-DOC اضافه شده.
از این کد منبع و فایل های قالب GTK-فیلم کارگردان تهیه کننده تولید Docbook XML (یا SGML) سند، که پس از آن به HTML تبدیل شده است. مستندات HTML تولید شده را می توان در یک مرورگر وب معمولی و یا با استفاده از مرورگر Devhelp API ویژه مرور (نگاه کنید به http://developer.imendio.com/wiki/Devhelp).
What در این نسخه جدید است :
GTK-DOC پشتیبانی از زیر مجموعه از Markdown (عنوان و فهرست) - ببینید
http://git.gnome.org/browse/gtk-doc/tree/tests/gobject/src/gobject.c
GTK-DOC کند devhelp قدیمی تولید نمی فایل بفروش. این کاهش توضیحات
زمان نسل و برای devhelp ها & gt کار می کند؛ = 0.11 (در سال 2005 منتشر شد).
تغییرات برای خارج از منبع ساخت دیر باعث شکستگی برای پروژه های با استفاده از
DOC_SOURCE_DIR با یک مسیر نسبی (به builddir). توصیه می شود به استفاده از
DOC_SOURCE_DIR = $ (top_srcdir) / SRC / XXX.
تغییرهای
590927: پشتیبانی AM_SILENT_RULES برای توضیحات، ساخت مراحل
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 های بسته بندی
بهبود عملکرد (PATCH): 656453
656658: GTK-doc.make: نصب می کند هدف اسناد نصب کنید در هنگام ساختن در یک دایرکتوری جداگانه
656773: GTK-DOC نتواند برای پیدا کردن یک نماد اعلام کرد به عنوان 'char * به ثابت'
656946: GTK-DOC قادر به انجام 'هوشمند کوتاه در خارج'
657377: srcdir = builddir ایجاد محتویات tmpl دور
همکاران
Bakaoukas Nikolaos
کلود Paroz
دانیل Mustieles
دیوید Necas
دیوید NEA؟ به عنوان
خاویر JardA³n
خورخه گونزالس
ماریو BlA¤ttermann
ماتیاس Clasen
MichaA، GA³rny
شان McCance
استفان SAUER (Kost)
اراده تامپسون
Yaakov Selkowitz
در مورد نیاز:
در پرل V5
libxslt و libxml2 برای 2.3.6
DocBook XSL صفحهسبکها
DocBook DTD XML
DTD DocBook SGML
جید V1.1 یا OpenJade 1.3.1
DocBook DSSSL صفحهسبکها
نظر یافت نشد