The GTK-Doc Project

Current Release

GTK-Doc 1.11 (Nov 16 2008)

• 531572 : one-page generation option
• 448879 : Use a footer when generating HTML documentation
• 311857 : xsltproc very slow generating index for gtk-docs.sgml
• 335239 : Using gnome-doc-utils for gtk-doc documentation
• 460753 : enable vpath build in gtkdoc-mkhtml
• 473342 : Warn about repeated symbols in sections
• 487727 : DocBook XML DTD version
• 523669 : make check: Element publisher content does not follow the...
• 530758 : gtk-doc should not expand XML tags and their attributes
• 533262 : no-template mode scans different source files
• 534627 : gtk-doc uses non-standard HTML element
• 542137 : No declaration found for: gsf_output_*
• 543855 : Fix for Bug 460753 (enable vpath build in gtkdoc-mkhtml) ...
• 544172 : Fails to parse return value of 'char const *'
• 552822 : Add rules to create $(REPORT_FILES)
• 553407 : Example Makefile.am uses obsolete INCLUDES instead of AM_...
• 554718 : gtk-doc needs to allow versioned TARGET_DIR
• 554833 : Be more careful with " struct _ < struct_name > "
• 558082 : evince docs build fails with GTK_DISABLE_SINGLE_INCLUDES
• 559281 : Correct check for existance of gtkdoc-rebase

Historic Releases

GTK-Doc 1.10 (Mar 20 2008)

• 460753: enable vpath build in gtkdoc-mkhtml
• 503119: Add dependency on content_files to SGML target
• 127049: building reference documentation fails when builddir != s...
• 481811: Inline function bodies are confused with declarations
• 448879: Use a footer when generating HTML documentation
• 492005: Deprecation guard warnings for properties and signals
• 498521: Inconsistent compiler flags passed in gtk-doc.make
• 365913: gtk-doc output is not predictable
• 446648: gtk-doc does not handle forward typedef'd enums
• 468278: Display proper types for properties
• 497367: don't use US-ASCII for output encoding
• 501066: Missing quotes around gtkdoc-rebase check cause a warning
• 508897: [PATCH] Fix build when gtk-doc is not installed
• 509539: Building documentation aborts when no .types file is present
• 512154: Struct member type attributes are limited to one token
• 513318: gtk-doc.el doesn't work fine with emacs22

GTK-Doc 1.9 (Sep 30 2007)

• 419308: unsynced regexps for parameter parsing
• 449618: Top navigation bar is in the way
• 453717: fixxref logic to determine absolute path"s is flawed
• 457173: unit tests for gtk-doc
• 465920: Use gtkdoc-rebase
• 467773: default master doc should have proper extension
• 141869: Poor error generated when faced with a type declared as ...
• 156643: Avoid make error in gtk-doc.make
• 322035: wrong macro parsing
• 323938: gtk-doc.m4 check is silent
• 324535: gtk-doc doesn"t handle deprecation inside enumerations
• 355352: If you don"t have an instantiatable type for a gtypeinter...
• 379466: Improve C parser to handle TYPE\nVARIABLE in function pro...
• 380824: docs are truncated if line begins with * returns
• 383456: make check test for 100% documentation
• 411739: Gtk-doc fails to handle struct tm * function_name ();
• 415388: Please clean -undocumented.txt files
• 418027: gtkdoc-mkdb does not handle #ifdef in enum {}
• 419997: parameter name trouble
• 428596: Warnings with gtk-doc.m4 macros
• 434134: fixxrefs like sed for installing pregenerated docs
• 436565: Report undeclared symbols into a file
• 445596: Impossible to link a page with an anchor
• 445693: Does not understand unsigned long as a type
• 450338 : Make gtk-doc.m4 fail when needed gtk-doc is not installed
• 454916: gtk-doc should permit generation of URI-based cross-refer...
• 457077: add --no-implicit-returns to gtkdoc-mkdb
• 459225: Accept automake-1.10 in autogen.sh
• 459725: jhbuild build gtk-doc fails on make
• 460127: parsing nested union/structs confuses public/private state
• 465365: [PATCH] gtk-doc does not compile
• 466559: [CSS] styling < hr / >
• 471014: G_CONST_RETURN * G_CONST_RETURN * function not picked up
• 477532: function variables
• 479913: gtk-doc.notmpl.make is not distributed
• 479923: distclean test output properly

GTK-Doc 1.8 (Feb 16 2007)

