1 GTK-Doc 1.27 (Dec 07 2017)
4 Finetune the python port.
8 o 773879 : scangobj: Do not generate unused parameters
9 o 786174 : Several test failures on Arch Linux
10 o 787495 : gtkdoc-fixxref crashes when running vim for syntax highlighting
11 o 787768 : Aborts when glib2.0-dev is not installed
12 o 787862 : Always open files in text mode and always use utf-8
13 o 788473 : fixxref crashes if a .devhelp2.gz file is found
14 o 789531 : Don't depend on the system shell
15 o 790022 : mkdb: Add support for (not optional) annotation
16 o 791131 : gtk-doc and python3: fixxref failures
26 Jan Alexander Steffens (heftig)
36 GTK-Doc 1.26 (Aug 11 2017)
39 Remove tmpl support (gtkdoc-mktmpl). Port all tools from bash/perl to python.
43 o 773879 : scangobj: Do not generate unused parameters
44 o 780789 : Convert gtkdoc-scan from Perl to Python
45 o 752126 : Add support for inline program documentation
46 o 753052 : _() causes element a: validity error : ID idx already defined
47 o 758137 : GtkLabel and GtkShortcutsShortcut notes on escaping character entities don't render properly
48 o 764407 : Broken links to structs in function definitions
49 o 764543 : /usr/bin/gtkdoc-mkpdf always exits with an error
50 o 768675 : make check fails on master
51 o 769125 : gtkdoc-mkhtml/pdf fails on spaces in search path
52 o 769341 : gtkdoc-mkdb line 3966 triggers "Negative repeat count does nothing" warnings
53 o 771255 : "Symbol name not found at the start of comment block" warning with "attributes" annotation.
54 o 773151 : configure: Lower perl dependency to 5.16.0
55 o 774168 : gobject introspection annotations and gtk-doc parser do not agree
56 o 774812 : Error messages from xsltproc are hidden by gtkdoc-mkhtml
57 o 778144 : Allow disabling introspection for ancillary property mechanisms
58 o 779566 : Replace shell executables with Python
86 Víctor Manuel Jáquez Leal
88 GTK-Doc 1.25 (Mar 21 2016)
93 o 763465 : – released version of gtk-doc no longer understands cross-reference data in gtk+
94 o 742404 : unify index.sgml and *.devhelp2 + change gtkdoc-fixxref to use *.devhelp2
95 o 743182 : Automatically support PACKAGE variables as XML entities
96 o 744061 : Skip standard g_iface, parent_instance and parent_class struct members
97 o 751479 : help: Document the Stability tag for documentation comments
98 o 751777 : gtk-doc -sections.txt file documentation is a bit confusing
99 o 751783 : Creating master xml document documentation is a bit lacking
100 o 751906 : help: Fix incorrect example syntax for embedded images
101 o 752795 : documentation is not rebuilt when only content of doc comments change
102 o 753145 : gtkdoc-mkhtml fails on spaces in file names
103 o 753348 : gtkdocize does not handle -flat flavours
104 o 756297 : Add CMake module
105 o 756368 : gtkdocize mistakenly parses options from comments in configure.ac
106 o 756519 : `make check' fails - Sequence (?R...) not recognized in regex
107 o 756684 : Support (not nullable) annotation
108 o 756998 : Support |[ < !-- language= " plain " -- > ]|
109 o 758996 : gtkdoc-mkdb: ensure macros appear in the correct section
110 o 759017 : autogenerated ids in return and parameter blocks
129 GTK-Doc 1.24 (May 29 2015)
132 This is another quick bugfix release for a regression, see bug #749591
136 o 749591 : gtk-doc 1.23 no longer includes xml namespace in .devhelp2 files
137 o 749706 : .gitignore files should not be under version control
138 o 749816 : Support syntax highlighting of different languages (patch included)
139 o 749901 : Strip common indent when highlighting with vim
149 GTK-Doc 1.23 (May 17 2015)
152 This is a quick bugfix release for a regression, see bug #749142.
156 o 749142 : Can't build totem-pl-parser from master using gtk-doc 1.22
157 o 749210 : mkman: Use full URL to refer to the docbook manpages stylesheet
164 GTK-Doc 1.22 (May 07 2015)
167 Important notice - starting with the next release these long deprecated
168 features will be removed - you'll now see a warning if you actually use these
169 features. Please write to gtk-doc-list@gnome.org and tell us your concerns:
170 o gtkdoc-mktmpl - please move all the comments into the sources.
171 o generating html via sgml tools (jade/openjade), using xsltproc and
172 docbook-xslt is pretty common and preferred since version 1.6
176 o 727778 : – gtk-doc doesn't understand annotations for GList-contained types
177 o 729911 : Using #TypeName inshort_description makes " - " in HTML index disappear
178 o 732689 : strange result on a generated html page
179 o 734689 : " Specific - > General " document title format
180 o 736073 : Regression: problems with enum constants
181 o 736725 : Documentation consists mostly of empty space
182 o 741305 : Scanner issue with enum containing value ='{'
183 o 741763 : Example Makefile.am improvements
184 o 741941 : Last function argument missing in docs (possibly due to macro in code)
185 o 743879 : special case G_DECLARE_*_TYPE
186 o 743967 : Make build results reproducible
187 o 744075 : Missing struct members if forward declared in another header
188 o 744368 : gtkdoc-depscan doesn't handle unicode in .devhelp2 files correctly
189 o 746118 : gtkdoc-scan: fix regex for get_type() functions
190 o 746120 : Expand annotation recognition on symbol lines
191 o 746121 : gtkdoc-mkdb: don't warn on 'deprecated entities'
192 o 747207 : Typos in documentation
193 o 747298 : Test still tries to check gtkdoc-scanobj
194 o 748456 : xsl: Enable ToC generation on empty < toc/ > elements
202 Dominique Leuenberger
216 GTK-Doc 1.21 (Jul 17 2014)
219 Important notice - starting with the next release these long deprecated
220 features will be removed, please write to gtk-doc-list@gnome.org and tell us
222 o gtkdoc-mktmpl - please move all the comments into the sources.
223 o generating html via sgml tools (jade/openjade), using xsltproc and
224 docbook-xslt is pretty common and preferred since version 1.6
228 o 170860 : gtk-doc should have definitions for stability
229 o 644111 : one cannot specify against which libs gtkdoc-fixxref should resolve links (problematic with multiple versions)
230 o 657444 : " enum foo { ... } " ; not recognized
231 o 671519 : Self-test relies on nonportable (GNU enhanced) 'date' command
232 o 678094 : the word " returns " in a function description can be parsed as the " Returns: " section
233 o 722621 : gtk-doc tarball was created with 32bit uid/gid, unusable with mingw/msys tar
234 o 724739 : Self-test fail: gtkdoc-mkdb misusing perl datatype
235 o 725505 : new syntax highlighting for code is weird
236 o 725663 : configure: non POSIX test usage
237 o 730658 : Deprecation warning for non-deprecated type GParamFlags
238 o 730777 : Add support for nullable and optional annotations
255 GTK-Doc 1.20 (Feb 16 2014)
258 Important notice - starting with the next release these long deprecated
259 features will be removed, please write to gtk-doc-list@gnome.org and tell us
261 o gtkdoc-scanobj (only used for gtkobject)
262 o return values need to be documented using "Returns:". We will remove the
263 heuristic that turns a paragraph starting with "Returns " into return docs.
264 o gtkdoc-mktmpl - please move all the comments into the sources.
265 o generating html via sgml tools (jade/openjade), using xsltproc and
266 docbook-xslt is pretty common and preferred since version 1.6
270 o 605537 : Returns: listed among parameters
271 o 624001 : Support attribute-based method to deprecate symbols
272 o 662424 : Class hierarchy about interfaces not generated by default
273 o 665926 : should not have to document object structures
274 o 666509 : Specifying --enable-gtk-doc should not be required to build source packages
275 o 669417 : Duplicate IDs generated for unions registered as boxed types
276 o 671519 : Self-test relies on nonportable (GNU enhanced) 'date' command
277 o 692367 : gtkdocize should take a srcdir argument
278 o 696570 : style updates
279 o 697940 : Race condition between setup-build.stamp and scan-build.stamp
280 o 701259 : /bin/bash: -chmod: command not found
281 o 701638 : Support automake parallel test harness (fix error with GTKDOC_CHECK)
282 o 706404 : Minor bug in gtkdoc-mkdb
283 o 706438 : Empty lines added at the beginning and at the end of a programlisting
284 o 707426 : master is broken in picking up flavour from configure.ac
285 o 707717 : Support " Deprecated: X.Y "
286 o 708268 : New *-insensitive.png files are not distributes
287 o 710478 : gtkdoc-mkdb: Don't complain about annotations with hyphen
288 o 711111 : gtkdoc-mkdb: sort entries in the glossary
289 o 711598 : gtkdoc-scan doesn't ignore decorators containing parentheses
290 o 719644 : docs: make yelp usage conditional in manual
291 o 719645 : configure: emit message when looking for yelp
292 o 720061 : make: create subdirectories of the content_files to the builddir
293 o 721228 : configure: search for xml catalog in XDG_DATA_DIRS
294 o 722479 : cp -u is not portable
295 o 723118 : Mark |[ blocks as CDATA
296 o 723288 : Fix MarkDown support
297 o 723417 : New MarkDown parser
298 o 723696 : Add support for blockquote
299 o 723812 : Add support for reference links
300 o 723913 : List in markdown: < p > inside the last element of a < ul > list
301 o 723991 : Improve the display of the synopsis
302 o 724002 : gtkdoc-scan: Fix use of uninitialised value in trace logging
327 Zbigniew Jędrzejewski-Szmek
329 GTK-Doc 1.19 (Jun 05 2013)
334 o 652740 : Warnings during expansion of content files
335 o 660436 : Warning for skip annotations on function parameters
336 o 661853 : allow EXTRA_DIST to be predefined
337 o 668228 : several of the tests use syntax not compatible with traditional Bourne shells
338 o 670724 : gtk-doc.make: double recursion when maintainer-clean
339 o 670767 : generated file gnome-doc-utils.m4 is in version control
340 o 670796 : (patch) Show commands when building documentation with make
341 o 671519 : Self-test relies on nonportable (GNU enhanced) 'date' command
342 o 671960 : make dist fails without html/*
343 o 672710 : Use new documentation infrastructure
344 o 676685 : Allow to order functions without using $MODULE-sections.txt
345 o 685365 : (PATCH) Fix contents of warning message, should be " -sections.txt " not " -section.txt "
346 o 686148 : [patch] suggested parameters for gtkdoc-scangobj
347 o 687685 : 'g_type_init' is deprecated
348 o 688204 : undocumented enum values missing in indexes
349 o 688423 : Add support for " transfer floating " introspection annotation
350 o 689209 : Automake complains about trailing space after backslash.
351 o 690438 : Small improvements
352 o 696930 : Incorrect allowed value for a property
353 o 700981 : make: copy the files with their relative path included
391 GTK-Doc 1.18 (Sep 14 2011)
394 o gtk-doc supports a subset of markdown (headings and lists) - see
395 http://git.gnome.org/browse/gtk-doc/tree/tests/gobject/src/gobject.c
396 o gtk-doc does not generate old devhelp files any more. This cuts down doc
397 generation time and works for devhelp >=0.11 (was released in 2005).
398 o changes for out-of-source dir build caused breakage for projects using
399 DOC_SOURCE_DIR with a relative path (to builddir). It is recommended to use
400 DOC_SOURCE_DIR=$(top_srcdir)/src/xxx.
404 o 590927 : Support AM_SILENT_RULES for doc-build steps
405 o 617121 : /* < private > */ declarations in enums are still displayed
406 o 627758 : A way to ignore a symbol
407 o 639145 : shorthand syntax for headings
408 o 644291 : Enum parser breaks on assignment of ')'
409 o 646870 : HTML_IMAGES no longer in EXTRA_DIST
410 o 648289 : gtkdoc-mkdb doesn't compile.
411 o 648331 : Specify compatible options for 'highlight' consistently.
412 o 649269 : gtkdoc-scanobj should set some of its own CFLAGS/LDFLAGS
413 o 650407 : Buildings docs while distchecking produces thousands of “No declaration found” warnings, then fails.
414 o 652746 : Documentation of plain boxed structs broken
415 o 652764 : Update autotools config a bit
416 o 655711 : summarize depscan output by package
417 o 656453 : Performance improvements (PATCH)
418 o 656658 : gtk-doc.make: install target doesn't install docs when building in a separate directory
419 o 656773 : gtk-doc fails to find a symbol declared as 'char* const'
420 o 656946 : gtk-doc unable to handle 'extern short int'
421 o 657377 : srcdir!=builddir builds discard contents of tmpl
441 GTK-Doc 1.17 (Feb 16 2011)
446 o 127049 : building reference documentation fails when builddir != srcdir
447 o 640241 : non-srcdir builds busted
455 GTK-Doc 1.16 (Jan 14 2011)
458 o gtkdoc-check can do more checks, one might need to update Makefile.am from
459 the examples/Makefile.am
463 o 625776 : serialise doubles and floats always with a decimal dot
464 o 627269 : link to signalflags docs from signal descriptions
465 o 467488 : GTK+ man pages request
466 o 481811 : Inline function bodies are confused with declarations
467 o 501107 : EXTRA_DIST automake warnings
468 o 512565 : add GTK_DOC_IGNORE
469 o 518427 : documentation best pratices needed
470 o 597937 : Function pointers as parameters to other functions are parsed improperly
471 o 612028 : gtkdoc-fixxref should call /usr/bin/vim -n -e -u NONE -T xterm
472 o 617478 : Tooltip is a nuisance
473 o 618379 : Navigation is hiding anchors title
474 o 620249 : invalid xml for object_index with (n_objects % 3) == 0
475 o 621931 : support GType and GVariant types
476 o 622971 : List of typos in the GTK-doc manual
477 o 623777 : G_TYPE_STRV in signals generate wrong docs
478 o 623968 : gtkdoc-mkdb generates invalid xml from sgml in inline comments
479 o 624199 : parser picks up contents of large macros
480 o 624200 : 'const' confuses the parser
481 o 627223 : gtkdoc-fixxref vim highlight fails on xhtml suffix
482 o 627920 : `make check` rule to list xml files missing from DOC_MAIN_SGML_FILE
483 o 628611 : gtk-doc > = 1.13 creates automagic dependencies on syntax highlighters
484 o 628794 : Issue in gtkdoc-mkman.in
485 o 630288 : Fix 'scope notified' annotation
486 o 631336 : remove lists of gtk+ signal args in gtkdoc-scanobj and -scangobj
487 o 632587 : gtkdoc-scanner fails to identify (closure) annotation
488 o 638330 : const in parameter list is ignored
489 o 638831 : Support GTK+ 3 cell properties
496 Gilles Dartiguelongue
512 GTK-Doc 1.15 (May 21 2010)
517 o 614496 : Support for multiple DOC_SOURCE_DIR directories
518 o 615550 : gtk-doc fails to recognize (scope ...) and (skip) annotations
528 GTK-Doc 1.14 (Mar 28 2010)
533 o 593282 : Append " _struct " prefix to every struct name
534 o 599514 : sane support for per-page images
535 o 604892 : checks fail
536 o 613611 : parameter descriptions with annotations truncated at first \n
537 o 115531 : add short description to index entries
538 o 165425 : gtk-doc fails to parse unions
539 o 512155 : gets confused by multiline typedef
540 o 568711 : undocumented enum values are not reported
541 o 590602 : secondly running gtkdoc-mkdb will generate DOCTYPE missing XML files
542 o 590625 : $(DOC_MODULE)-overrides.txt is required by " make dist "
543 o 591975 : Section_Id always embeds a trailing newline
544 o 604885 : Fix the use of gtkdocize --flavour option
545 o 604992 : gtkdoc-fixxref broken link warning is broken for functions
546 o 604995 : Syntax error in gtkdoc-mkman
547 o 604998 : Check for syntax errors in the test suite
548 o 605052 : put class structs to the generated section file
549 o 605211 : Many build failures with gtk-doc 1.13
550 o 605281 : Add " Since " and " Deprecated " tag to function example
551 o 605285 : Add < keycap > and < keycombo > example
552 o 605289 : Some documentation improvements
553 o 605452 : Added more info to " Documenting symbols " sectio
554 o 605564 : Env var equivalent to --flavour=no-tmpl
555 o 606661 : XInclude error while gnerating documentation
556 o 607445 : gtk-doc does not support long double as returned value type
557 o 607531 : Execute system() calls in subshells to ease debugging
558 o 609062 : [All-langs] [gtk-doc] Translated *.po files not available within ~/po directory
559 o 609194 : sort interface implementers
560 o 610255 : Self-test failure in git as of 2010-02-17: FAIL: gobject.sh
561 o 610257 : Patch to make GTK-DOC notice functions/variables with 'signed' prototypes
562 o 611848 : gtk-doc produces invalid DocBook markup if the SECTION ends with a tag that cannot be nested inside < para >
568 Emilio Pozuelo Monfort
569 Francisco Javier F. Serrador
587 GTK-Doc 1.13 (Dec 18 2009)
590 o 604891 : gtk-doc tarball does not build
596 GTK-Doc 1.12 (Dec 18 2009)
601 o 591450 : Build related fixes
602 o 466535 : generate documentation as pdf
603 o 502191 : acronym support
604 o 532395 : inline function parsing problems (e.g. in glib api docs)
605 o 536928 : have syntax highlghted and xrefs source code samples
606 o 562064 : index generation trouble
607 o 562310 : glib 2.18.3: /bin/sh: line 1: gtkdoc-rebase: command not found
608 o 562655 : doesn't produce deprecation note for signals
609 o 565126 : linking to struct members
610 o 565835 : Three spelling errors in gtk-doc-manual
611 o 566911 : add support for --help and --version to remaining tools
612 o 567132 : Take FOO_GET_INTERFACE as standard
613 o 568702 : gtkdoc-mkhtml no longer works when symlinked
614 o 568706 : gtkdoc-scan: use CamelCase id for interfaces
615 o 568708 : gtkdoc-scan should try not to scan files twice
616 o 568714 : Perl errors when syntax highlighting is not available
617 o 568732 : missing long descriptions undetected
618 o 568734 : configure check for gtk-doc prints that gtk-doc cannot be built
619 o 569339 : abbreviation are not expanded at the start of text
620 o 572396 : Fix to use shave + gtk-doc + libtool 1.x
621 o 572612 : Mistakenly substitute -1 with G_MAXULONG in x86_64
622 o 572967 : use g_strerror
623 o 574654 : --ignore-decorators does not ignore trailing stuff
624 o 575574 : Be more friendly for files with a space in their name
625 o 575623 : Update FSF address
626 o 575711 : < table > element mismatch in highlighted code
627 o 576313 : implicit declarations in testsuite ?
628 o 577059 : Gnome-doc support can't be disabled
629 o 577774 : Test suite run even when built with --disable-gtk-doc
630 o 580206 : gcc warnings in < module > -scan.c
631 o 580300 : gtkdoc-scan picks up _get_type functions it should not
632 o 580622 : xml dir is both part of distclean and dist rules
633 o 581237 : gtk-doc uses wrong gtkdoc-check in " make check " phase
634 o 584952 : " uninitialized value in concatenation " gtkdoc-mkdb line 938
635 o 587103 : return values of function-like macros
636 o 587196 : Typo in a string
637 o 589426 : Python is a required dependency
638 o 591789 : master FTBFS with automake 1.11
639 o 594224 : Please fix manual about inlined SECTION comments (and show warnings when invalid)
640 o 596730 : Signed vs. unsigned comparison in gtkdoc-scangobj.in causing compile errors
641 o 596731 : autogen.sh doesn't recognize automake-1.11
642 o 602026 : Warn if non-existing function gets referenced
643 o 602518 : Doesn't support " long int " return type
644 o 604798 : tests/fail.sh and tests/tools.sh.in use bashisms
666 GTK-Doc 1.11 (Nov 16 2008)
671 o 531572 : one-page generation option
672 o 448879 : Use a footer when generating HTML documentation
673 o 311857 : xsltproc very slow generating index for gtk-docs.sgml
674 o 335239 : Using gnome-doc-utils for gtk-doc documentation
675 o 460753 : enable vpath build in gtkdoc-mkhtml
676 o 473342 : Warn about repeated symbols in sections
677 o 487727 : DocBook XML DTD version
678 o 523669 : make check: Element publisher content does not follow the...
679 o 530758 : gtk-doc should not expand XML tags and their attributes
680 o 533262 : no-template mode scans different source files
681 o 534627 : gtk-doc uses non-standard HTML element
682 o 542137 : No declaration found for: gsf_output_*
683 o 543855 : Fix for Bug 460753 (enable vpath build in gtkdoc-mkhtml) ...
684 o 544172 : Fails to parse return value of 'char const *'
685 o 552822 : Add rules to create $(REPORT_FILES)
686 o 553407 : Example Makefile.am uses obsolete INCLUDES instead of AM_...
687 o 554718 : gtk-doc needs to allow versioned TARGET_DIR
688 o 554833 : Be more careful with " struct _ < struct_name > "
689 o 558082 : evince docs build fails with GTK_DISABLE_SINGLE_INCLUDES
690 o 559281 : Correct check for existance of gtkdoc-rebase
707 GTK-Doc 1.10 (Mar 20 2008)
712 o 460753 : enable vpath build in gtkdoc-mkhtml
713 o 503119 : Add dependency on content_files to SGML target
714 o 127049 : building reference documentation fails when builddir != s...
715 o 481811 : Inline function bodies are confused with declarations
716 o 448879 : Use a footer when generating HTML documentation
717 o 492005 : Deprecation guard warnings for properties and signals
718 o 498521 : Inconsistent compiler flags passed in gtk-doc.make
719 o 365913 : gtk-doc output is not predictable
720 o 446648 : gtk-doc does not handle forward typedef'd enums
721 o 468278 : Display proper types for properties
722 o 497367 : don't use US-ASCII for output encoding
723 o 501066 : Missing quotes around gtkdoc-rebase check cause a warning
724 o 508897 : [PATCH] Fix build when gtk-doc is not installed
725 o 509539 : Building documentation aborts when no .types file is present
726 o 512154 : Struct member type attributes are limited to one token
727 o 513318 : gtk-doc.el doesn't work fine with emacs22
747 GTK-Doc 1.9 (Sep 30 2007)
752 o 419308 : unsynced regexps for parameter parsing
753 o 449618 : Top navigation bar is in the way
754 o 453717 : fixxref logic to determine absolute path's is flawed
755 o 457173 : unit tests for gtk-doc
756 o 465920 : Use gtkdoc-rebase
757 o 467773 : default master doc should have proper extension
758 o 141869 : Poor error generated when faced with a type declared as '...
759 o 156643 : Avoid make error in gtk-doc.make
760 o 322035 : wrong macro parsing
761 o 323938 : gtk-doc.m4 check is silent
762 o 324535 : gtk-doc doesn't handle deprecation inside enumerations
763 o 355352 : If you don't have an instantiatable type for a gtypeinter...
764 o 379466 : Improve C parser to handle TYPE\nVARIABLE in function pro...
765 o 380824 : docs are truncated if line begins with '* returns '
766 o 383456 : ' make check ' test for 100% documentation
767 o 411739 : Gtk-doc fails to handle ' struct tm * function_name (); '
768 o 415388 : Please clean -undocumented.txt files
769 o 418027 : gtkdoc-mkdb does not handle #ifdef in enum {}
770 o 419997 : parameter name trouble
771 o 428596 : Warnings with gtk-doc.m4 macros
772 o 434134 : fixxrefs like sed for installing pregenerated docs
773 o 436565 : Report undeclared symbols into a file
774 o 445596 : Impossible to link a page with an anchor
775 o 445693 : Does not understand ' unsigned long ' as a type
776 o 450338 : Make gtk-doc.m4 fail when needed gtk-doc is not installed
777 o 454916 : gtk-doc should permit generation of URI-based cross-refer...
778 o 457077 : add --no-implicit-returns to gtkdoc-mkdb
779 o 459225 : Accept automake-1.10 in autogen.sh
780 o 459725 : ' jhbuild build gtk-doc ' fails on make
781 o 460127 : parsing nested union/structs confuses public/private state
782 o 465365 : [PATCH] gtk-doc does not compile
783 o 466559 : [CSS] styling <hr />;
784 o 471014 : G_CONST_RETURN * G_CONST_RETURN * function not picked up
785 o 477532 : function variables
786 o 479913 : gtk-doc.notmpl.make is not distributed
787 o 479923 : distclean test output properly
803 GTK-Doc 1.8 (Feb 16 2007)
806 o Made it easier to include example code in the source code comment blocks.
807 "|[ ... ]|" can be used to delineate example code (it just gets converted
808 to "<informalexample><programlisting>"), and most of the text in example
809 code is left as it is. The only thing that is still expanded is
810 '#' to allow links to a symbol's documentation, e.g. '#GtkWidget'.
811 o Made the field widths wider for the HTML output, so it looks a bit nicer.
812 o Added a '--rebuild-sections' option to gtkdoc-scan to automatically rebuild
813 the MODULE-sections.txt file. This only works if all the header files are
814 organized neatly and functions don't need rearranging in the docs.
815 o Added a '--rebuild-types' option to gtkdoc-scan to automatically rebuild
816 the MODULE.types file, so you don't need to add new types manually.
817 o Leave CDATA sections as they are, in the extra XML content files and within
818 source code comment blocks.
819 o Allow the section id and #include's to be set within the "SECTION:" comment
820 block, using "@Section_ID:xxx" and "@Include:".
821 o Added "--default-includes" option to specify the default #include's (for
822 people who are using --rebuild-sections and so can't specify it in
823 MODULE-sections.txt).
824 o Added a '--query-child-properties' argument to help document child
825 properties of arbitrary GObjects (used by things like canvas widgets).
826 o Fixed documentation of signals of interfaces.
829 GTK-Doc 1.7 (Jul 29 2006)
832 o Fixed bug that resulted in empty "@:" lines in the templates.
833 o Fixed a few bugs with the XSL code.
834 o Supported a few more variations of C syntax.
835 o Remove the internally-used '-struct' suffix from links to widget structs.
836 o Fixed a few missing build dependencies.
837 o Added a new "C-x4s" binding to the emacs lisp code, to insert a blank
838 section header in the source code.
839 o Fixed bug that ignored inline section header docs with '-' in their names.
840 o Added a 'make docs' target that can be used to build the docs even when
841 gtk-doc has been disabled at configure time.
844 GTK-Doc 1.6 (Apr 9 2006)
847 o Removed the hard dependancy on openjade or jade, since XML is used mainly
848 now rather than SGML.
849 o Install the .pc file in $(datadir) rather than $(libdir) since gtk-doc is
850 architecture-independant.
851 o Added "--ignore-decorators" option to ignore a list of declarators in
852 function declarations.
853 o Support '#Object::signal'/'#Object:property' to link to signals/properties
854 o Fixed missing index terms.
857 GTK-Doc 1.5 (Mar 7 2006)
860 o Output the new version of devhelp2 information, but still generate the old
861 devhelp files so older versions of DevHelp still work OK.
862 o Fixed the initial creation of the *-sections.txt file so the object
863 hierarchy, signals and properties all work automatically.
864 o Show information about signal flags (run first/last).
865 o Support a --source-suffixes argument specifying which source files to scan.
866 o Support other root object types besides GObject and GInterface.
867 o Use a fixed navigation bar for the generated documentation.
868 o New documentation from Stefan Kost.
869 o Handle more variations of C syntax.
872 GTK-Doc 1.4 (Jul 3 2005)
875 o Support section documentation (title, short description, long description
876 and 'see also') within the source code. I think everything can now be
877 documented within the source code.
878 o Support Stable/Unstable/Private stability levels for everything.
881 GTK-Doc 1.3 (Jan 9 2005)
884 o Use the new style.css stylesheet instead of hard-wiring the styles.
885 o Updated the documentation and example build files.
886 o Added support for a gallery of widget images.
887 o Output default values for widget properties and allowed ranges.
888 o Only underline links in the docs when the mouse hovers over them.
889 o Added support for placing the parameter table anywhere within the function
890 documentation (using the "<!--PARAMETERS-->" marker).
891 o Handle more variations of C syntax.
894 GTK-Doc 1.2 (Feb 16 2004)
897 o Added widget signals and properties to undocumented output and statistics.
898 o Added support for an index of all symbols.
899 o Emit "Since:" information for signals and properties.
900 o Added derived subclasses and interfaces to the widget hierarchies.
901 o Added .cat SGML catalog file.
902 o Support properties on interfaces.
903 o Added "--help" options to the scripts.
906 GTK-Doc 1.1 (Apr 18 2003)
909 o Add a gtk-doc.m4 macro that allows packages to provide consistent
910 checking for gtk-doc.
911 o Check to make sure that the XML catalog actually contains entries
912 for the DocBook XML DTD and XSLT stylesheets. Please consult the
913 README file if your system's XML catalog isn't set up.
914 o Add infrastructure for including the standard gtk-doc makefile
915 glue, so that maintainers of packages don't need to worry about
916 keeping it up to date. See glib head for an example of its use.
917 o Some updates to the devhelp contents file generation, as suggested
919 o Fix some bugs in the DocBook XML codepath that were preventing
920 inter-module cross references from being resolved.
921 o Fix some bugs in extraction of object property documentation.
924 GTK-Doc 1.0 (Jan 20 2003)
927 o Added support for "Since:" and "Deprecated:" tags, and look for deprecated
928 guard macros in header files.
929 o Support /*< public >*/ and /*< private >*/ markers for all structs.
930 o New "--ignore-files" option for gtkdoc-mkdb, to ignore files or directories.
931 o Used the "sgml-raw" output type with openjade, to avoid problems with Lynx.
932 o Added .pc pkg-config file which can be used to check the gtk-doc version.
935 GTK-Doc 0.10 (Nov 14 2002)
938 o --output-format option to select whether SGML or XML is generated.
939 o Use openjade or jade when converting SGML to HTML.
940 o Use xsltproc to convert XML to HTML, with a new look.
941 o In XML mode, support XIncludes as an alternative to entities.
942 o In XML mode, create .devhelp files.
943 o List interfaces in the object hierarchy.
944 o Create docs for signals on interfaces.
945 o Generate links between interface and their implementations and
947 o Create docs for child and style properties.
948 o Use blurbs for property documentation.
949 o Allow inline documentation for signals and properties.