1 GTK-Doc 1.20.1 (... .. 2014)
6 GTK-Doc 1.20 (Feb 16 2014)
9 Important notice - starting with the next release these long deprecated
10 features will be removed, please write to gtk-doc-list@gnome.org and tell us
12 o gtkdoc-scanobj (only used for gtkobject)
13 o return values need to be documented using "Returns:". We will remove the
14 heuristic that turns a paragraph starting with "Returns " into return docs.
15 o gtkdoc-mktmpl - please move all the comments into the sources.
16 o generating html via sgml tools (jade/openjade), using xsltproc and
17 docbook-xslt is pretty common and preferred since version 1.6
21 o 605537 : Returns: listed among parameters
22 o 624001 : Support attribute-based method to deprecate symbols
23 o 662424 : Class hierarchy about interfaces not generated by default
24 o 665926 : should not have to document object structures
25 o 666509 : Specifying --enable-gtk-doc should not be required to build source packages
26 o 669417 : Duplicate IDs generated for unions registered as boxed types
27 o 671519 : Self-test relies on nonportable (GNU enhanced) 'date' command
28 o 692367 : gtkdocize should take a srcdir argument
29 o 696570 : style updates
30 o 697940 : Race condition between setup-build.stamp and scan-build.stamp
31 o 701259 : /bin/bash: -chmod: command not found
32 o 701638 : Support automake parallel test harness (fix error with GTKDOC_CHECK)
33 o 706404 : Minor bug in gtkdoc-mkdb
34 o 706438 : Empty lines added at the beginning and at the end of a programlisting
35 o 707426 : master is broken in picking up flavour from configure.ac
36 o 707717 : Support " Deprecated: X.Y "
37 o 708268 : New *-insensitive.png files are not distributes
38 o 710478 : gtkdoc-mkdb: Don't complain about annotations with hyphen
39 o 711111 : gtkdoc-mkdb: sort entries in the glossary
40 o 711598 : gtkdoc-scan doesn't ignore decorators containing parentheses
41 o 719644 : docs: make yelp usage conditional in manual
42 o 719645 : configure: emit message when looking for yelp
43 o 720061 : make: create subdirectories of the content_files to the builddir
44 o 721228 : configure: search for xml catalog in XDG_DATA_DIRS
45 o 722479 : cp -u is not portable
46 o 723118 : Mark |[ blocks as CDATA
47 o 723288 : Fix MarkDown support
48 o 723417 : New MarkDown parser
49 o 723696 : Add support for blockquote
50 o 723812 : Add support for reference links
51 o 723913 : List in markdown: < p > inside the last element of a < ul > list
52 o 723991 : Improve the display of the synopsis
53 o 724002 : gtkdoc-scan: Fix use of uninitialised value in trace logging
78 Zbigniew Jędrzejewski-Szmek
80 GTK-Doc 1.19 (Jun 05 2013)
85 o 652740 : Warnings during expansion of content files
86 o 660436 : Warning for skip annotations on function parameters
87 o 661853 : allow EXTRA_DIST to be predefined
88 o 668228 : several of the tests use syntax not compatible with traditional Bourne shells
89 o 670724 : gtk-doc.make: double recursion when maintainer-clean
90 o 670767 : generated file gnome-doc-utils.m4 is in version control
91 o 670796 : (patch) Show commands when building documentation with make
92 o 671519 : Self-test relies on nonportable (GNU enhanced) 'date' command
93 o 671960 : make dist fails without html/*
94 o 672710 : Use new documentation infrastructure
95 o 676685 : Allow to order functions without using $MODULE-sections.txt
96 o 685365 : (PATCH) Fix contents of warning message, should be " -sections.txt " not " -section.txt "
97 o 686148 : [patch] suggested parameters for gtkdoc-scangobj
98 o 687685 : 'g_type_init' is deprecated
99 o 688204 : undocumented enum values missing in indexes
100 o 688423 : Add support for " transfer floating " introspection annotation
101 o 689209 : Automake complains about trailing space after backslash.
102 o 690438 : Small improvements
103 o 696930 : Incorrect allowed value for a property
104 o 700981 : make: copy the files with their relative path included
142 GTK-Doc 1.18 (Sep 14 2011)
145 o gtk-doc supports a subset of markdown (headings and lists) - see
146 http://git.gnome.org/browse/gtk-doc/tree/tests/gobject/src/gobject.c
147 o gtk-doc does not generate old devhelp files any more. This cuts down doc
148 generation time and works for devhelp >=0.11 (was released in 2005).
149 o changes for out-of-source dir build caused breakage for projects using
150 DOC_SOURCE_DIR with a relative path (to builddir). It is recommended to use
151 DOC_SOURCE_DIR=$(top_srcdir)/src/xxx.
155 o 590927 : Support AM_SILENT_RULES for doc-build steps
156 o 617121 : /* < private > */ declarations in enums are still displayed
157 o 627758 : A way to ignore a symbol
158 o 639145 : shorthand syntax for headings
159 o 644291 : Enum parser breaks on assignment of ')'
160 o 646870 : HTML_IMAGES no longer in EXTRA_DIST
161 o 648289 : gtkdoc-mkdb doesn't compile.
162 o 648331 : Specify compatible options for 'highlight' consistently.
163 o 649269 : gtkdoc-scanobj should set some of its own CFLAGS/LDFLAGS
164 o 650407 : Buildings docs while distchecking produces thousands of “No declaration found” warnings, then fails.
165 o 652746 : Documentation of plain boxed structs broken
166 o 652764 : Update autotools config a bit
167 o 655711 : summarize depscan output by package
168 o 656453 : Performance improvements (PATCH)
169 o 656658 : gtk-doc.make: install target doesn't install docs when building in a separate directory
170 o 656773 : gtk-doc fails to find a symbol declared as 'char* const'
171 o 656946 : gtk-doc unable to handle 'extern short int'
172 o 657377 : srcdir!=builddir builds discard contents of tmpl
192 GTK-Doc 1.17 (Feb 16 2011)
197 o 127049 : building reference documentation fails when builddir != srcdir
198 o 640241 : non-srcdir builds busted
206 GTK-Doc 1.16 (Jan 14 2011)
209 o gtkdoc-check can do more checks, one might need to update Makefile.am from
210 the examples/Makefile.am
214 o 625776 : serialise doubles and floats always with a decimal dot
215 o 627269 : link to signalflags docs from signal descriptions
216 o 467488 : GTK+ man pages request
217 o 481811 : Inline function bodies are confused with declarations
218 o 501107 : EXTRA_DIST automake warnings
219 o 512565 : add GTK_DOC_IGNORE
220 o 518427 : documentation best pratices needed
221 o 597937 : Function pointers as parameters to other functions are parsed improperly
222 o 612028 : gtkdoc-fixxref should call /usr/bin/vim -n -e -u NONE -T xterm
223 o 617478 : Tooltip is a nuisance
224 o 618379 : Navigation is hiding anchors title
225 o 620249 : invalid xml for object_index with (n_objects % 3) == 0
226 o 621931 : support GType and GVariant types
227 o 622971 : List of typos in the GTK-doc manual
228 o 623777 : G_TYPE_STRV in signals generate wrong docs
229 o 623968 : gtkdoc-mkdb generates invalid xml from sgml in inline comments
230 o 624199 : parser picks up contents of large macros
231 o 624200 : 'const' confuses the parser
232 o 627223 : gtkdoc-fixxref vim highlight fails on xhtml suffix
233 o 627920 : `make check` rule to list xml files missing from DOC_MAIN_SGML_FILE
234 o 628611 : gtk-doc > = 1.13 creates automagic dependencies on syntax highlighters
235 o 628794 : Issue in gtkdoc-mkman.in
236 o 630288 : Fix 'scope notified' annotation
237 o 631336 : remove lists of gtk+ signal args in gtkdoc-scanobj and -scangobj
238 o 632587 : gtkdoc-scanner fails to identify (closure) annotation
239 o 638330 : const in parameter list is ignored
240 o 638831 : Support GTK+ 3 cell properties
247 Gilles Dartiguelongue
263 GTK-Doc 1.15 (May 21 2010)
268 o 614496 : Support for multiple DOC_SOURCE_DIR directories
269 o 615550 : gtk-doc fails to recognize (scope ...) and (skip) annotations
279 GTK-Doc 1.14 (Mar 28 2010)
284 o 593282 : Append " _struct " prefix to every struct name
285 o 599514 : sane support for per-page images
286 o 604892 : checks fail
287 o 613611 : parameter descriptions with annotations truncated at first \n
288 o 115531 : add short description to index entries
289 o 165425 : gtk-doc fails to parse unions
290 o 512155 : gets confused by multiline typedef
291 o 568711 : undocumented enum values are not reported
292 o 590602 : secondly running gtkdoc-mkdb will generate DOCTYPE missing XML files
293 o 590625 : $(DOC_MODULE)-overrides.txt is required by " make dist "
294 o 591975 : Section_Id always embeds a trailing newline
295 o 604885 : Fix the use of gtkdocize --flavour option
296 o 604992 : gtkdoc-fixxref broken link warning is broken for functions
297 o 604995 : Syntax error in gtkdoc-mkman
298 o 604998 : Check for syntax errors in the test suite
299 o 605052 : put class structs to the generated section file
300 o 605211 : Many build failures with gtk-doc 1.13
301 o 605281 : Add " Since " and " Deprecated " tag to function example
302 o 605285 : Add < keycap > and < keycombo > example
303 o 605289 : Some documentation improvements
304 o 605452 : Added more info to " Documenting symbols " sectio
305 o 605564 : Env var equivalent to --flavour=no-tmpl
306 o 606661 : XInclude error while gnerating documentation
307 o 607445 : gtk-doc does not support long double as returned value type
308 o 607531 : Execute system() calls in subshells to ease debugging
309 o 609062 : [All-langs] [gtk-doc] Translated *.po files not available within ~/po directory
310 o 609194 : sort interface implementers
311 o 610255 : Self-test failure in git as of 2010-02-17: FAIL: gobject.sh
312 o 610257 : Patch to make GTK-DOC notice functions/variables with 'signed' prototypes
313 o 611848 : gtk-doc produces invalid DocBook markup if the SECTION ends with a tag that cannot be nested inside < para >
319 Emilio Pozuelo Monfort
320 Francisco Javier F. Serrador
338 GTK-Doc 1.13 (Dec 18 2009)
341 o 604891 : gtk-doc tarball does not build
347 GTK-Doc 1.12 (Dec 18 2009)
352 o 591450 : Build related fixes
353 o 466535 : generate documentation as pdf
354 o 502191 : acronym support
355 o 532395 : inline function parsing problems (e.g. in glib api docs)
356 o 536928 : have syntax highlghted and xrefs source code samples
357 o 562064 : index generation trouble
358 o 562310 : glib 2.18.3: /bin/sh: line 1: gtkdoc-rebase: command not found
359 o 562655 : doesn't produce deprecation note for signals
360 o 565126 : linking to struct members
361 o 565835 : Three spelling errors in gtk-doc-manual
362 o 566911 : add support for --help and --version to remaining tools
363 o 567132 : Take FOO_GET_INTERFACE as standard
364 o 568702 : gtkdoc-mkhtml no longer works when symlinked
365 o 568706 : gtkdoc-scan: use CamelCase id for interfaces
366 o 568708 : gtkdoc-scan should try not to scan files twice
367 o 568714 : Perl errors when syntax highlighting is not available
368 o 568732 : missing long descriptions undetected
369 o 568734 : configure check for gtk-doc prints that gtk-doc cannot be built
370 o 569339 : abbreviation are not expanded at the start of text
371 o 572396 : Fix to use shave + gtk-doc + libtool 1.x
372 o 572612 : Mistakenly substitute -1 with G_MAXULONG in x86_64
373 o 572967 : use g_strerror
374 o 574654 : --ignore-decorators does not ignore trailing stuff
375 o 575574 : Be more friendly for files with a space in their name
376 o 575623 : Update FSF address
377 o 575711 : < table > element mismatch in highlighted code
378 o 576313 : implicit declarations in testsuite ?
379 o 577059 : Gnome-doc support can't be disabled
380 o 577774 : Test suite run even when built with --disable-gtk-doc
381 o 580206 : gcc warnings in < module > -scan.c
382 o 580300 : gtkdoc-scan picks up _get_type functions it should not
383 o 580622 : xml dir is both part of distclean and dist rules
384 o 581237 : gtk-doc uses wrong gtkdoc-check in " make check " phase
385 o 584952 : " uninitialized value in concatenation " gtkdoc-mkdb line 938
386 o 587103 : return values of function-like macros
387 o 587196 : Typo in a string
388 o 589426 : Python is a required dependency
389 o 591789 : master FTBFS with automake 1.11
390 o 594224 : Please fix manual about inlined SECTION comments (and show warnings when invalid)
391 o 596730 : Signed vs. unsigned comparison in gtkdoc-scangobj.in causing compile errors
392 o 596731 : autogen.sh doesn't recognize automake-1.11
393 o 602026 : Warn if non-existing function gets referenced
394 o 602518 : Doesn't support " long int " return type
395 o 604798 : tests/fail.sh and tests/tools.sh.in use bashisms
417 GTK-Doc 1.11 (Nov 16 2008)
422 o 531572 : one-page generation option
423 o 448879 : Use a footer when generating HTML documentation
424 o 311857 : xsltproc very slow generating index for gtk-docs.sgml
425 o 335239 : Using gnome-doc-utils for gtk-doc documentation
426 o 460753 : enable vpath build in gtkdoc-mkhtml
427 o 473342 : Warn about repeated symbols in sections
428 o 487727 : DocBook XML DTD version
429 o 523669 : make check: Element publisher content does not follow the...
430 o 530758 : gtk-doc should not expand XML tags and their attributes
431 o 533262 : no-template mode scans different source files
432 o 534627 : gtk-doc uses non-standard HTML element
433 o 542137 : No declaration found for: gsf_output_*
434 o 543855 : Fix for Bug 460753 (enable vpath build in gtkdoc-mkhtml) ...
435 o 544172 : Fails to parse return value of 'char const *'
436 o 552822 : Add rules to create $(REPORT_FILES)
437 o 553407 : Example Makefile.am uses obsolete INCLUDES instead of AM_...
438 o 554718 : gtk-doc needs to allow versioned TARGET_DIR
439 o 554833 : Be more careful with " struct _ < struct_name > "
440 o 558082 : evince docs build fails with GTK_DISABLE_SINGLE_INCLUDES
441 o 559281 : Correct check for existance of gtkdoc-rebase
458 GTK-Doc 1.10 (Mar 20 2008)
463 o 460753 : enable vpath build in gtkdoc-mkhtml
464 o 503119 : Add dependency on content_files to SGML target
465 o 127049 : building reference documentation fails when builddir != s...
466 o 481811 : Inline function bodies are confused with declarations
467 o 448879 : Use a footer when generating HTML documentation
468 o 492005 : Deprecation guard warnings for properties and signals
469 o 498521 : Inconsistent compiler flags passed in gtk-doc.make
470 o 365913 : gtk-doc output is not predictable
471 o 446648 : gtk-doc does not handle forward typedef'd enums
472 o 468278 : Display proper types for properties
473 o 497367 : don't use US-ASCII for output encoding
474 o 501066 : Missing quotes around gtkdoc-rebase check cause a warning
475 o 508897 : [PATCH] Fix build when gtk-doc is not installed
476 o 509539 : Building documentation aborts when no .types file is present
477 o 512154 : Struct member type attributes are limited to one token
478 o 513318 : gtk-doc.el doesn't work fine with emacs22
498 GTK-Doc 1.9 (Sep 30 2007)
503 o 419308 : unsynced regexps for parameter parsing
504 o 449618 : Top navigation bar is in the way
505 o 453717 : fixxref logic to determine absolute path's is flawed
506 o 457173 : unit tests for gtk-doc
507 o 465920 : Use gtkdoc-rebase
508 o 467773 : default master doc should have proper extension
509 o 141869 : Poor error generated when faced with a type declared as '...
510 o 156643 : Avoid make error in gtk-doc.make
511 o 322035 : wrong macro parsing
512 o 323938 : gtk-doc.m4 check is silent
513 o 324535 : gtk-doc doesn't handle deprecation inside enumerations
514 o 355352 : If you don't have an instantiatable type for a gtypeinter...
515 o 379466 : Improve C parser to handle TYPE\nVARIABLE in function pro...
516 o 380824 : docs are truncated if line begins with '* returns '
517 o 383456 : ' make check ' test for 100% documentation
518 o 411739 : Gtk-doc fails to handle ' struct tm * function_name (); '
519 o 415388 : Please clean -undocumented.txt files
520 o 418027 : gtkdoc-mkdb does not handle #ifdef in enum {}
521 o 419997 : parameter name trouble
522 o 428596 : Warnings with gtk-doc.m4 macros
523 o 434134 : fixxrefs like sed for installing pregenerated docs
524 o 436565 : Report undeclared symbols into a file
525 o 445596 : Impossible to link a page with an anchor
526 o 445693 : Does not understand ' unsigned long ' as a type
527 o 450338 : Make gtk-doc.m4 fail when needed gtk-doc is not installed
528 o 454916 : gtk-doc should permit generation of URI-based cross-refer...
529 o 457077 : add --no-implicit-returns to gtkdoc-mkdb
530 o 459225 : Accept automake-1.10 in autogen.sh
531 o 459725 : ' jhbuild build gtk-doc ' fails on make
532 o 460127 : parsing nested union/structs confuses public/private state
533 o 465365 : [PATCH] gtk-doc does not compile
534 o 466559 : [CSS] styling <hr />;
535 o 471014 : G_CONST_RETURN * G_CONST_RETURN * function not picked up
536 o 477532 : function variables
537 o 479913 : gtk-doc.notmpl.make is not distributed
538 o 479923 : distclean test output properly
554 GTK-Doc 1.8 (Feb 16 2007)
557 o Made it easier to include example code in the source code comment blocks.
558 "|[ ... ]|" can be used to delineate example code (it just gets converted
559 to "<informalexample><programlisting>"), and most of the text in example
560 code is left as it is. The only thing that is still expanded is
561 '#' to allow links to a symbol's documentation, e.g. '#GtkWidget'.
562 o Made the field widths wider for the HTML output, so it looks a bit nicer.
563 o Added a '--rebuild-sections' option to gtkdoc-scan to automatically rebuild
564 the MODULE-sections.txt file. This only works if all the header files are
565 organized neatly and functions don't need rearranging in the docs.
566 o Added a '--rebuild-types' option to gtkdoc-scan to automatically rebuild
567 the MODULE.types file, so you don't need to add new types manually.
568 o Leave CDATA sections as they are, in the extra XML content files and within
569 source code comment blocks.
570 o Allow the section id and #include's to be set within the "SECTION:" comment
571 block, using "@Section_ID:xxx" and "@Include:".
572 o Added "--default-includes" option to specify the default #include's (for
573 people who are using --rebuild-sections and so can't specify it in
574 MODULE-sections.txt).
575 o Added a '--query-child-properties' argument to help document child
576 properties of arbitrary GObjects (used by things like canvas widgets).
577 o Fixed documentation of signals of interfaces.
580 GTK-Doc 1.7 (Jul 29 2006)
583 o Fixed bug that resulted in empty "@:" lines in the templates.
584 o Fixed a few bugs with the XSL code.
585 o Supported a few more variations of C syntax.
586 o Remove the internally-used '-struct' suffix from links to widget structs.
587 o Fixed a few missing build dependencies.
588 o Added a new "C-x4s" binding to the emacs lisp code, to insert a blank
589 section header in the source code.
590 o Fixed bug that ignored inline section header docs with '-' in their names.
591 o Added a 'make docs' target that can be used to build the docs even when
592 gtk-doc has been disabled at configure time.
595 GTK-Doc 1.6 (Apr 9 2006)
598 o Removed the hard dependancy on openjade or jade, since XML is used mainly
599 now rather than SGML.
600 o Install the .pc file in $(datadir) rather than $(libdir) since gtk-doc is
601 architecture-independant.
602 o Added "--ignore-decorators" option to ignore a list of declarators in
603 function declarations.
604 o Support '#Object::signal'/'#Object:property' to link to signals/properties
605 o Fixed missing index terms.
608 GTK-Doc 1.5 (Mar 7 2006)
611 o Output the new version of devhelp2 information, but still generate the old
612 devhelp files so older versions of DevHelp still work OK.
613 o Fixed the initial creation of the *-sections.txt file so the object
614 hierarchy, signals and properties all work automatically.
615 o Show information about signal flags (run first/last).
616 o Support a --source-suffixes argument specifying which source files to scan.
617 o Support other root object types besides GObject and GInterface.
618 o Use a fixed navigation bar for the generated documentation.
619 o New documentation from Stefan Kost.
620 o Handle more variations of C syntax.
623 GTK-Doc 1.4 (Jul 3 2005)
626 o Support section documentation (title, short description, long description
627 and 'see also') within the source code. I think everything can now be
628 documented within the source code.
629 o Support Stable/Unstable/Private stability levels for everything.
632 GTK-Doc 1.3 (Jan 9 2005)
635 o Use the new style.css stylesheet instead of hard-wiring the styles.
636 o Updated the documentation and example build files.
637 o Added support for a gallery of widget images.
638 o Output default values for widget properties and allowed ranges.
639 o Only underline links in the docs when the mouse hovers over them.
640 o Added support for placing the parameter table anywhere within the function
641 documentation (using the "<!--PARAMETERS-->" marker).
642 o Handle more variations of C syntax.
645 GTK-Doc 1.2 (Feb 16 2004)
648 o Added widget signals and properties to undocumented output and statistics.
649 o Added support for an index of all symbols.
650 o Emit "Since:" information for signals and properties.
651 o Added derived subclasses and interfaces to the widget hierarchies.
652 o Added .cat SGML catalog file.
653 o Support properties on interfaces.
654 o Added "--help" options to the scripts.
657 GTK-Doc 1.1 (Apr 18 2003)
660 o Add a gtk-doc.m4 macro that allows packages to provide consistent
661 checking for gtk-doc.
662 o Check to make sure that the XML catalog actually contains entries
663 for the DocBook XML DTD and XSLT stylesheets. Please consult the
664 README file if your system's XML catalog isn't set up.
665 o Add infrastructure for including the standard gtk-doc makefile
666 glue, so that maintainers of packages don't need to worry about
667 keeping it up to date. See glib head for an example of its use.
668 o Some updates to the devhelp contents file generation, as suggested
670 o Fix some bugs in the DocBook XML codepath that were preventing
671 inter-module cross references from being resolved.
672 o Fix some bugs in extraction of object property documentation.
675 GTK-Doc 1.0 (Jan 20 2003)
678 o Added support for "Since:" and "Deprecated:" tags, and look for deprecated
679 guard macros in header files.
680 o Support /*< public >*/ and /*< private >*/ markers for all structs.
681 o New "--ignore-files" option for gtkdoc-mkdb, to ignore files or directories.
682 o Used the "sgml-raw" output type with openjade, to avoid problems with Lynx.
683 o Added .pc pkg-config file which can be used to check the gtk-doc version.
686 GTK-Doc 0.10 (Nov 14 2002)
689 o --output-format option to select whether SGML or XML is generated.
690 o Use openjade or jade when converting SGML to HTML.
691 o Use xsltproc to convert XML to HTML, with a new look.
692 o In XML mode, support XIncludes as an alternative to entities.
693 o In XML mode, create .devhelp files.
694 o List interfaces in the object hierarchy.
695 o Create docs for signals on interfaces.
696 o Generate links between interface and their implementations and
698 o Create docs for child and style properties.
699 o Use blurbs for property documentation.
700 o Allow inline documentation for signals and properties.