• Made it easier to include example code in the source code comment blocks.
• |[ ... ]| can be used to delineate example code (it just gets converted to <informalexample><programlisting>), and most of the text in example code is left as it is. The only thing that is still expanded is # to allow links to a symbol"s documentation, e.g. #GtkWidget.
• Made the field widths wider for the HTML output, so it looks a bit nicer.
• Added a --rebuild-sections option to gtkdoc-scan to automatically rebuild the MODULE-sections.txt file. This only works if all the header files are organized neatly and functions don"t need rearranging in the docs.
• Added a --rebuild-types option to gtkdoc-scan to automatically rebuild the MODULE.types file, so you don"t need to add new types manually.
• Leave CDATA sections as they are, in the extra XML content files and within source code comment blocks.
• Allow the section id and #include"s to be set within the SECTION: comment block, using @Section_ID:xxx and @Include:.
• Added --default-includes option to specify the default #include"s (for people who are using --rebuild-sections and so can"t specify it in MODULE-sections.txt).
• Added a --query-child-properties argument to help document child properties of arbitrary GObjects (used by things like canvas widgets).
• Fixed documentation of signals of interfaces.

GTK-Doc 1.7 (Jul 29 2006)

• Fixed bug that resulted in empty @: lines in the templates.
• Fixed a few bugs with the XSL code.
• Supported a few more variations of C syntax.
• Remove the internally-used '-struct' suffix from links to widget structs.
• Fixed a few missing build dependencies.
• Added a new C-x4s binding to the emacs lisp code, to insert a blank section header in the source code.
• Fixed bug that ignored inline section header docs with '-' in their names.
• Added a 'make docs' target that can be used to build the docs even when gtk-doc has been disabled at configure time.

GTK-Doc 1.6 (Apr 9 2006)

• Removed the hard dependancy on openjade or jade, since XML is used mainly now rather than SGML.
• Install the .pc file in $(datadir) rather than $(libdir) since gtk-doc is architecture-independant.
• Added --ignore-decorators option to ignore a list of declarators in function declarations.
• Support #Object::signal"/"#Object:property to link to signals/properties.
• Fixed missing index terms.

GTK-Doc 1.5 (Mar 7 2006)

• Output the new version of devhelp2 information, but still generate the old devhelp files so older versions of DevHelp still work OK.
• Fixed the initial creation of the *-sections.txt file so the object hierarchy, signals and properties all work automatically.
• Show information about signal flags (run first/last).
• Support a --source-suffixes argument specifying which source files to scan.
• Support other root object types besides GObject and GInterface.
• Use a fixed navigation bar for the generated documentation.
• New documentation from Stefan Kost.
• Handle more variations of C syntax.

GTK-Doc 1.4 (Jul 3 2005)

• Support section documentation (title, short description, long description and 'see also') within the source code. I think everything can now be documented within the source code.
• Support Stable/Unstable/Private stability levels for everything.

GTK-Doc 1.3 (Jan 9 2005)

• Use the new style.css stylesheet instead of hard-wiring the styles.
• Updated the documentation and example build files.
• Added support for a gallery of widget images.
• Output default values for widget properties and allowed ranges.
• Only underline links in the docs when the mouse hovers over them.
• Added support for placing the parameter table anywhere within the function documentation (using the <!--PARAMETERS--> marker).
• Handle more variations of C syntax.

GTK-Doc 1.2 (Feb 16 2004)

• Added widget signals and properties to undocumented output and statistics.
• Added support for an index of all symbols.
• Emit "Since:" information for signals and properties.
• Added derived subclasses and interfaces to the widget hierarchies.
• Added .cat SGML catalog file.
• Support properties on interfaces.
• Added --help options to the scripts.

GTK-Doc 1.1 (Apr 18 2003)

• Add a gtk-doc.m4 macro that allows packages to provide consistent checking for gtk-doc.
• Check to make sure that the XML catalog actually contains entries for the DocBook XML DTD and XSLT stylesheets. Please consult the README file if your system's XML catalog isn't set up.
• Add infrastructure for including the standard gtk-doc makefile glue, so that maintainers of packages don't need to worry about keeping it up to date. See glib head for an example of its use.
• Some updates to the devhelp contents file generation, as suggested by Hallski.
• Fix some bugs in the DocBook XML codepath that were preventing inter-module cross references from being resolved.
• Fix some bugs in extraction of object property documentation.

GTK-Doc 1.0 (Jan 20 2003)

• Added support for Since: and Deprecated: tags, and look for deprecated guard macros in header files.
• Support /*< public >*/ and /*< private >*/ markers for all structs.
• New --ignore-files option for gtkdoc-mkdb, to ignore files or directories.
• Used the sgml-raw output type with openjade, to avoid problems with Lynx.
• Added .pc pkg-config file which can be used to check the gtk-doc version.

GTK-Doc 0.10 (Nov 14 2002)

• --output-format option to select whether SGML or XML is generated.
• Use openjade or jade when converting SGML to HTML.
• Use xsltproc to convert XML to HTML, with a new look.
• In XML mode, support XIncludes as an alternative to entities.
• In XML mode, create .devhelp files.
• List interfaces in the object hierarchy.
• Create docs for signals on interfaces.
• Generate links between interface and their implementations and prerequisites.
• Create docs for child and style properties.
• Use blurbs for property documentation.
• Allow inline documentation for signals and properties.