GTK-דוק משמש לתעד קוד C. הוא משמש בדרך כלל כדי לתעד API הציבורי של ספריות, כגון + GTK וספריות GNOME, אבל גם זה יכול לשמש כדי לתעד קוד יישום.
שים לב שGTK-דוק לא נועד במקור להיות כלי תיעוד למטרות כלליות, כך שהוא יכול להיות קצת מביך להתקנה ולשימוש. לכלי תיעוד למטרות כלליות מלוטש יותר, ייתכן שתרצו להסתכל על Doxygen (http://www.doxygen.org/). עם זאת יש GTK-דוק קצת קוד מיוחד כדי לתעד את האותות ומאפיינים של יישומונים GTK + ושיעורי GObject שכלים אחרים לא יכולים להיות.
GTK-דוק מאפשר התיעוד שלך להיות כתוב ב -2 דרכים:
) משובץ בתוך קוד המקור בהערות במיוחד בתבנית.
או
ב) נוסף לקבצי 'התבנית' שתפוקות GTK-דוק לאחר סריקת כל קבצי הכותרת וניתוח ההצהרות.
מהערות אלה קוד המקור וקבצי תבנית GTK-דוק יוצר מסמך XML DocBook (או SGML), שהפך לאחר מכן ל- HTML. תיעוד HTML שנוצר יכול להיות עיינו בדפדפן אינטרנט רגיל או על ידי שימוש בדפדפן API Devhelp המיוחד (ראה http://developer.imendio.com/wiki/Devhelp).
What חדש בהודעה זו:
- GTK-דוק תומך משנה של markdown (כותרות ורשימות) - ראה
- http://git.gnome.org/browse/gtk-doc/tree/tests/gobject/src/gobject.c
- GTK-דוק אינו מייצר devhelp קבצים ישן יותר. כך יצמצם את דוק
- זמן ודור עובד עבור devhelp & gt;. = 0.11 (שוחרר בשנת 2005)
- שינויים למבנה dir מחוץ למקור שנגרמו שבר לפרויקטים באמצעות
- DOC_SOURCE_DIR עם נתיב יחסי (לbuilddir). מומלץ להשתמש
- DOC_SOURCE_DIR = $ (top_srcdir) / src / xxx.
- שינויים
- 590,927: AM_SILENT_RULES תמיכה בצעדים דוק-לבנות
- 617,121: / * & lt; פרטי & gt; * / הצהרות בenums עדיין מוצגות
- 627,758: דרך להתעלם סמל
- 639,145: תחביר קצרנות לכותרות
- 644,291: הפסקות מנתח Enum במשימה של ')'
- 646,870: HTML_IMAGES כבר לא בEXTRA_DIST
- 648,289:. Gtkdoc-mkdb לא לקמפל
- 648,331:. ציין אפשרויות תואמות עבור 'גולת כותרת' באופן עקבי
- 649,269: gtkdoc-scanobj צריך להגדיר כמה CFLAGS / LDFLAGS
- 650,407: מסמכי מבנים תוך distchecking מייצר אלפי € ביסודות של הצהרת € אונו ?? אזהרות, אז נכשל.
- 652,746: תיעוד של structs התאגרף רגיל נשבר
- 652,764: autotools עדכון config קצת
- 655,711: לסכם פלט depscan ידי חבילה
- 656,453: שיפורי ביצועים (תיקון)
- 656,658: GTK-doc.make: להתקין יעד לא להתקין מסמכים בעת הבנייה בספרייה נפרדת
- 656,773: GTK-דוק לא מצליח למצוא סמל הוכרז כ'const char * '
- 656,946: GTK-דוק מסוגל להתמודד "int הקצר extern '
- 657,377:! Srcdir = builddir בונה להשליך תוכן של tmpl
- תורמים
- Bakaoukas ניקולאוס
- קלוד פרוז ארגון
- דניאל Mustieles
- דוד Necas
- דוד רח"ל ?? כ
- חבייר JardA³n
- חורחה גונזלס
- מריו BlA¤ttermann
- מתיאס Clasen
- MichaA, GA³rny
- שון McCance
- סטפן Sauer (קוסט)
- האם תומפסון
- יעקב Selkowitz
דרישות :
- פרל v5
- libxslt & libxml2 2.3.6
- גיליונותסגנון XSL DocBook
- DocBook XML DTD
- DocBook SGML DTD
- v1.1 או ג'ייד OpenJade 1.3.1
- גיליונותסגנון DSSSL DocBook
תגובות לא נמצא