GTK-Doc

GTK-Doc được sử dụng để tài liệu mã C. Nó thường được dùng để ghi các API công cộng của các thư viện, chẳng hạn như các thư viện GTK + và GNOME, nhưng nó cũng có thể được sử dụng để tài liệu mã ứng dụng.
Lưu ý rằng GTK-Doc đã không được dự định ban đầu là một công cụ tài liệu có mục đích chung, vì vậy nó có thể là một chút khó khăn để thiết lập và sử dụng. Đối với một công cụ tài liệu có mục đích chung được đánh bóng nhiều hơn bạn có thể muốn xem xét Doxygen (http://www.doxygen.org/). Tuy nhiên GTK-Doc có một số mã đặc biệt để ghi lại các tín hiệu và tính chất của GTK + widget và các lớp học GObject mà các công cụ khác có thể không có.
GTK-Doc cho phép tài liệu của bạn phải được viết bằng 2 cách:
a) nhúng vào bên trong mã nguồn trong cảm nhận đặc biệt định dạng.
hoặc
b) Thêm vào các 'mẫu' các tập tin mà gtk-doc đầu ra sau khi quét tất cả các tập tin tiêu đề và phân tích các tờ khai.
Từ những ý kiến ​​mã nguồn và các tập tin mẫu GTK-Doc tạo ra một Docbook XML (hoặc SGML) tài liệu, sau đó được chuyển thành HTML. Các tài liệu HTML được tạo ra có thể được duyệt trong một trình duyệt web thông thường hoặc bằng cách sử dụng các trình duyệt Devhelp API đặc biệt (xem http://developer.imendio.com/wiki/Devhelp).

What là mới trong phiên bản này:

• gtk-doc hỗ trợ một tập hợp con của markdown (tiêu đề và danh sách) - xem
• http://git.gnome.org/browse/gtk-doc/tree/tests/gobject/src/gobject.c
• gtk-doc không tạo ra các tập tin devhelp cũ nữa. Điều này cắt giảm xuống doc
• thời gian thế hệ và làm việc cho devhelp & gt;. = 0.11 (đã được phát hành vào năm 2005)
• thay đổi cho out-of-nguồn dir xây dựng gây ra vỡ cho các dự án sử dụng
• DOC_SOURCE_DIR với một đường dẫn tương đối (để builddir). Đó là khuyến cáo sử dụng
• DOC_SOURCE_DIR = $ (top_srcdir) / src / xxx.
• Thay đổi
• 590.927: Hỗ trợ AM_SILENT_RULES cho bước doc-xây dựng
• 617.121: / * & lt; tin & gt; * / Tờ khai trong enums vẫn được hiển thị
• 627.758: Một cách để bỏ qua một biểu tượng
• 639.145: cú pháp tốc ký cho tiêu đề
• 644.291: nghỉ Enum phân tích cú pháp trên giao ')
• 646.870: HTML_IMAGES không còn trong EXTRA_DIST
• 648.289:. Gtkdoc-mkdb không biên dịch
• 648.331:. Xác định các tùy chọn tương thích cho 'nổi bật' luôn
• 649.269: gtkdoc-scanobj nên thiết lập một số CFLAGS riêng của mình / LDFLAGS
• 650.407: Nhà tài liệu trong khi distchecking sản xuất hàng ngàn € một Ono Foundation khai € ?? cảnh báo, sau đó không thành công.
• 652.746: Tài liệu về cấu trúc đóng hộp đồng bằng bị phá vỡ
• 652.764: Cập nhật autotools cấu hình một chút
• 655.711: tổng sản lượng depscan bởi gói
• 656.453: Hiệu suất cải tiến (PATCH)
• 656.658: gtk-doc.make: cài đặt mục tiêu không cài đặt tài liệu khi xây dựng trong một thư mục riêng biệt
• 656.773: gtk-doc không tìm thấy một biểu tượng khai báo là 'char * const'
• 656.946: gtk-doc không thể xử lý 'extern int ngắn'
• 657.377: srcdir = builddir xây dựng loại bỏ nội dung của tmpl
• Cộng tác viên
• Bakaoukas Nikolaos
• Claude Paroz
• Daniel Mustieles
• David Necas
• David Nea ?? như
• Javier JardA³n
• Jorge Gonzalez
• Mario BlA¤ttermann
• Matthias Clasen
• MichaA, GA³rny
• Shaun McCance
• Stefan Sauer (Kost)
• Will Thompson
• Yaakov Selkowitz

Yêu cầu :

• Perl v5
• libxslt & libxml2 2.3.6
• DocBook XSL Stylesheets
• DocBook XML DTD
• DocBook SGML DTD
• Jade v1.1 hoặc OpenJade 1.3.1
• DocBook DSSSL Stylesheets