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