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