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