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