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