1 GTK-Doc 1.21.1 (... .. 2014)
6 GTK-Doc 1.21 (Jul 17 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-mktmpl - please move all the comments into the sources.
13 o generating html via sgml tools (jade/openjade), using xsltproc and
14 docbook-xslt is pretty common and preferred since version 1.6
18 o 170860 : gtk-doc should have definitions for stability
19 o 644111 : one cannot specify against which libs gtkdoc-fixxref should resolve links (problematic with multiple versions)
20 o 657444 : " enum foo { ... } " ; not recognized
21 o 671519 : Self-test relies on nonportable (GNU enhanced) 'date' command
22 o 678094 : the word " returns " in a function description can be parsed as the " Returns: " section
23 o 722621 : gtk-doc tarball was created with 32bit uid/gid, unusable with mingw/msys tar
24 o 724739 : Self-test fail: gtkdoc-mkdb misusing perl datatype
25 o 725505 : new syntax highlighting for code is weird
26 o 725663 : configure: non POSIX test usage
27 o 730658 : Deprecation warning for non-deprecated type GParamFlags
28 o 730777 : Add support for nullable and optional annotations
45 GTK-Doc 1.20 (Feb 16 2014)
48 Important notice - starting with the next release these long deprecated
49 features will be removed, please write to gtk-doc-list@gnome.org and tell us
51 o gtkdoc-scanobj (only used for gtkobject)
52 o return values need to be documented using "Returns:". We will remove the
53 heuristic that turns a paragraph starting with "Returns " into return docs.
54 o gtkdoc-mktmpl - please move all the comments into the sources.
55 o generating html via sgml tools (jade/openjade), using xsltproc and
56 docbook-xslt is pretty common and preferred since version 1.6
60 o 605537 : Returns: listed among parameters
61 o 624001 : Support attribute-based method to deprecate symbols
62 o 662424 : Class hierarchy about interfaces not generated by default
63 o 665926 : should not have to document object structures
64 o 666509 : Specifying --enable-gtk-doc should not be required to build source packages
65 o 669417 : Duplicate IDs generated for unions registered as boxed types
66 o 671519 : Self-test relies on nonportable (GNU enhanced) 'date' command
67 o 692367 : gtkdocize should take a srcdir argument
68 o 696570 : style updates
69 o 697940 : Race condition between setup-build.stamp and scan-build.stamp
70 o 701259 : /bin/bash: -chmod: command not found
71 o 701638 : Support automake parallel test harness (fix error with GTKDOC_CHECK)
72 o 706404 : Minor bug in gtkdoc-mkdb
73 o 706438 : Empty lines added at the beginning and at the end of a programlisting
74 o 707426 : master is broken in picking up flavour from configure.ac
75 o 707717 : Support " Deprecated: X.Y "
76 o 708268 : New *-insensitive.png files are not distributes
77 o 710478 : gtkdoc-mkdb: Don't complain about annotations with hyphen
78 o 711111 : gtkdoc-mkdb: sort entries in the glossary
79 o 711598 : gtkdoc-scan doesn't ignore decorators containing parentheses
80 o 719644 : docs: make yelp usage conditional in manual
81 o 719645 : configure: emit message when looking for yelp
82 o 720061 : make: create subdirectories of the content_files to the builddir
83 o 721228 : configure: search for xml catalog in XDG_DATA_DIRS
84 o 722479 : cp -u is not portable
85 o 723118 : Mark |[ blocks as CDATA
86 o 723288 : Fix MarkDown support
87 o 723417 : New MarkDown parser
88 o 723696 : Add support for blockquote
89 o 723812 : Add support for reference links
90 o 723913 : List in markdown: < p > inside the last element of a < ul > list
91 o 723991 : Improve the display of the synopsis
92 o 724002 : gtkdoc-scan: Fix use of uninitialised value in trace logging
117 Zbigniew Jędrzejewski-Szmek
119 GTK-Doc 1.19 (Jun 05 2013)
124 o 652740 : Warnings during expansion of content files
125 o 660436 : Warning for skip annotations on function parameters
126 o 661853 : allow EXTRA_DIST to be predefined
127 o 668228 : several of the tests use syntax not compatible with traditional Bourne shells
128 o 670724 : gtk-doc.make: double recursion when maintainer-clean
129 o 670767 : generated file gnome-doc-utils.m4 is in version control
130 o 670796 : (patch) Show commands when building documentation with make
131 o 671519 : Self-test relies on nonportable (GNU enhanced) 'date' command
132 o 671960 : make dist fails without html/*
133 o 672710 : Use new documentation infrastructure
134 o 676685 : Allow to order functions without using $MODULE-sections.txt
135 o 685365 : (PATCH) Fix contents of warning message, should be " -sections.txt " not " -section.txt "
136 o 686148 : [patch] suggested parameters for gtkdoc-scangobj
137 o 687685 : 'g_type_init' is deprecated
138 o 688204 : undocumented enum values missing in indexes
139 o 688423 : Add support for " transfer floating " introspection annotation
140 o 689209 : Automake complains about trailing space after backslash.
141 o 690438 : Small improvements
142 o 696930 : Incorrect allowed value for a property
143 o 700981 : make: copy the files with their relative path included
181 GTK-Doc 1.18 (Sep 14 2011)
184 o gtk-doc supports a subset of markdown (headings and lists) - see
185 http://git.gnome.org/browse/gtk-doc/tree/tests/gobject/src/gobject.c
186 o gtk-doc does not generate old devhelp files any more. This cuts down doc
187 generation time and works for devhelp >=0.11 (was released in 2005).
188 o changes for out-of-source dir build caused breakage for projects using
189 DOC_SOURCE_DIR with a relative path (to builddir). It is recommended to use
190 DOC_SOURCE_DIR=$(top_srcdir)/src/xxx.
194 o 590927 : Support AM_SILENT_RULES for doc-build steps
195 o 617121 : /* < private > */ declarations in enums are still displayed
196 o 627758 : A way to ignore a symbol
197 o 639145 : shorthand syntax for headings
198 o 644291 : Enum parser breaks on assignment of ')'
199 o 646870 : HTML_IMAGES no longer in EXTRA_DIST
200 o 648289 : gtkdoc-mkdb doesn't compile.
201 o 648331 : Specify compatible options for 'highlight' consistently.
202 o 649269 : gtkdoc-scanobj should set some of its own CFLAGS/LDFLAGS
203 o 650407 : Buildings docs while distchecking produces thousands of “No declaration found” warnings, then fails.
204 o 652746 : Documentation of plain boxed structs broken
205 o 652764 : Update autotools config a bit
206 o 655711 : summarize depscan output by package
207 o 656453 : Performance improvements (PATCH)
208 o 656658 : gtk-doc.make: install target doesn't install docs when building in a separate directory
209 o 656773 : gtk-doc fails to find a symbol declared as 'char* const'
210 o 656946 : gtk-doc unable to handle 'extern short int'
211 o 657377 : srcdir!=builddir builds discard contents of tmpl
231 GTK-Doc 1.17 (Feb 16 2011)
236 o 127049 : building reference documentation fails when builddir != srcdir
237 o 640241 : non-srcdir builds busted
245 GTK-Doc 1.16 (Jan 14 2011)
248 o gtkdoc-check can do more checks, one might need to update Makefile.am from
249 the examples/Makefile.am
253 o 625776 : serialise doubles and floats always with a decimal dot
254 o 627269 : link to signalflags docs from signal descriptions
255 o 467488 : GTK+ man pages request
256 o 481811 : Inline function bodies are confused with declarations
257 o 501107 : EXTRA_DIST automake warnings
258 o 512565 : add GTK_DOC_IGNORE
259 o 518427 : documentation best pratices needed
260 o 597937 : Function pointers as parameters to other functions are parsed improperly
261 o 612028 : gtkdoc-fixxref should call /usr/bin/vim -n -e -u NONE -T xterm
262 o 617478 : Tooltip is a nuisance
263 o 618379 : Navigation is hiding anchors title
264 o 620249 : invalid xml for object_index with (n_objects % 3) == 0
265 o 621931 : support GType and GVariant types
266 o 622971 : List of typos in the GTK-doc manual
267 o 623777 : G_TYPE_STRV in signals generate wrong docs
268 o 623968 : gtkdoc-mkdb generates invalid xml from sgml in inline comments
269 o 624199 : parser picks up contents of large macros
270 o 624200 : 'const' confuses the parser
271 o 627223 : gtkdoc-fixxref vim highlight fails on xhtml suffix
272 o 627920 : `make check` rule to list xml files missing from DOC_MAIN_SGML_FILE
273 o 628611 : gtk-doc > = 1.13 creates automagic dependencies on syntax highlighters
274 o 628794 : Issue in gtkdoc-mkman.in
275 o 630288 : Fix 'scope notified' annotation
276 o 631336 : remove lists of gtk+ signal args in gtkdoc-scanobj and -scangobj
277 o 632587 : gtkdoc-scanner fails to identify (closure) annotation
278 o 638330 : const in parameter list is ignored
279 o 638831 : Support GTK+ 3 cell properties
286 Gilles Dartiguelongue
302 GTK-Doc 1.15 (May 21 2010)
307 o 614496 : Support for multiple DOC_SOURCE_DIR directories
308 o 615550 : gtk-doc fails to recognize (scope ...) and (skip) annotations
318 GTK-Doc 1.14 (Mar 28 2010)
323 o 593282 : Append " _struct " prefix to every struct name
324 o 599514 : sane support for per-page images
325 o 604892 : checks fail
326 o 613611 : parameter descriptions with annotations truncated at first \n
327 o 115531 : add short description to index entries
328 o 165425 : gtk-doc fails to parse unions
329 o 512155 : gets confused by multiline typedef
330 o 568711 : undocumented enum values are not reported
331 o 590602 : secondly running gtkdoc-mkdb will generate DOCTYPE missing XML files
332 o 590625 : $(DOC_MODULE)-overrides.txt is required by " make dist "
333 o 591975 : Section_Id always embeds a trailing newline
334 o 604885 : Fix the use of gtkdocize --flavour option
335 o 604992 : gtkdoc-fixxref broken link warning is broken for functions
336 o 604995 : Syntax error in gtkdoc-mkman
337 o 604998 : Check for syntax errors in the test suite
338 o 605052 : put class structs to the generated section file
339 o 605211 : Many build failures with gtk-doc 1.13
340 o 605281 : Add " Since " and " Deprecated " tag to function example
341 o 605285 : Add < keycap > and < keycombo > example
342 o 605289 : Some documentation improvements
343 o 605452 : Added more info to " Documenting symbols " sectio
344 o 605564 : Env var equivalent to --flavour=no-tmpl
345 o 606661 : XInclude error while gnerating documentation
346 o 607445 : gtk-doc does not support long double as returned value type
347 o 607531 : Execute system() calls in subshells to ease debugging
348 o 609062 : [All-langs] [gtk-doc] Translated *.po files not available within ~/po directory
349 o 609194 : sort interface implementers
350 o 610255 : Self-test failure in git as of 2010-02-17: FAIL: gobject.sh
351 o 610257 : Patch to make GTK-DOC notice functions/variables with 'signed' prototypes
352 o 611848 : gtk-doc produces invalid DocBook markup if the SECTION ends with a tag that cannot be nested inside < para >
358 Emilio Pozuelo Monfort
359 Francisco Javier F. Serrador
377 GTK-Doc 1.13 (Dec 18 2009)
380 o 604891 : gtk-doc tarball does not build
386 GTK-Doc 1.12 (Dec 18 2009)
391 o 591450 : Build related fixes
392 o 466535 : generate documentation as pdf
393 o 502191 : acronym support
394 o 532395 : inline function parsing problems (e.g. in glib api docs)
395 o 536928 : have syntax highlghted and xrefs source code samples
396 o 562064 : index generation trouble
397 o 562310 : glib 2.18.3: /bin/sh: line 1: gtkdoc-rebase: command not found
398 o 562655 : doesn't produce deprecation note for signals
399 o 565126 : linking to struct members
400 o 565835 : Three spelling errors in gtk-doc-manual
401 o 566911 : add support for --help and --version to remaining tools
402 o 567132 : Take FOO_GET_INTERFACE as standard
403 o 568702 : gtkdoc-mkhtml no longer works when symlinked
404 o 568706 : gtkdoc-scan: use CamelCase id for interfaces
405 o 568708 : gtkdoc-scan should try not to scan files twice
406 o 568714 : Perl errors when syntax highlighting is not available
407 o 568732 : missing long descriptions undetected
408 o 568734 : configure check for gtk-doc prints that gtk-doc cannot be built
409 o 569339 : abbreviation are not expanded at the start of text
410 o 572396 : Fix to use shave + gtk-doc + libtool 1.x
411 o 572612 : Mistakenly substitute -1 with G_MAXULONG in x86_64
412 o 572967 : use g_strerror
413 o 574654 : --ignore-decorators does not ignore trailing stuff
414 o 575574 : Be more friendly for files with a space in their name
415 o 575623 : Update FSF address
416 o 575711 : < table > element mismatch in highlighted code
417 o 576313 : implicit declarations in testsuite ?
418 o 577059 : Gnome-doc support can't be disabled
419 o 577774 : Test suite run even when built with --disable-gtk-doc
420 o 580206 : gcc warnings in < module > -scan.c
421 o 580300 : gtkdoc-scan picks up _get_type functions it should not
422 o 580622 : xml dir is both part of distclean and dist rules
423 o 581237 : gtk-doc uses wrong gtkdoc-check in " make check " phase
424 o 584952 : " uninitialized value in concatenation " gtkdoc-mkdb line 938
425 o 587103 : return values of function-like macros
426 o 587196 : Typo in a string
427 o 589426 : Python is a required dependency
428 o 591789 : master FTBFS with automake 1.11
429 o 594224 : Please fix manual about inlined SECTION comments (and show warnings when invalid)
430 o 596730 : Signed vs. unsigned comparison in gtkdoc-scangobj.in causing compile errors
431 o 596731 : autogen.sh doesn't recognize automake-1.11
432 o 602026 : Warn if non-existing function gets referenced
433 o 602518 : Doesn't support " long int " return type
434 o 604798 : tests/fail.sh and tests/tools.sh.in use bashisms
456 GTK-Doc 1.11 (Nov 16 2008)
461 o 531572 : one-page generation option
462 o 448879 : Use a footer when generating HTML documentation
463 o 311857 : xsltproc very slow generating index for gtk-docs.sgml
464 o 335239 : Using gnome-doc-utils for gtk-doc documentation
465 o 460753 : enable vpath build in gtkdoc-mkhtml
466 o 473342 : Warn about repeated symbols in sections
467 o 487727 : DocBook XML DTD version
468 o 523669 : make check: Element publisher content does not follow the...
469 o 530758 : gtk-doc should not expand XML tags and their attributes
470 o 533262 : no-template mode scans different source files
471 o 534627 : gtk-doc uses non-standard HTML element
472 o 542137 : No declaration found for: gsf_output_*
473 o 543855 : Fix for Bug 460753 (enable vpath build in gtkdoc-mkhtml) ...
474 o 544172 : Fails to parse return value of 'char const *'
475 o 552822 : Add rules to create $(REPORT_FILES)
476 o 553407 : Example Makefile.am uses obsolete INCLUDES instead of AM_...
477 o 554718 : gtk-doc needs to allow versioned TARGET_DIR
478 o 554833 : Be more careful with " struct _ < struct_name > "
479 o 558082 : evince docs build fails with GTK_DISABLE_SINGLE_INCLUDES
480 o 559281 : Correct check for existance of gtkdoc-rebase
497 GTK-Doc 1.10 (Mar 20 2008)
502 o 460753 : enable vpath build in gtkdoc-mkhtml
503 o 503119 : Add dependency on content_files to SGML target
504 o 127049 : building reference documentation fails when builddir != s...
505 o 481811 : Inline function bodies are confused with declarations
506 o 448879 : Use a footer when generating HTML documentation
507 o 492005 : Deprecation guard warnings for properties and signals
508 o 498521 : Inconsistent compiler flags passed in gtk-doc.make
509 o 365913 : gtk-doc output is not predictable
510 o 446648 : gtk-doc does not handle forward typedef'd enums
511 o 468278 : Display proper types for properties
512 o 497367 : don't use US-ASCII for output encoding
513 o 501066 : Missing quotes around gtkdoc-rebase check cause a warning
514 o 508897 : [PATCH] Fix build when gtk-doc is not installed
515 o 509539 : Building documentation aborts when no .types file is present
516 o 512154 : Struct member type attributes are limited to one token
517 o 513318 : gtk-doc.el doesn't work fine with emacs22
537 GTK-Doc 1.9 (Sep 30 2007)
542 o 419308 : unsynced regexps for parameter parsing
543 o 449618 : Top navigation bar is in the way
544 o 453717 : fixxref logic to determine absolute path's is flawed
545 o 457173 : unit tests for gtk-doc
546 o 465920 : Use gtkdoc-rebase
547 o 467773 : default master doc should have proper extension
548 o 141869 : Poor error generated when faced with a type declared as '...
549 o 156643 : Avoid make error in gtk-doc.make
550 o 322035 : wrong macro parsing
551 o 323938 : gtk-doc.m4 check is silent
552 o 324535 : gtk-doc doesn't handle deprecation inside enumerations
553 o 355352 : If you don't have an instantiatable type for a gtypeinter...
554 o 379466 : Improve C parser to handle TYPE\nVARIABLE in function pro...
555 o 380824 : docs are truncated if line begins with '* returns '
556 o 383456 : ' make check ' test for 100% documentation
557 o 411739 : Gtk-doc fails to handle ' struct tm * function_name (); '
558 o 415388 : Please clean -undocumented.txt files
559 o 418027 : gtkdoc-mkdb does not handle #ifdef in enum {}
560 o 419997 : parameter name trouble
561 o 428596 : Warnings with gtk-doc.m4 macros
562 o 434134 : fixxrefs like sed for installing pregenerated docs
563 o 436565 : Report undeclared symbols into a file
564 o 445596 : Impossible to link a page with an anchor
565 o 445693 : Does not understand ' unsigned long ' as a type
566 o 450338 : Make gtk-doc.m4 fail when needed gtk-doc is not installed
567 o 454916 : gtk-doc should permit generation of URI-based cross-refer...
568 o 457077 : add --no-implicit-returns to gtkdoc-mkdb
569 o 459225 : Accept automake-1.10 in autogen.sh
570 o 459725 : ' jhbuild build gtk-doc ' fails on make
571 o 460127 : parsing nested union/structs confuses public/private state
572 o 465365 : [PATCH] gtk-doc does not compile
573 o 466559 : [CSS] styling <hr />;
574 o 471014 : G_CONST_RETURN * G_CONST_RETURN * function not picked up
575 o 477532 : function variables
576 o 479913 : gtk-doc.notmpl.make is not distributed
577 o 479923 : distclean test output properly
593 GTK-Doc 1.8 (Feb 16 2007)
596 o Made it easier to include example code in the source code comment blocks.
597 "|[ ... ]|" can be used to delineate example code (it just gets converted
598 to "<informalexample><programlisting>"), and most of the text in example
599 code is left as it is. The only thing that is still expanded is
600 '#' to allow links to a symbol's documentation, e.g. '#GtkWidget'.
601 o Made the field widths wider for the HTML output, so it looks a bit nicer.
602 o Added a '--rebuild-sections' option to gtkdoc-scan to automatically rebuild
603 the MODULE-sections.txt file. This only works if all the header files are
604 organized neatly and functions don't need rearranging in the docs.
605 o Added a '--rebuild-types' option to gtkdoc-scan to automatically rebuild
606 the MODULE.types file, so you don't need to add new types manually.
607 o Leave CDATA sections as they are, in the extra XML content files and within
608 source code comment blocks.
609 o Allow the section id and #include's to be set within the "SECTION:" comment
610 block, using "@Section_ID:xxx" and "@Include:".
611 o Added "--default-includes" option to specify the default #include's (for
612 people who are using --rebuild-sections and so can't specify it in
613 MODULE-sections.txt).
614 o Added a '--query-child-properties' argument to help document child
615 properties of arbitrary GObjects (used by things like canvas widgets).
616 o Fixed documentation of signals of interfaces.
619 GTK-Doc 1.7 (Jul 29 2006)
622 o Fixed bug that resulted in empty "@:" lines in the templates.
623 o Fixed a few bugs with the XSL code.
624 o Supported a few more variations of C syntax.
625 o Remove the internally-used '-struct' suffix from links to widget structs.
626 o Fixed a few missing build dependencies.
627 o Added a new "C-x4s" binding to the emacs lisp code, to insert a blank
628 section header in the source code.
629 o Fixed bug that ignored inline section header docs with '-' in their names.
630 o Added a 'make docs' target that can be used to build the docs even when
631 gtk-doc has been disabled at configure time.
634 GTK-Doc 1.6 (Apr 9 2006)
637 o Removed the hard dependancy on openjade or jade, since XML is used mainly
638 now rather than SGML.
639 o Install the .pc file in $(datadir) rather than $(libdir) since gtk-doc is
640 architecture-independant.
641 o Added "--ignore-decorators" option to ignore a list of declarators in
642 function declarations.
643 o Support '#Object::signal'/'#Object:property' to link to signals/properties
644 o Fixed missing index terms.
647 GTK-Doc 1.5 (Mar 7 2006)
650 o Output the new version of devhelp2 information, but still generate the old
651 devhelp files so older versions of DevHelp still work OK.
652 o Fixed the initial creation of the *-sections.txt file so the object
653 hierarchy, signals and properties all work automatically.
654 o Show information about signal flags (run first/last).
655 o Support a --source-suffixes argument specifying which source files to scan.
656 o Support other root object types besides GObject and GInterface.
657 o Use a fixed navigation bar for the generated documentation.
658 o New documentation from Stefan Kost.
659 o Handle more variations of C syntax.
662 GTK-Doc 1.4 (Jul 3 2005)
665 o Support section documentation (title, short description, long description
666 and 'see also') within the source code. I think everything can now be
667 documented within the source code.
668 o Support Stable/Unstable/Private stability levels for everything.
671 GTK-Doc 1.3 (Jan 9 2005)
674 o Use the new style.css stylesheet instead of hard-wiring the styles.
675 o Updated the documentation and example build files.
676 o Added support for a gallery of widget images.
677 o Output default values for widget properties and allowed ranges.
678 o Only underline links in the docs when the mouse hovers over them.
679 o Added support for placing the parameter table anywhere within the function
680 documentation (using the "<!--PARAMETERS-->" marker).
681 o Handle more variations of C syntax.
684 GTK-Doc 1.2 (Feb 16 2004)
687 o Added widget signals and properties to undocumented output and statistics.
688 o Added support for an index of all symbols.
689 o Emit "Since:" information for signals and properties.
690 o Added derived subclasses and interfaces to the widget hierarchies.
691 o Added .cat SGML catalog file.
692 o Support properties on interfaces.
693 o Added "--help" options to the scripts.
696 GTK-Doc 1.1 (Apr 18 2003)
699 o Add a gtk-doc.m4 macro that allows packages to provide consistent
700 checking for gtk-doc.
701 o Check to make sure that the XML catalog actually contains entries
702 for the DocBook XML DTD and XSLT stylesheets. Please consult the
703 README file if your system's XML catalog isn't set up.
704 o Add infrastructure for including the standard gtk-doc makefile
705 glue, so that maintainers of packages don't need to worry about
706 keeping it up to date. See glib head for an example of its use.
707 o Some updates to the devhelp contents file generation, as suggested
709 o Fix some bugs in the DocBook XML codepath that were preventing
710 inter-module cross references from being resolved.
711 o Fix some bugs in extraction of object property documentation.
714 GTK-Doc 1.0 (Jan 20 2003)
717 o Added support for "Since:" and "Deprecated:" tags, and look for deprecated
718 guard macros in header files.
719 o Support /*< public >*/ and /*< private >*/ markers for all structs.
720 o New "--ignore-files" option for gtkdoc-mkdb, to ignore files or directories.
721 o Used the "sgml-raw" output type with openjade, to avoid problems with Lynx.
722 o Added .pc pkg-config file which can be used to check the gtk-doc version.
725 GTK-Doc 0.10 (Nov 14 2002)
728 o --output-format option to select whether SGML or XML is generated.
729 o Use openjade or jade when converting SGML to HTML.
730 o Use xsltproc to convert XML to HTML, with a new look.
731 o In XML mode, support XIncludes as an alternative to entities.
732 o In XML mode, create .devhelp files.
733 o List interfaces in the object hierarchy.
734 o Create docs for signals on interfaces.
735 o Generate links between interface and their implementations and
737 o Create docs for child and style properties.
738 o Use blurbs for property documentation.
739 o Allow inline documentation for signals and properties.