Debian Codegraph @

NEWS

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