GTK-Doc Manual

  • 1. Introduction
    • 1.1. What is GTK-Doc?
    • 1.2. How Does GTK-Doc Work?
    • 1.3. Getting GTK-Doc
    • 1.4. About GTK-Doc
    • 1.5. About this Manual
  • 2. Setting up your project
    • 2.1. Setting up a skeleton documentation
    • 2.2. Integration with autoconf
    • 2.3. Integration with automake
    • 2.4. Integration with autogen
    • 2.5. Running the doc build
    • 2.6. Integration with version control systems
    • 2.7. Integration with plain makefiles or other build systems
  • 3. Documenting the code
    • 3.1. Documentation comments
    • 3.2. Documenting sections
    • 3.3. Documenting symbols
    • 3.4. Useful DocBook tags
  • 4. Filling the extra files
    • 4.1. Editing the types file
    • 4.2. Editing the master document
    • 4.3. Editing the section file
  • 5. Controlling the result
    • 6. Documenting other interfaces
      • 6.1. Command line options and man pages
      • 6.2. DBus interfaces
    • 7. Frequently asked questions
      • 8. Tools related to gtk-doc
        • A. GNU Free Documentation License
          • A.1. 0. PREAMBLE
          • A.2. 1. APPLICABILITY AND DEFINITIONS
          • A.3. 2. VERBATIM COPYING
          • A.4. 3. COPYING IN QUANTITY
          • A.5. 4. MODIFICATIONS
          • A.6. 5. COMBINING DOCUMENTS
          • A.7. 6. COLLECTIONS OF DOCUMENTS
          • A.8. 7. AGGREGATION WITH INDEPENDENT WORKS
          • A.9. 8. TRANSLATION
          • A.10. 9. TERMINATION
          • A.11. 10. FUTURE REVISIONS OF THIS LICENSE
          • A.12. Addendum
        About This Document Introduction

        About

        • About This Document
        • GTK-Doc Manual
          • Introduction
          • Setting up your project
          • Documenting the code
          • Filling the extra files
          • Controlling the result
          • Documenting other interfaces
          • Frequently asked questions
          • Tools related to gtk-doc
          • GNU Free Documentation License
         
         
        • The GNOME Project
          • About Us
          • Get Involved
          • Teams
          • The GNOME Foundation
          • Support GNOME
          • Contact
        • Resources
          • Documentation
          • Wiki
          • Mailing Lists
          • IRC Channels
          • Bug Tracker
          • Development Code
          • Build Tool
        • News
          • Latest Release
          • Planet GNOME
          • Development News
          • Twitter
        • This website is available in many languages
          • Switch Language
        Copyright © 2005‒2014 The GNOME Project
        Optimised for standards. Hosted by Red Hat.