GTK-Doc จะใช้ในการจัดทำเอกสารรหัส C มันมักจะใช้เพื่อจัดทำเอกสารประชาชน API ของห้องสมุดเช่นดี + และห้องสมุด GNOME แต่ก็ยังสามารถใช้ในการจัดทำเอกสารรหัสโปรแกรม
โปรดทราบว่า GTK-หมอไม่ได้ตั้งใจเดิมที่จะเป็นเครื่องมือที่มีเอกสารทั่วไปเพื่อที่จะสามารถเป็นบิตที่น่าอึดอัดใจในการติดตั้งและการใช้งาน สำหรับเครื่องมือเอกสารขัดวัตถุประสงค์ทั่วไปคุณอาจต้องการที่จะมองไปที่ Doxygen (http://www.doxygen.org/) อย่างไรก็ตาม GTK-Doc มีรหัสพิเศษเพื่อจัดทำเอกสารการส่งสัญญาณและคุณสมบัติของเครื่องมือที่ดี + และการเรียน GObject เครื่องมืออื่น ๆ ที่อาจจะไม่ได้
GTK-Doc ช่วยให้เอกสารของคุณที่จะเขียนใน 2 วิธี:
) สมองกลฝังตัวอยู่ภายในรหัสที่มาแสดงความคิดเห็นในการจัดรูปแบบพิเศษ
หรือ
ข) การเพิ่มไฟล์ 'แม่แบบซึ่งผล GTK-doc หลังจากการสแกนไฟล์ทั้งหมดส่วนหัวและแยกประกาศ
จากแหล่งที่มาของรหัสเหล่านี้แสดงความคิดเห็นและแฟ้มแม่แบบ GTK-Doc สร้าง 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 เก่าไฟล์ใด ๆ เพิ่มเติม นี้ลดลง doc
- เวลาการสร้างและการทำงานสำหรับ devhelp & gt;. = 0.11 (ได้รับการปล่อยตัวในปี 2005)
- การเปลี่ยนแปลงออกจากแหล่ง dir สร้างความแตกแยกที่เกิดจากโครงการโดยใช้
- DOC_SOURCE_DIR กับทางญาติ (เพื่อ builddir) ก็จะแนะนำให้ใช้
- DOC_SOURCE_DIR = $ (top_srcdir) / src / xxx.
- การเปลี่ยนแปลง
- 590927: การสนับสนุนสำหรับ AM_SILENT_RULES doc สร้างขั้นตอน
- 617121: / * & lt; ส่วนตัว & gt; * / declarations ใน enums จะยังคงแสดง
- 627758: วิธีที่จะไม่สนใจสัญลักษณ์
- 639145: ไวยากรณ์ชวเลขสำหรับหัว
- 644291: Enum แบ่งตัวแยกวิเคราะห์ที่ได้รับมอบหมายของ ')
- 646870: HTML_IMAGES ไม่ได้อยู่ใน EXTRA_DIST
- 648289:. gtkdoc-mkdb ไม่ได้รวบรวม
- 648331:. ระบุตัวเลือกที่เข้ากันได้สำหรับ 'ไฮไลต์' อย่างต่อเนื่อง
- 649269: gtkdoc-scanobj ควรตั้งบางส่วนของ CFLAGS ของตัวเอง / เหมาะสม ldflags
- 650407: อาคารในขณะที่เอกสาร distchecking ผลิตพันของประกาศ€โน่ founda € ?? คำเตือนแล้วล้มเหลว.
- 652746: เอกสาร structs ชนิดบรรจุกล่องธรรมดาเสีย
- 652764: การปรับปรุงปรับแต่ง autotools บิต
- 655711: สรุปเอาท์พุท depscan ด้วยแพคเกจ
- 656453: ปรับปรุงประสิทธิภาพการทำงาน (PATCH)
- 656658: GTK-doc.make: ติดตั้งเป้าหมายไม่ได้ติดตั้งเอกสารเมื่อมีการสร้างในไดเรกทอรีที่แยกต่างหาก
- 656773: GTK-doc ล้มเหลวที่จะหาสัญลักษณ์ประกาศให้เป็น 'const char *'
- 656946: GTK-doc ไม่สามารถที่จะจัดการกับ 'int สั้น extern'
- 657377: srcdir = builddir สร้างทิ้งเนื้อหาของ tmpl
- ร่วม
- Bakaoukas Nikolaos
- Claude Paroz
- แดเนียล Mustieles
- เดวิด Necas
- เดวิด Nea ?? เป็น
- Javier JardA³n
- Jorge อนซาเลซ
- มาริโอBlA¤ttermann
- Matthias Clasen
- MichaA, GA³rny
- ฌอน McCance
- สเตฟานซาวเออร์ (Kost)
- ธ อมป์สันจะ
- ยาคอฟ Selkowitz
ต้องการ
- Perl v5
- libxslt และ libxml2 2.3.6
- DocBook XSL Stylesheets
- DocBook XML DTD
- DocBook SGML DTD
- หยก v1.1 หรือ OpenJade 1.3.1
- DocBook DSSSL Stylesheets
ความคิดเห็นที่ไม่พบ