GTK-Doc News

GTK-Doc 1.20

Released Feb 16, 2014
  • Bug 605537 : Returns: listed among parameters
  • Bug 624001 : Support attribute-based method to deprecate symbols
  • Bug 662424 : Class hierarchy about interfaces not generated by default
  • Bug 665926 : should not have to document object structures
  • Bug 666509 : Specifying --enable-gtk-doc should not be required to build source packages
  • Bug 669417 : Duplicate IDs generated for unions registered as boxed types
  • Bug 671519 : Self-test relies on nonportable (GNU enhanced) 'date' command
  • Bug 692367 : gtkdocize should take a srcdir argument
  • Bug 696570 : style updates
  • Bug 697940 : Race condition between setup-build.stamp and scan-build.stamp
  • Bug 701259 : /bin/bash: -chmod: command not found
  • Bug 701638 : Support automake parallel test harness (fix error with GTKDOC_CHECK)
  • Bug 706404 : Minor bug in gtkdoc-mkdb
  • Bug 706438 : Empty lines added at the beginning and at the end of a programlisting
  • Bug 707426 : master is broken in picking up flavour from configure.ac
  • Bug 707717 : Support " Deprecated: X.Y "
  • Bug 708268 : New *-insensitive.png files are not distributes
  • Bug 710478 : gtkdoc-mkdb: Don't complain about annotations with hyphen
  • Bug 711111 : gtkdoc-mkdb: sort entries in the glossary
  • Bug 711598 : gtkdoc-scan doesn't ignore decorators containing parentheses
  • Bug 719644 : docs: make yelp usage conditional in manual
  • Bug 719645 : configure: emit message when looking for yelp
  • Bug 720061 : make: create subdirectories of the content_files to the builddir
  • Bug 721228 : configure: search for xml catalog in XDG_DATA_DIRS
  • Bug 722479 : cp -u is not portable
  • Bug 723118 : Mark |[ blocks as CDATA
  • Bug 723288 : Fix MarkDown support
  • Bug 723417 : New MarkDown parser
  • Bug 723696 : Add support for blockquote
  • Bug 723812 : Add support for reference links
  • Bug 723913 : List in markdown: < p > inside the last element of a < ul > list
  • Bug 723991 : Improve the display of the synopsis
  • Bug 724002 : gtkdoc-scan: Fix use of uninitialised value in trace logging

GTK-Doc 1.19

Released Jun 05, 2013
  • Bug 652740 : Warnings during expansion of content files
  • Bug 660436 : Warning for skip annotations on function parameters
  • Bug 661853 : allow EXTRA_DIST to be predefined
  • Bug 668228 : several of the tests use syntax not compatible with traditional Bourne shells
  • Bug 670724 : gtk-doc.make: double recursion when maintainer-clean
  • Bug 670767 : generated file gnome-doc-utils.m4 is in version control
  • Bug 670796 : (patch) Show commands when building documentation with make
  • Bug 671519 : Self-test relies on nonportable (GNU enhanced) 'date' command
  • Bug 671960 : make dist fails without html/*
  • Bug 672710 : Use new documentation infrastructure
  • Bug 676685 : Allow to order functions without using $MODULE-sections.txt
  • Bug 685365 : (PATCH) Fix contents of warning message, should be " -sections.txt " not " -section.txt "
  • Bug 686148 : [patch] suggested parameters for gtkdoc-scangobj
  • Bug 687685 : 'g_type_init' is deprecated
  • Bug 688204 : undocumented enum values missing in indexes
  • Bug 688423 : Add support for " transfer floating " introspection annotation
  • Bug 689209 : Automake complains about trailing space after backslash.
  • Bug 690438 : Small improvements
  • Bug 696930 : Incorrect allowed value for a property
  • Bug 700981 : make: copy the files with their relative path included

GTK-Doc 1.18

Released Sep 14, 2011
  • Bug 590927: Support AM_SILENT_RULES for doc-build steps
  • Bug 617121: /* < private > */ declarations in enums are still displayed
  • Bug 627758: A way to ignore a symbol
  • Bug 639145: shorthand syntax for headings
  • Bug 644291: Enum parser breaks on assignment of ')'
  • Bug 646870: HTML_IMAGES no longer in EXTRA_DIST
  • Bug 648289: gtkdoc-mkdb doesn't compile.
  • Bug 648331: Specify compatible options for 'highlight' consistently.
  • Bug 649269: gtkdoc-scanobj should set some of its own CFLAGS/LDFLAGS
  • Bug 650407: Buildings docs while distchecking produces thousands of “No declaration found” warnings, then fails.
  • Bug 652746: Documentation of plain boxed structs broken
  • Bug 652764: Update autotools config a bit
  • Bug 655711: summarize depscan output by package
  • Bug 656453: Performance improvements (PATCH)
  • Bug 656658: gtk-doc.make: install target doesn't install docs when building in a separate directory
  • Bug 656773: gtk-doc fails to find a symbol declared as 'char* const'
  • Bug 656946: gtk-doc unable to handle 'extern short int'
  • Bug 657377: srcdir!=builddir builds discard contents of tmpl

GTK-Doc 1.17

Released Feb 26, 2011
  • Bug 127049: building reference documentation fails when builddir != srcdir
  • Bug 640241: non-srcdir builds busted

GTK-Doc 1.16

Released Jan 14, 2011
  • Bug 625776: serialise doubles and floats always with a decimal dot
  • Bug 627269: link to signalflags docs from signal descriptions
  • Bug 467488: GTK+ man pages request
  • Bug 481811: Inline function bodies are confused with declarations
  • Bug 501107: EXTRA_DIST automake warnings
  • Bug 512565: add GTK_DOC_IGNORE
  • Bug 518427: documentation best pratices needed
  • Bug 597937: Function pointers as parameters to other functions are parsed improperly
  • Bug 612028: gtkdoc-fixxref should call /usr/bin/vim -n -e -u NONE -T xterm
  • Bug 617478: Tooltip is a nuisance
  • Bug 618379: Navigation is hiding anchors title
  • Bug 620249: invalid xml for object_index with (n_objects % 3) == 0
  • Bug 621931: support GType and GVariant types
  • Bug 622971: List of typos in the GTK-doc manual
  • Bug 623777: G_TYPE_STRV in signals generate wrong docs
  • Bug 623968: gtkdoc-mkdb generates invalid xml from sgml in inline comments
  • Bug 624199: parser picks up contents of large macros
  • Bug 624200: 'const' confuses the parser
  • Bug 627223: gtkdoc-fixxref vim highlight fails on xhtml suffix
  • Bug 627920: `make check` rule to list xml files missing from DOC_MAIN_SGML_FILE
  • Bug 628611: gtk-doc > = 1.13 creates automagic dependencies on syntax highlighters
  • Bug 628794: Issue in gtkdoc-mkman.in
  • Bug 630288: Fix 'scope notified' annotation
  • Bug 631336: remove lists of gtk+ signal args in gtkdoc-scanobj and -scangobj
  • Bug 632587: gtkdoc-scanner fails to identify (closure) annotation
  • Bug 638330: const in parameter list is ignored
  • Bug 638831: Support GTK+ 3 cell properties

GTK-Doc 1.15

Released May 21, 2010
  • Bug 614496: Support for multiple DOC_SOURCE_DIR directories
  • Bug 615550: gtk-doc fails to recognize (scope ...) and (skip) annotations

GTK-Doc 1.14

Released March 28, 2010
  • Bug 593282: Append ' _struct ' prefix to every struct name
  • Bug 599514: sane support for per-page images
  • Bug 604892: checks fail
  • Bug 613611: parameter descriptions with annotations truncated at first \n
  • Bug 115531: add short description to index entries
  • Bug 165425: gtk-doc fails to parse unions
  • Bug 512155: gets confused by multiline typedef
  • Bug 568711: undocumented enum values are not reported
  • Bug 590602: secondly running gtkdoc-mkdb will generate DOCTYPE missing XML files
  • Bug 590625: $(DOC_MODULE)-overrides.txt is required by ' make dist '
  • Bug 591975: Section_Id always embeds a trailing newline
  • Bug 604885: Fix the use of gtkdocize --flavour option
  • Bug 604992: gtkdoc-fixxref broken link warning is broken for functions
  • Bug 604995: Syntax error in gtkdoc-mkman
  • Bug 604998: Check for syntax errors in the test suite
  • Bug 605052: put class structs to the generated section file
  • Bug 605211: Many build failures with gtk-doc 1.13
  • Bug 605281: Add ' Since ' and ' Deprecated ' tag to function example
  • Bug 605285: Add < keycap > and < keycombo > example
  • Bug 605289: Some documentation improvements
  • Bug 605452: Added more info to ' Documenting symbols ' sectio
  • Bug 605564: Env var equivalent to --flavour=no-tmpl
  • Bug 606661: XInclude error while gnerating documentation
  • Bug 607445: gtk-doc does not support long double as returned value type
  • Bug 607531: Execute system() calls in subshells to ease debugging
  • Bug 609062: [All-langs] [gtk-doc] Translated *.po files not available within ~/po directory
  • Bug 609194: sort interface implementers
  • Bug 610255: Self-test failure in git as of 2010-02-17: FAIL: gobject.sh
  • Bug 610257: Patch to make GTK-DOC notice functions/variables with 'signed' prototypes
  • Bug 611848: gtk-doc produces invalid DocBook markup if the SECTION ends with a tag that cannot be nested inside < para >

GTK-Doc 1.13

Released December 18, 2009

GTK-Doc 1.12

Released December 18, 2009
  • Bug 591450: Build related fixes
  • Bug 466535: generate documentation as pdf
  • Bug 502191: acronym support
  • Bug 532395: inline function parsing problems (e.g. in glib api docs)
  • Bug 536928: have syntax highlghted and xrefs source code samples
  • Bug 562064: index generation trouble
  • Bug 562310: glib 2.18.3: /bin/sh: line 1: gtkdoc-rebase: command not found
  • Bug 562655: doesn't produce deprecation note for signals
  • Bug 565126: linking to struct members
  • Bug 565835: Three spelling errors in gtk-doc-manual
  • Bug 566911: add support for --help and --version to remaining tools
  • Bug 567132: Take FOO_GET_INTERFACE as standard
  • Bug 568702: gtkdoc-mkhtml no longer works when symlinked
  • Bug 568706: gtkdoc-scan: use CamelCase id for interfaces
  • Bug 568708: gtkdoc-scan should try not to scan files twice
  • Bug 568714: Perl errors when syntax highlighting is not available
  • Bug 568732: missing long descriptions undetected
  • Bug 568734: configure check for gtk-doc prints that gtk-doc cannot be built
  • Bug 569339: abbreviation are not expanded at the start of text
  • Bug 572396: Fix to use shave + gtk-doc + libtool 1.x
  • Bug 572612: Mistakenly substitute -1 with G_MAXULONG in x86_64
  • Bug 572967: use g_strerror
  • Bug 574654: --ignore-decorators does not ignore trailing stuff
  • Bug 575574: Be more friendly for files with a space in their name
  • Bug 575623: Update FSF address
  • Bug 575711: < table > element mismatch in highlighted code
  • Bug 576313: implicit declarations in testsuite ?
  • Bug 577059: Gnome-doc support can't be disabled
  • Bug 577774: Test suite run even when built with --disable-gtk-doc
  • Bug 580206: gcc warnings in < module > -scan.c
  • Bug 580300: gtkdoc-scan picks up _get_type functions it should not
  • Bug 580622: xml dir is both part of distclean and dist rules
  • Bug 581237: gtk-doc uses wrong gtkdoc-check in ' make check ' phase
  • Bug 584952: ' uninitialized value in concatenation ' gtkdoc-mkdb line 938
  • Bug 587103: return values of function-like macros
  • Bug 587196: Typo in a string
  • Bug 589426: Python is a required dependency
  • Bug 591789: master FTBFS with automake 1.11
  • Bug 594224: Please fix manual about inlined SECTION comments (and show warnings when invalid)
  • Bug 596730: Signed vs. unsigned comparison in gtkdoc-scangobj.in causing compile errors
  • Bug 596731: autogen.sh doesn't recognize automake-1.11
  • Bug 602026: Warn if non-existing function gets referenced
  • Bug 602518: Doesn't support ' long int ' return type
  • Bug 604798: tests/fail.sh and tests/tools.sh.in use bashisms

GTK-Doc 1.11

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

GTK-Doc 1.10

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

GTK-Doc 1.9

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

GTK-Doc 1.8

Released Feburary 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

Released July 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

Released April 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

Released March 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

Released July 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

Released January 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

Released February 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

Released April 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

Released January 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

Released November 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.