release: update news and date in manual
[gtk-doc.git] / NEWS
blobeec1e0c665caab0dd030ced2eb66cd2a70f36949
1 GTK-Doc 1.24  (May 29 2015)
2 ============
4  This is another quick bugfix release for a regression, see bug #749591
6  Changes
8  o 749591 : gtk-doc 1.23 no longer includes xml namespace in .devhelp2 files
9  o 749706 : .gitignore files should not be under version control
10  o 749816 : Support syntax highlighting of different languages (patch included)
11  o 749901 : Strip common indent when highlighting with vim
13  Contributors
15  Daniel Mustieles
16  Dexter Chua
17  Michael Catanzaro
18  Peter De Wachter
19  Stefan Sauer
21 GTK-Doc 1.23  (May 17 2015)
22 ============
24  This is a quick bugfix release for a regression, see bug #749142.
26  Changes
28  o 749142 : Can't build totem-pl-parser from master using gtk-doc 1.22
29  o 749210 : mkman: Use full URL to refer to the docbook manpages stylesheet
31  Contributors
33  Emanuele Aina
34  Stefan Sauer
36 GTK-Doc 1.22    (May 07 2015)
37 ============
39  Important notice - starting with the next release these long deprecated
40  features will be removed - you'll now see a warning if you actually use these
41  features. Please write to gtk-doc-list@gnome.org and tell us your concerns:
42  o gtkdoc-mktmpl - please move all the comments into the sources.
43  o generating html via sgml tools (jade/openjade), using xsltproc and
44    docbook-xslt is pretty common and preferred since version 1.6
46  Changes
48  o 727778 :  –    gtk-doc doesn't understand annotations for GList-contained types
49  o 729911 : Using #TypeName inshort_description makes " - " in HTML index disappear
50  o 732689 : strange result on a generated html page
51  o 734689 :  " Specific - > General " document title format
52  o 736073 : Regression: problems with enum constants
53  o 736725 : Documentation consists mostly of empty space
54  o 741305 : Scanner issue with enum containing value ='{'
55  o 741763 : Example Makefile.am improvements
56  o 741941 : Last function argument missing in docs (possibly due to macro in code)
57  o 743879 : special case G_DECLARE_*_TYPE
58  o 743967 : Make build results reproducible
59  o 744075 : Missing struct members if forward declared in another header
60  o 744368 : gtkdoc-depscan doesn't handle unicode in .devhelp2 files correctly
61  o 746118 : gtkdoc-scan: fix regex for get_type() functions
62  o 746120 : Expand annotation recognition on symbol lines
63  o 746121 : gtkdoc-mkdb: don't warn on 'deprecated entities'
64  o 747207 : Typos in documentation
65  o 747298 : Test still tries to check gtkdoc-scanobj
66  o 748456 : xsl: Enable ToC generation on empty < toc/ > elements
68  Contributors
70  Anders Jonsson
71  Andre Klapper
72  Daniel Mustieles
73  David King
74  Dominique Leuenberger
75  Efstathios Iosifidis
76  Emanuele Aina
77  Fran Diéguez
78  Maria  Mavridou
79  Marvin Schmidt
80  Olav Vitters
81  Philip Withnall
82  Rafael Ferreira
83  Ryan Lortie
84  Stefan Sauer
85  Tom Tryfonidis
86  Xavier Claessens
88 GTK-Doc 1.21    (Jul 17 2014)
89 ============
91  Important notice - starting with the next release these long deprecated
92  features will be removed, please write to gtk-doc-list@gnome.org and tell us
93  your concerns:
94  o gtkdoc-mktmpl - please move all the comments into the sources.
95  o generating html via sgml tools (jade/openjade), using xsltproc and
96    docbook-xslt is pretty common and preferred since version 1.6
98  Changes
100  o 170860 : gtk-doc should have definitions for stability
101  o 644111 : one cannot specify against which libs gtkdoc-fixxref should resolve links (problematic with multiple versions)
102  o 657444 :  " enum foo { ... } " ; not recognized
103  o 671519 : Self-test relies on nonportable (GNU enhanced) 'date' command
104  o 678094 : the word " returns " in a function description can be parsed as the " Returns: " section
105  o 722621 : gtk-doc tarball was created with 32bit uid/gid, unusable with mingw/msys tar
106  o 724739 : Self-test fail: gtkdoc-mkdb misusing perl datatype
107  o 725505 : new syntax highlighting for code is weird
108  o 725663 : configure: non POSIX test usage
109  o 730658 : Deprecation warning for non-deprecated type GParamFlags
110  o 730777 : Add support for nullable and optional annotations
112  Contributors
114  Christophe Fergeau
115  Damon Chaplin
116  Daniel Macks
117  Daniel Mustieles
118  Emmanuele Bassi
119  maria thukididu
120  Naohiro Aota
121  Philip Withnall
122  Rafael Ferreira
123  Stefan Sauer
124  Thomas Wood
125  William Jon McCann
127 GTK-Doc 1.20    (Feb 16 2014)
128 ============
130  Important notice - starting with the next release these long deprecated
131  features will be removed, please write to gtk-doc-list@gnome.org and tell us
132  your concerns:
133  o gtkdoc-scanobj (only used for gtkobject)
134  o return values need to be documented using "Returns:". We will remove the
135    heuristic that turns a paragraph starting with "Returns " into return docs.
136  o gtkdoc-mktmpl - please move all the comments into the sources.
137  o generating html via sgml tools (jade/openjade), using xsltproc and
138    docbook-xslt is pretty common and preferred since version 1.6
140  Changes
142  o 605537 : Returns: listed among parameters
143  o 624001 : Support attribute-based method to deprecate symbols
144  o 662424 : Class hierarchy about interfaces not generated by default
145  o 665926 : should not have to document object structures
146  o 666509 : Specifying --enable-gtk-doc should not be required to build source packages
147  o 669417 : Duplicate IDs generated for unions registered as boxed types
148  o 671519 : Self-test relies on nonportable (GNU enhanced) 'date' command
149  o 692367 : gtkdocize should take a srcdir argument
150  o 696570 : style updates
151  o 697940 : Race condition between setup-build.stamp and scan-build.stamp
152  o 701259 : /bin/bash: -chmod: command not found
153  o 701638 : Support automake parallel test harness (fix error with GTKDOC_CHECK)
154  o 706404 : Minor bug in gtkdoc-mkdb
155  o 706438 : Empty lines added at the beginning and at the end of a programlisting
156  o 707426 : master is broken in picking up flavour from configure.ac
157  o 707717 : Support " Deprecated: X.Y " 
158  o 708268 : New *-insensitive.png files are not distributes
159  o 710478 : gtkdoc-mkdb: Don't complain about annotations with hyphen
160  o 711111 : gtkdoc-mkdb: sort entries in the glossary
161  o 711598 : gtkdoc-scan doesn't ignore decorators containing parentheses
162  o 719644 : docs: make yelp usage conditional in manual
163  o 719645 : configure: emit message when looking for yelp
164  o 720061 : make: create subdirectories of the content_files to the  builddir
165  o 721228 : configure: search for xml catalog in XDG_DATA_DIRS
166  o 722479 : cp -u is not portable
167  o 723118 : Mark |[ blocks as CDATA
168  o 723288 : Fix MarkDown support
169  o 723417 : New MarkDown parser
170  o 723696 : Add support for blockquote
171  o 723812 : Add support for reference links
172  o 723913 : List in markdown: < p > inside the last element of a < ul > list
173  o 723991 : Improve the display of the synopsis
174  o 724002 : gtkdoc-scan: Fix use of uninitialised value in trace logging
176  Contributors
178  Alban Browaeys
179  Alexander Kanavin
180  Carlos Garcia Campos
181  Christian Kirbach
182  Daniel Mustieles
183  David King
184  David Nečas
185  Dieter Verfaillie
186  Dimitris Spingos
187  Hib Eris
188  Matthias Clasen
189  Philip Chimento
190  Philip Withnall
191  Rafael Ferreira
192  Rico Tzschichholz
193  Ryan Lortie
194  Sebastian Rasmussen
195  Sébastien Wilmet
196  Stefan Sauer
197  Stef Walter
198  William Jon McCann
199  Zbigniew Jędrzejewski-Szmek
201 GTK-Doc 1.19    (Jun 05 2013)
202 ============
204  Changes
206  o 652740 : Warnings during expansion of content files
207  o 660436 : Warning for skip annotations on function parameters
208  o 661853 : allow EXTRA_DIST to be predefined
209  o 668228 : several of the tests use syntax not compatible with traditional Bourne shells
210  o 670724 : gtk-doc.make: double recursion when maintainer-clean
211  o 670767 : generated file gnome-doc-utils.m4 is in version control
212  o 670796 : (patch) Show commands when building documentation with make
213  o 671519 : Self-test relies on nonportable (GNU enhanced) 'date' command
214  o 671960 : make dist fails without html/*
215  o 672710 : Use new documentation infrastructure
216  o 676685 : Allow to order functions without using $MODULE-sections.txt
217  o 685365 : (PATCH) Fix contents of warning message, should be " -sections.txt " not " -section.txt " 
218  o 686148 : [patch] suggested parameters for gtkdoc-scangobj
219  o 687685 : 'g_type_init' is deprecated
220  o 688204 : undocumented enum values missing in indexes
221  o 688423 : Add support for " transfer floating " introspection annotation
222  o 689209 : Automake complains about trailing space after backslash.
223  o 690438 : Small improvements
224  o 696930 : Incorrect allowed value for a property
225  o 700981 : make: copy the files with their relative path included
227  Contributors
229  Alban Browaeys
230  Aleksander Morgado
231  Alexandre Franke
232  Bruno Brouard
233  Colin Walters
234  Daiki Ueno
235  Daniel Mustieles
236  David King
237  David Nečas
238  Dieter Verfaillie
239  Dimitris Spingos
240  dmustieles
241  Henrik Stokseth
242  Hib Eris
243  Javier Jardón
244  Jens Georg
245  Jiro Matsuzawa
246  Krzesimir Nowak
247  Mario Blättermann
248  Martin Pitt
249  Matthias Clasen
250  Murray Cumming
251  Piotr Drąg
252  Ryan Lortie
253  Sébastien Wilmet
254  Simon Josefsson
255  Stefan Sauer
256  Stef Walter
257  Takao Fujiwara
258  Tim Mooney
259  Tom Tryfonidis
260  黄世海
263 GTK-Doc 1.18    (Sep 14 2011)
264 ============
266  o gtk-doc supports a subset of markdown (headings and lists) - see
267    http://git.gnome.org/browse/gtk-doc/tree/tests/gobject/src/gobject.c
268  o gtk-doc does not generate old devhelp files any more. This cuts down doc
269    generation time and works for devhelp >=0.11 (was released in 2005).
270  o changes for out-of-source dir build caused breakage for projects using
271    DOC_SOURCE_DIR with a relative path (to builddir). It is recommended to use 
272    DOC_SOURCE_DIR=$(top_srcdir)/src/xxx.
274  Changes
276  o 590927 : Support AM_SILENT_RULES for doc-build steps
277  o 617121 : /* < private > */ declarations in enums are still displayed
278  o 627758 : A way to ignore a symbol
279  o 639145 : shorthand syntax for headings
280  o 644291 : Enum parser breaks on assignment of ')'
281  o 646870 : HTML_IMAGES no longer in EXTRA_DIST
282  o 648289 : gtkdoc-mkdb doesn't compile.
283  o 648331 : Specify compatible options for 'highlight' consistently.
284  o 649269 : gtkdoc-scanobj should set some of its own CFLAGS/LDFLAGS
285  o 650407 : Buildings docs while distchecking produces thousands of “No declaration found” warnings, then fails.
286  o 652746 : Documentation of plain boxed structs broken
287  o 652764 : Update autotools config a bit
288  o 655711 : summarize depscan output by package
289  o 656453 : Performance improvements (PATCH)
290  o 656658 : gtk-doc.make: install target doesn't install docs when building in a separate directory
291  o 656773 : gtk-doc fails to find a symbol declared as 'char* const'
292  o 656946 : gtk-doc unable to handle 'extern short int'
293  o 657377 : srcdir!=builddir builds discard contents of tmpl
295  Contributors
297  Bakaoukas Nikolaos
298  Claude Paroz
299  Daniel Mustieles
300  David Necas
301  David Nečas
302  Javier Jardón
303  Jorge González
304  Mario Blättermann
305  Matthias Clasen
306  Michał Górny
307  Shaun McCance
308  Stefan Sauer (Kost)
309  Will Thompson
310  Yaakov Selkowitz
313 GTK-Doc 1.17    (Feb 16 2011)
314 ============
316  Changes
318  o 127049 : building reference documentation fails when builddir != srcdir
319  o 640241 : non-srcdir builds busted
321  Contributors
323  Daniel Mustieles
324  Javier Jardón
325  Stefan Kost
327 GTK-Doc 1.16    (Jan 14 2011)
328 ============
330  o gtkdoc-check can do more checks, one might need to update Makefile.am from
331    the examples/Makefile.am
333  Changes
335  o 625776 : serialise doubles and floats always with a decimal dot
336  o 627269 : link to signalflags docs from signal descriptions
337  o 467488 : GTK+ man pages request
338  o 481811 : Inline function bodies are confused with declarations
339  o 501107 : EXTRA_DIST automake warnings
340  o 512565 : add GTK_DOC_IGNORE
341  o 518427 : documentation best pratices needed
342  o 597937 : Function pointers as parameters to other functions are parsed improperly
343  o 612028 : gtkdoc-fixxref should call /usr/bin/vim -n -e -u NONE -T xterm
344  o 617478 : Tooltip is a nuisance
345  o 618379 : Navigation is hiding anchors title
346  o 620249 : invalid xml for object_index with (n_objects % 3) == 0
347  o 621931 : support GType and GVariant types
348  o 622971 : List of typos in the GTK-doc manual
349  o 623777 : G_TYPE_STRV in signals generate wrong docs
350  o 623968 : gtkdoc-mkdb generates invalid xml from sgml in inline comments
351  o 624199 : parser picks up contents of large macros
352  o 624200 : 'const' confuses the parser
353  o 627223 : gtkdoc-fixxref vim highlight fails on xhtml suffix
354  o 627920 : `make check` rule to list xml files missing from DOC_MAIN_SGML_FILE
355  o 628611 : gtk-doc > = 1.13 creates automagic dependencies on syntax highlighters
356  o 628794 : Issue in gtkdoc-mkman.in
357  o 630288 : Fix 'scope notified' annotation
358  o 631336 : remove lists of gtk+ signal args in gtkdoc-scanobj and -scangobj
359  o 632587 : gtkdoc-scanner fails to identify (closure) annotation
360  o 638330 : const in parameter list is ignored
361  o 638831 : Support GTK+ 3 cell properties
363  Contributors
365  Bruno Brouard
366  Christian Persch
367  Claude Paroz
368  Gilles Dartiguelongue
369  Javier Jardón
370  Jorge González
371  Maarten Bosmans
372  Mario Blättermann
373  Matej Urbančič
374  Matthias Clasen
375  Pablo Castellano
376  P. F. Chimento
377  Philip Withnall
378  Rodrigo Aliste
379  Simón Pena
380  Stefan Kost
381  Tim-Philipp Müller
382  Vasilis Tsivikis
384 GTK-Doc 1.15    (May 21 2010)
385 ============
387  Changes
389  o 614496 : Support for multiple DOC_SOURCE_DIR directories
390  o 615550 : gtk-doc fails to recognize (scope ...) and (skip) annotations
392  Contributors
394  Andreas Rottmann
395  Jorge González
396  Nicola Fontana
397  Nikos Bakaoukas
398  Stefan Kost
400 GTK-Doc 1.14    (Mar 28 2010)
401 ============
403  Changes
405  o 593282 : Append " _struct " prefix to every struct name
406  o 599514 : sane support for per-page images
407  o 604892 : checks fail
408  o 613611 : parameter descriptions with annotations truncated at first \n
409  o 115531 : add short description to index entries
410  o 165425 : gtk-doc fails to parse unions
411  o 512155 : gets confused by multiline typedef
412  o 568711 : undocumented enum values are not reported
413  o 590602 : secondly running gtkdoc-mkdb will generate DOCTYPE missing XML files
414  o 590625 : $(DOC_MODULE)-overrides.txt is required by " make dist " 
415  o 591975 : Section_Id always embeds a trailing newline
416  o 604885 : Fix the use of gtkdocize --flavour option
417  o 604992 : gtkdoc-fixxref broken link warning is broken for functions
418  o 604995 : Syntax error in gtkdoc-mkman
419  o 604998 : Check for syntax errors in the test suite
420  o 605052 : put class structs to the generated section file
421  o 605211 : Many build failures with gtk-doc 1.13
422  o 605281 : Add " Since " and " Deprecated " tag to function example
423  o 605285 : Add < keycap > and < keycombo > example
424  o 605289 : Some documentation improvements
425  o 605452 : Added more info to " Documenting symbols " sectio
426  o 605564 : Env var equivalent to --flavour=no-tmpl
427  o 606661 : XInclude error while gnerating documentation
428  o 607445 : gtk-doc does not support long double as returned value type
429  o 607531 : Execute system() calls in subshells to ease debugging
430  o 609062 : [All-langs] [gtk-doc] Translated *.po files not available within ~/po directory
431  o 609194 : sort interface implementers
432  o 610255 : Self-test failure in git as of 2010-02-17: FAIL: gobject.sh
433  o 610257 : Patch to make GTK-DOC notice functions/variables with 'signed' prototypes
434  o 611848 : gtk-doc produces invalid DocBook markup if the SECTION ends with a tag that cannot be nested inside < para > 
436  Contributors
438  Bruno Brouard
439  David Nečas
440  Emilio Pozuelo Monfort
441  Francisco Javier F. Serrador
442  Javier Jardón
443  Jorge González
444  Loïc Minier
445  Mario Blättermann
446  Marios Zindilis
447  Nicola Fontana
448  Philip Chimento
449  Runa Bhattacharjee
450  Ryan Lortie
451  Simon Josefsson
452  Simon McVittie
453  Stefan Kost
454  Sweta Kothari
455  Vincent Untz
456  Felix Iyadurai
457  krishnababu k
459 GTK-Doc 1.13    (Dec 18 2009)
460 ============
462  o 604891 : gtk-doc tarball does not build
464  Contributors
466  Stefan Kost
468 GTK-Doc 1.12    (Dec 18 2009)
469 ============
471  Changes
473  o 591450 : Build related fixes
474  o 466535 : generate documentation as pdf
475  o 502191 : acronym support
476  o 532395 : inline function parsing problems (e.g. in glib api docs)
477  o 536928 : have syntax highlghted and xrefs source code samples
478  o 562064 : index generation trouble
479  o 562310 : glib 2.18.3: /bin/sh: line 1: gtkdoc-rebase: command not found
480  o 562655 : doesn't produce deprecation note for signals
481  o 565126 : linking to struct members
482  o 565835 : Three spelling errors in gtk-doc-manual
483  o 566911 : add support for --help and --version to remaining tools
484  o 567132 : Take FOO_GET_INTERFACE as standard
485  o 568702 : gtkdoc-mkhtml no longer works when symlinked
486  o 568706 : gtkdoc-scan: use CamelCase id for interfaces
487  o 568708 : gtkdoc-scan should try not to scan files twice
488  o 568714 : Perl errors when syntax highlighting is not available
489  o 568732 : missing long descriptions undetected
490  o 568734 : configure check for gtk-doc prints that gtk-doc cannot be built
491  o 569339 : abbreviation are not expanded at the start of text
492  o 572396 : Fix to use shave + gtk-doc + libtool 1.x
493  o 572612 : Mistakenly substitute -1 with G_MAXULONG in x86_64
494  o 572967 : use g_strerror
495  o 574654 : --ignore-decorators does not ignore trailing stuff
496  o 575574 : Be more friendly for files with a space in their name
497  o 575623 : Update FSF address
498  o 575711 :  < table > element mismatch in highlighted code
499  o 576313 : implicit declarations in testsuite ?
500  o 577059 : Gnome-doc support can't be disabled
501  o 577774 : Test suite run even when built with --disable-gtk-doc
502  o 580206 : gcc warnings in < module > -scan.c
503  o 580300 : gtkdoc-scan picks up _get_type functions it should not
504  o 580622 : xml dir is both part of distclean and dist rules
505  o 581237 : gtk-doc uses wrong gtkdoc-check in " make check " phase
506  o 584952 :  " uninitialized value in concatenation " gtkdoc-mkdb line 938
507  o 587103 : return values of function-like macros
508  o 587196 : Typo in a string
509  o 589426 : Python is a required dependency
510  o 591789 : master FTBFS with automake 1.11
511  o 594224 : Please fix manual about inlined SECTION comments (and show warnings when invalid)
512  o 596730 : Signed vs. unsigned comparison in gtkdoc-scangobj.in causing compile errors
513  o 596731 : autogen.sh doesn't recognize automake-1.11
514  o 602026 : Warn if non-existing function gets referenced
515  o 602518 : Doesn't support " long int " return type
516  o 604798 : tests/fail.sh and tests/tools.sh.in use bashisms
518  Contributors
520  Claude Paroz
521  Dan Williams
522  Daniel Mustieles
523  Daniel Nylander
524  H. Habighorst
525  Jannis Pohlmann
526  Javier Jardón
527  Jennie Petoumenou
528  Jorge González
529  Mario Blättermann
530  Nicola Fontana
531  Philip Chimento
532  Philip Withnall
533  Simos Xenitellis
534  Stefan Kost
535  Sven Herzberg
538 GTK-Doc 1.11    (Nov 16 2008)
539 ============
541  Changes
543  o 531572 : one-page generation option
544  o 448879 : Use a footer when generating HTML documentation
545  o 311857 : xsltproc very slow generating index for gtk-docs.sgml
546  o 335239 : Using gnome-doc-utils for gtk-doc documentation
547  o 460753 : enable vpath build in gtkdoc-mkhtml
548  o 473342 : Warn about repeated symbols in sections
549  o 487727 : DocBook XML DTD version
550  o 523669 : make check: Element publisher content does not follow the...
551  o 530758 : gtk-doc should not expand XML tags and their attributes
552  o 533262 : no-template mode scans different source files
553  o 534627 : gtk-doc uses non-standard HTML element
554  o 542137 : No declaration found for: gsf_output_*
555  o 543855 : Fix for Bug 460753 (enable vpath build in gtkdoc-mkhtml) ...
556  o 544172 : Fails to parse return value of 'char const *'
557  o 552822 : Add rules to create $(REPORT_FILES)
558  o 553407 : Example Makefile.am uses obsolete INCLUDES instead of AM_...
559  o 554718 : gtk-doc needs to allow versioned TARGET_DIR
560  o 554833 : Be more careful with " struct _ < struct_name >  " 
561  o 558082 : evince docs build fails with GTK_DISABLE_SINGLE_INCLUDES
562  o 559281 : Correct check for existance of gtkdoc-rebase
564  Contributors
566  Behdad Esfahbod
567  Christian Persch
568  David Nečas
569  Felix Riemann
570  Jeffrey Stedfast
571  Marc-Andre Lureau
572  Matthew Barnes
573  Peter Kjellerstedt
574  Sebastian Dröge
575  Simon Josefsson
576  Stefan Kost
579 GTK-Doc 1.10    (Mar 20 2008)
580 ============
582  Changes
584  o 460753 : enable vpath build in gtkdoc-mkhtml
585  o 503119 : Add dependency on content_files to SGML target
586  o 127049 : building reference documentation fails when builddir != s...
587  o 481811 : Inline function bodies are confused with declarations
588  o 448879 : Use a footer when generating HTML documentation
589  o 492005 : Deprecation guard warnings for properties and signals
590  o 498521 : Inconsistent compiler flags passed in gtk-doc.make
591  o 365913 : gtk-doc output is not predictable
592  o 446648 : gtk-doc does not handle forward typedef'd enums
593  o 468278 : Display proper types for properties
594  o 497367 : don't use US-ASCII for output encoding
595  o 501066 : Missing quotes around gtkdoc-rebase check cause a warning
596  o 508897 : [PATCH] Fix build when gtk-doc is not installed
597  o 509539 : Building documentation aborts when no .types file is present
598  o 512154 : Struct member type attributes are limited to one token
599  o 513318 : gtk-doc.el doesn't work fine with emacs22
601  Contributors
603  Benjamin Otte
604  Carlos Garnacho
605  Damon Chaplin
606  David Nečas
607  Frederic Peters
608  Joe Marcus Clarke
609  Kouhei Sutou
610  Loïc Minier
611  Mathias Hasselmann
612  Petteri Räty
613  Rouslan Solomakhin
614  Stefan Kost
615  Sven Herzberg
616  Yeti
619 GTK-Doc 1.9     (Sep 30 2007)
620 ===========
622  Changes
624  o 419308 : unsynced regexps for parameter parsing
625  o 449618 : Top navigation bar is in the way
626  o 453717 : fixxref logic to determine absolute path's is flawed
627  o 457173 : unit tests for gtk-doc
628  o 465920 : Use gtkdoc-rebase
629  o 467773 : default master doc should have proper extension
630  o 141869 : Poor error generated when faced with a type declared as '...
631  o 156643 : Avoid make error in gtk-doc.make
632  o 322035 : wrong macro parsing
633  o 323938 : gtk-doc.m4 check is silent
634  o 324535 : gtk-doc doesn't handle deprecation inside enumerations
635  o 355352 : If you don't have an instantiatable type for a gtypeinter...
636  o 379466 : Improve C parser to handle TYPE\nVARIABLE in function pro...
637  o 380824 : docs are truncated if line begins with '* returns '
638  o 383456 : ' make check ' test for 100% documentation
639  o 411739 : Gtk-doc fails to handle ' struct tm * function_name (); ' 
640  o 415388 : Please clean -undocumented.txt files
641  o 418027 : gtkdoc-mkdb does not handle #ifdef in enum {}
642  o 419997 : parameter name trouble
643  o 428596 : Warnings with gtk-doc.m4 macros
644  o 434134 : fixxrefs like sed for installing pregenerated docs
645  o 436565 : Report undeclared symbols into a file
646  o 445596 : Impossible to link a page with an anchor
647  o 445693 : Does not understand ' unsigned long ' as a type
648  o 450338 : Make gtk-doc.m4 fail when needed gtk-doc is not installed
649  o 454916 : gtk-doc should permit generation of URI-based cross-refer...
650  o 457077 : add --no-implicit-returns to gtkdoc-mkdb
651  o 459225 : Accept automake-1.10 in autogen.sh
652  o 459725 : ' jhbuild build gtk-doc ' fails on make
653  o 460127 : parsing nested union/structs confuses public/private state
654  o 465365 : [PATCH] gtk-doc does not compile
655  o 466559 : [CSS] styling <hr />; 
656  o 471014 : G_CONST_RETURN * G_CONST_RETURN * function not picked up
657  o 477532 : function variables
658  o 479913 : gtk-doc.notmpl.make is not distributed
659  o 479923 : distclean test output properly
661  Contributors
663  Benjamin Otte
664  Damon Chaplin
665  David Nečas
666  Frederic Peters
667  Loic Minier
668  Petteri Räty
669  Rouslan Solomakhin
670  Stefan Kost
671  Sven Herzberg
672  Yeti
675 GTK-Doc 1.8     (Feb 16 2007)
676 ===========
678  o Made it easier to include example code in the source code comment blocks.
679    "|[ ... ]|" can be used to delineate example code (it just gets converted
680    to "<informalexample><programlisting>"), and most of the text in example
681    code is left as it is. The only thing that is still expanded is
682    '#' to allow links to a symbol's documentation, e.g. '#GtkWidget'.
683  o Made the field widths wider for the HTML output, so it looks a bit nicer.
684  o Added a '--rebuild-sections' option to gtkdoc-scan to automatically rebuild
685    the MODULE-sections.txt file. This only works if all the header files are
686    organized neatly and functions don't need rearranging in the docs.
687  o Added a '--rebuild-types' option to gtkdoc-scan to automatically rebuild
688    the MODULE.types file, so you don't need to add new types manually.
689  o Leave CDATA sections as they are, in the extra XML content files and within
690    source code comment blocks.
691  o Allow the section id and #include's to be set within the "SECTION:" comment
692    block, using "@Section_ID:xxx" and "@Include:".
693  o Added "--default-includes" option to specify the default #include's (for
694    people who are using --rebuild-sections and so can't specify it in
695    MODULE-sections.txt).
696  o Added a '--query-child-properties' argument to help document child
697    properties of arbitrary GObjects (used by things like canvas widgets).
698  o Fixed documentation of signals of interfaces.
701 GTK-Doc 1.7     (Jul 29 2006)
702 ===========
704  o Fixed bug that resulted in empty "@:" lines in the templates.
705  o Fixed a few bugs with the XSL code.
706  o Supported a few more variations of C syntax.
707  o Remove the internally-used '-struct' suffix from links to widget structs.
708  o Fixed a few missing build dependencies.
709  o Added a new "C-x4s" binding to the emacs lisp code, to insert a blank
710    section header in the source code.
711  o Fixed bug that ignored inline section header docs with '-' in their names.
712  o Added a 'make docs' target that can be used to build the docs even when
713    gtk-doc has been disabled at configure time.
716 GTK-Doc 1.6     (Apr 9 2006)
717 ===========
719  o Removed the hard dependancy on openjade or jade, since XML is used mainly
720    now rather than SGML.
721  o Install the .pc file in $(datadir) rather than $(libdir) since gtk-doc is
722    architecture-independant.
723  o Added "--ignore-decorators" option to ignore a list of declarators in
724    function declarations.
725  o Support '#Object::signal'/'#Object:property' to link to signals/properties
726  o Fixed missing index terms.
729 GTK-Doc 1.5     (Mar 7 2006)
730 ===========
732  o Output the new version of devhelp2 information, but still generate the old
733    devhelp files so older versions of DevHelp still work OK.
734  o Fixed the initial creation of the *-sections.txt file so the object
735    hierarchy, signals and properties all work automatically.
736  o Show information about signal flags (run first/last).
737  o Support a --source-suffixes argument specifying which source files to scan.
738  o Support other root object types besides GObject and GInterface.
739  o Use a fixed navigation bar for the generated documentation.
740  o New documentation from Stefan Kost.
741  o Handle more variations of C syntax.
744 GTK-Doc 1.4     (Jul 3 2005)
745 ===========
747  o Support section documentation (title, short description, long description
748    and 'see also') within the source code. I think everything can now be
749    documented within the source code.
750  o Support Stable/Unstable/Private stability levels for everything.
753 GTK-Doc 1.3     (Jan 9 2005)
754 ===========
756  o Use the new style.css stylesheet instead of hard-wiring the styles.
757  o Updated the documentation and example build files.
758  o Added support for a gallery of widget images.
759  o Output default values for widget properties and allowed ranges.
760  o Only underline links in the docs when the mouse hovers over them.
761  o Added support for placing the parameter table anywhere within the function
762    documentation (using the "<!--PARAMETERS-->" marker).
763  o Handle more variations of C syntax.
766 GTK-Doc 1.2     (Feb 16 2004)
767 ===========
769  o Added widget signals and properties to undocumented output and statistics.
770  o Added support for an index of all symbols.
771  o Emit "Since:" information for signals and properties.
772  o Added derived subclasses and interfaces to the widget hierarchies.
773  o Added .cat SGML catalog file.
774  o Support properties on interfaces. 
775  o Added "--help" options to the scripts.
778 GTK-Doc 1.1     (Apr 18 2003)
779 ===========
781  o Add a gtk-doc.m4 macro that allows packages to provide consistent
782    checking for gtk-doc.
783  o Check to make sure that the XML catalog actually contains entries
784    for the DocBook XML DTD and XSLT stylesheets.  Please consult the
785    README file if your system's XML catalog isn't set up.
786  o Add infrastructure for including the standard gtk-doc makefile
787    glue, so that maintainers of packages don't need to worry about
788    keeping it up to date.  See glib head for an example of its use.
789  o Some updates to the devhelp contents file generation, as suggested
790    by Hallski.
791  o Fix some bugs in the DocBook XML codepath that were preventing
792    inter-module cross references from being resolved.
793  o Fix some bugs in extraction of object property documentation.
796 GTK-Doc 1.0     (Jan 20 2003)
797 ===========
799  o Added support for "Since:" and "Deprecated:" tags, and look for deprecated
800    guard macros in header files.
801  o Support /*< public >*/ and /*< private >*/ markers for all structs.
802  o New "--ignore-files" option for gtkdoc-mkdb, to ignore files or directories.
803  o Used the "sgml-raw" output type with openjade, to avoid problems with Lynx.
804  o Added .pc pkg-config file which can be used to check the gtk-doc version.
807 GTK-Doc 0.10    (Nov 14 2002)
808 ============
810  o --output-format option to select whether SGML or XML is generated. 
811  o Use openjade or jade when converting SGML to HTML.
812  o Use xsltproc to convert XML to HTML, with a new look.
813  o In XML mode, support XIncludes as an alternative to entities.
814  o In XML mode, create .devhelp files. 
815  o List interfaces in the object hierarchy.
816  o Create docs for signals on interfaces.
817  o Generate links between interface and their implementations and
818    prerequisites.
819  o Create docs for child and style properties.
820  o Use blurbs for property documentation.
821  o Allow inline documentation for signals and properties.