1 GTK-Doc 1.16 (xxx xx xxxx)
4 o gtkdoc-check can do more checks, one might need to update Makefile.am from
5 the examples/Makefile.am
8 GTK-Doc 1.15 (May 21 2010)
13 o 614496 : Support for multiple DOC_SOURCE_DIR directories
14 o 615550 : gtk-doc fails to recognize (scope ...) and (skip) annotations
24 GTK-Doc 1.14 (Mar 28 2010)
29 o 593282 : Append " _struct " prefix to every struct name
30 o 599514 : sane support for per-page images
31 o 604892 : checks fail
32 o 613611 : parameter descriptions with annotations truncated at first \n
33 o 115531 : add short description to index entries
34 o 165425 : gtk-doc fails to parse unions
35 o 512155 : gets confused by multiline typedef
36 o 568711 : undocumented enum values are not reported
37 o 590602 : secondly running gtkdoc-mkdb will generate DOCTYPE missing XML files
38 o 590625 : $(DOC_MODULE)-overrides.txt is required by " make dist "
39 o 591975 : Section_Id always embeds a trailing newline
40 o 604885 : Fix the use of gtkdocize --flavour option
41 o 604992 : gtkdoc-fixxref broken link warning is broken for functions
42 o 604995 : Syntax error in gtkdoc-mkman
43 o 604998 : Check for syntax errors in the test suite
44 o 605052 : put class structs to the generated section file
45 o 605211 : Many build failures with gtk-doc 1.13
46 o 605281 : Add " Since " and " Deprecated " tag to function example
47 o 605285 : Add < keycap > and < keycombo > example
48 o 605289 : Some documentation improvements
49 o 605452 : Added more info to " Documenting symbols " sectio
50 o 605564 : Env var equivalent to --flavour=no-tmpl
51 o 606661 : XInclude error while gnerating documentation
52 o 607445 : gtk-doc does not support long double as returned value type
53 o 607531 : Execute system() calls in subshells to ease debugging
54 o 609062 : [All-langs] [gtk-doc] Translated *.po files not available within ~/po directory
55 o 609194 : sort interface implementers
56 o 610255 : Self-test failure in git as of 2010-02-17: FAIL: gobject.sh
57 o 610257 : Patch to make GTK-DOC notice functions/variables with 'signed' prototypes
58 o 611848 : gtk-doc produces invalid DocBook markup if the SECTION ends with a tag that cannot be nested inside < para >
64 Emilio Pozuelo Monfort
65 Francisco Javier F. Serrador
83 GTK-Doc 1.13 (Dec 18 2009)
86 o 604891 : gtk-doc tarball does not build
92 GTK-Doc 1.12 (Dec 18 2009)
97 o 591450 : Build related fixes
98 o 466535 : generate documentation as pdf
99 o 502191 : acronym support
100 o 532395 : inline function parsing problems (e.g. in glib api docs)
101 o 536928 : have syntax highlghted and xrefs source code samples
102 o 562064 : index generation trouble
103 o 562310 : glib 2.18.3: /bin/sh: line 1: gtkdoc-rebase: command not found
104 o 562655 : doesn't produce deprecation note for signals
105 o 565126 : linking to struct members
106 o 565835 : Three spelling errors in gtk-doc-manual
107 o 566911 : add support for --help and --version to remaining tools
108 o 567132 : Take FOO_GET_INTERFACE as standard
109 o 568702 : gtkdoc-mkhtml no longer works when symlinked
110 o 568706 : gtkdoc-scan: use CamelCase id for interfaces
111 o 568708 : gtkdoc-scan should try not to scan files twice
112 o 568714 : Perl errors when syntax highlighting is not available
113 o 568732 : missing long descriptions undetected
114 o 568734 : configure check for gtk-doc prints that gtk-doc cannot be built
115 o 569339 : abbreviation are not expanded at the start of text
116 o 572396 : Fix to use shave + gtk-doc + libtool 1.x
117 o 572612 : Mistakenly substitute -1 with G_MAXULONG in x86_64
118 o 572967 : use g_strerror
119 o 574654 : --ignore-decorators does not ignore trailing stuff
120 o 575574 : Be more friendly for files with a space in their name
121 o 575623 : Update FSF address
122 o 575711 : < table > element mismatch in highlighted code
123 o 576313 : implicit declarations in testsuite ?
124 o 577059 : Gnome-doc support can't be disabled
125 o 577774 : Test suite run even when built with --disable-gtk-doc
126 o 580206 : gcc warnings in < module > -scan.c
127 o 580300 : gtkdoc-scan picks up _get_type functions it should not
128 o 580622 : xml dir is both part of distclean and dist rules
129 o 581237 : gtk-doc uses wrong gtkdoc-check in " make check " phase
130 o 584952 : " uninitialized value in concatenation " gtkdoc-mkdb line 938
131 o 587103 : return values of function-like macros
132 o 587196 : Typo in a string
133 o 589426 : Python is a required dependency
134 o 591789 : master FTBFS with automake 1.11
135 o 594224 : Please fix manual about inlined SECTION comments (and show warnings when invalid)
136 o 596730 : Signed vs. unsigned comparison in gtkdoc-scangobj.in causing compile errors
137 o 596731 : autogen.sh doesn't recognize automake-1.11
138 o 602026 : Warn if non-existing function gets referenced
139 o 602518 : Doesn't support " long int " return type
140 o 604798 : tests/fail.sh and tests/tools.sh.in use bashisms
162 GTK-Doc 1.11 (Nov 16 2008)
167 o 531572 : one-page generation option
168 o 448879 : Use a footer when generating HTML documentation
169 o 311857 : xsltproc very slow generating index for gtk-docs.sgml
170 o 335239 : Using gnome-doc-utils for gtk-doc documentation
171 o 460753 : enable vpath build in gtkdoc-mkhtml
172 o 473342 : Warn about repeated symbols in sections
173 o 487727 : DocBook XML DTD version
174 o 523669 : make check: Element publisher content does not follow the...
175 o 530758 : gtk-doc should not expand XML tags and their attributes
176 o 533262 : no-template mode scans different source files
177 o 534627 : gtk-doc uses non-standard HTML element
178 o 542137 : No declaration found for: gsf_output_*
179 o 543855 : Fix for Bug 460753 (enable vpath build in gtkdoc-mkhtml) ...
180 o 544172 : Fails to parse return value of 'char const *'
181 o 552822 : Add rules to create $(REPORT_FILES)
182 o 553407 : Example Makefile.am uses obsolete INCLUDES instead of AM_...
183 o 554718 : gtk-doc needs to allow versioned TARGET_DIR
184 o 554833 : Be more careful with " struct _ < struct_name > "
185 o 558082 : evince docs build fails with GTK_DISABLE_SINGLE_INCLUDES
186 o 559281 : Correct check for existance of gtkdoc-rebase
203 GTK-Doc 1.10 (Mar 20 2008)
208 o 460753 : enable vpath build in gtkdoc-mkhtml
209 o 503119 : Add dependency on content_files to SGML target
210 o 127049 : building reference documentation fails when builddir != s...
211 o 481811 : Inline function bodies are confused with declarations
212 o 448879 : Use a footer when generating HTML documentation
213 o 492005 : Deprecation guard warnings for properties and signals
214 o 498521 : Inconsistent compiler flags passed in gtk-doc.make
215 o 365913 : gtk-doc output is not predictable
216 o 446648 : gtk-doc does not handle forward typedef'd enums
217 o 468278 : Display proper types for properties
218 o 497367 : don't use US-ASCII for output encoding
219 o 501066 : Missing quotes around gtkdoc-rebase check cause a warning
220 o 508897 : [PATCH] Fix build when gtk-doc is not installed
221 o 509539 : Building documentation aborts when no .types file is present
222 o 512154 : Struct member type attributes are limited to one token
223 o 513318 : gtk-doc.el doesn't work fine with emacs22
243 GTK-Doc 1.9 (Sep 30 2007)
248 o 419308 : unsynced regexps for parameter parsing
249 o 449618 : Top navigation bar is in the way
250 o 453717 : fixxref logic to determine absolute path's is flawed
251 o 457173 : unit tests for gtk-doc
252 o 465920 : Use gtkdoc-rebase
253 o 467773 : default master doc should have proper extension
254 o 141869 : Poor error generated when faced with a type declared as '...
255 o 156643 : Avoid make error in gtk-doc.make
256 o 322035 : wrong macro parsing
257 o 323938 : gtk-doc.m4 check is silent
258 o 324535 : gtk-doc doesn't handle deprecation inside enumerations
259 o 355352 : If you don't have an instantiatable type for a gtypeinter...
260 o 379466 : Improve C parser to handle TYPE\nVARIABLE in function pro...
261 o 380824 : docs are truncated if line begins with '* returns '
262 o 383456 : ' make check ' test for 100% documentation
263 o 411739 : Gtk-doc fails to handle ' struct tm * function_name (); '
264 o 415388 : Please clean -undocumented.txt files
265 o 418027 : gtkdoc-mkdb does not handle #ifdef in enum {}
266 o 419997 : parameter name trouble
267 o 428596 : Warnings with gtk-doc.m4 macros
268 o 434134 : fixxrefs like sed for installing pregenerated docs
269 o 436565 : Report undeclared symbols into a file
270 o 445596 : Impossible to link a page with an anchor
271 o 445693 : Does not understand ' unsigned long ' as a type
272 o 450338 : Make gtk-doc.m4 fail when needed gtk-doc is not installed
273 o 454916 : gtk-doc should permit generation of URI-based cross-refer...
274 o 457077 : add --no-implicit-returns to gtkdoc-mkdb
275 o 459225 : Accept automake-1.10 in autogen.sh
276 o 459725 : ' jhbuild build gtk-doc ' fails on make
277 o 460127 : parsing nested union/structs confuses public/private state
278 o 465365 : [PATCH] gtk-doc does not compile
279 o 466559 : [CSS] styling <hr />;
280 o 471014 : G_CONST_RETURN * G_CONST_RETURN * function not picked up
281 o 477532 : function variables
282 o 479913 : gtk-doc.notmpl.make is not distributed
283 o 479923 : distclean test output properly
299 GTK-Doc 1.8 (Feb 16 2007)
302 o Made it easier to include example code in the source code comment blocks.
303 "|[ ... ]|" can be used to delineate example code (it just gets converted
304 to "<informalexample><programlisting>"), and most of the text in example
305 code is left as it is. The only thing that is still expanded is
306 '#' to allow links to a symbol's documentation, e.g. '#GtkWidget'.
307 o Made the field widths wider for the HTML output, so it looks a bit nicer.
308 o Added a '--rebuild-sections' option to gtkdoc-scan to automatically rebuild
309 the MODULE-sections.txt file. This only works if all the header files are
310 organized neatly and functions don't need rearranging in the docs.
311 o Added a '--rebuild-types' option to gtkdoc-scan to automatically rebuild
312 the MODULE.types file, so you don't need to add new types manually.
313 o Leave CDATA sections as they are, in the extra XML content files and within
314 source code comment blocks.
315 o Allow the section id and #include's to be set within the "SECTION:" comment
316 block, using "@Section_ID:xxx" and "@Include:".
317 o Added "--default-includes" option to specify the default #include's (for
318 people who are using --rebuild-sections and so can't specify it in
319 MODULE-sections.txt).
320 o Added a '--query-child-properties' argument to help document child
321 properties of arbitrary GObjects (used by things like canvas widgets).
322 o Fixed documentation of signals of interfaces.
325 GTK-Doc 1.7 (Jul 29 2006)
328 o Fixed bug that resulted in empty "@:" lines in the templates.
329 o Fixed a few bugs with the XSL code.
330 o Supported a few more variations of C syntax.
331 o Remove the internally-used '-struct' suffix from links to widget structs.
332 o Fixed a few missing build dependencies.
333 o Added a new "C-x4s" binding to the emacs lisp code, to insert a blank
334 section header in the source code.
335 o Fixed bug that ignored inline section header docs with '-' in their names.
336 o Added a 'make docs' target that can be used to build the docs even when
337 gtk-doc has been disabled at configure time.
340 GTK-Doc 1.6 (Apr 9 2006)
343 o Removed the hard dependancy on openjade or jade, since XML is used mainly
344 now rather than SGML.
345 o Install the .pc file in $(datadir) rather than $(libdir) since gtk-doc is
346 architecture-independant.
347 o Added "--ignore-decorators" option to ignore a list of declarators in
348 function declarations.
349 o Support '#Object::signal'/'#Object:property' to link to signals/properties
350 o Fixed missing index terms.
353 GTK-Doc 1.5 (Mar 7 2006)
356 o Output the new version of devhelp2 information, but still generate the old
357 devhelp files so older versions of DevHelp still work OK.
358 o Fixed the initial creation of the *-sections.txt file so the object
359 hierarchy, signals and properties all work automatically.
360 o Show information about signal flags (run first/last).
361 o Support a --source-suffixes argument specifying which source files to scan.
362 o Support other root object types besides GObject and GInterface.
363 o Use a fixed navigation bar for the generated documentation.
364 o New documentation from Stefan Kost.
365 o Handle more variations of C syntax.
368 GTK-Doc 1.4 (Jul 3 2005)
371 o Support section documentation (title, short description, long description
372 and 'see also') within the source code. I think everything can now be
373 documented within the source code.
374 o Support Stable/Unstable/Private stability levels for everything.
377 GTK-Doc 1.3 (Jan 9 2005)
380 o Use the new style.css stylesheet instead of hard-wiring the styles.
381 o Updated the documentation and example build files.
382 o Added support for a gallery of widget images.
383 o Output default values for widget properties and allowed ranges.
384 o Only underline links in the docs when the mouse hovers over them.
385 o Added support for placing the parameter table anywhere within the function
386 documentation (using the "<!--PARAMETERS-->" marker).
387 o Handle more variations of C syntax.
390 GTK-Doc 1.2 (Feb 16 2004)
393 o Added widget signals and properties to undocumented output and statistics.
394 o Added support for an index of all symbols.
395 o Emit "Since:" information for signals and properties.
396 o Added derived subclasses and interfaces to the widget hierarchies.
397 o Added .cat SGML catalog file.
398 o Support properties on interfaces.
399 o Added "--help" options to the scripts.
402 GTK-Doc 1.1 (Apr 18 2003)
405 o Add a gtk-doc.m4 macro that allows packages to provide consistent
406 checking for gtk-doc.
407 o Check to make sure that the XML catalog actually contains entries
408 for the DocBook XML DTD and XSLT stylesheets. Please consult the
409 README file if your system's XML catalog isn't set up.
410 o Add infrastructure for including the standard gtk-doc makefile
411 glue, so that maintainers of packages don't need to worry about
412 keeping it up to date. See glib head for an example of its use.
413 o Some updates to the devhelp contents file generation, as suggested
415 o Fix some bugs in the DocBook XML codepath that were preventing
416 inter-module cross references from being resolved.
417 o Fix some bugs in extraction of object property documentation.
420 GTK-Doc 1.0 (Jan 20 2003)
423 o Added support for "Since:" and "Deprecated:" tags, and look for deprecated
424 guard macros in header files.
425 o Support /*< public >*/ and /*< private >*/ markers for all structs.
426 o New "--ignore-files" option for gtkdoc-mkdb, to ignore files or directories.
427 o Used the "sgml-raw" output type with openjade, to avoid problems with Lynx.
428 o Added .pc pkg-config file which can be used to check the gtk-doc version.
431 GTK-Doc 0.10 (Nov 14 2002)
434 o --output-format option to select whether SGML or XML is generated.
435 o Use openjade or jade when converting SGML to HTML.
436 o Use xsltproc to convert XML to HTML, with a new look.
437 o In XML mode, support XIncludes as an alternative to entities.
438 o In XML mode, create .devhelp files.
439 o List interfaces in the object hierarchy.
440 o Create docs for signals on interfaces.
441 o Generate links between interface and their implementations and
443 o Create docs for child and style properties.
444 o Use blurbs for property documentation.
445 o Allow inline documentation for signals and properties.