1 GTK-Doc 1.18 (Sep 14 2011)
4 o gtk-doc supports a subset of markdown (headings and lists) - see
5 http://git.gnome.org/browse/gtk-doc/tree/tests/gobject/src/gobject.c
6 o gtk-doc does not generate old devhelp files any more. This cuts down doc
7 generation time and works for devhelp >=0.11 (was released in 2005).
8 o changes for out-of-source dir build caused breakage for projects using
9 DOC_SOURCE_DIR with a relative path (to builddir). It is recommended to use
10 DOC_SOURCE_DIR=$(top_srcdir)/src/xxx.
14 o 590927 : Support AM_SILENT_RULES for doc-build steps
15 o 617121 : /* < private > */ declarations in enums are still displayed
16 o 627758 : A way to ignore a symbol
17 o 639145 : shorthand syntax for headings
18 o 644291 : Enum parser breaks on assignment of ')'
19 o 646870 : HTML_IMAGES no longer in EXTRA_DIST
20 o 648289 : gtkdoc-mkdb doesn't compile.
21 o 648331 : Specify compatible options for 'highlight' consistently.
22 o 649269 : gtkdoc-scanobj should set some of its own CFLAGS/LDFLAGS
23 o 650407 : Buildings docs while distchecking produces thousands of “No declaration found” warnings, then fails.
24 o 652746 : Documentation of plain boxed structs broken
25 o 652764 : Update autotools config a bit
26 o 655711 : summarize depscan output by package
27 o 656453 : Performance improvements (PATCH)
28 o 656658 : gtk-doc.make: install target doesn't install docs when building in a separate directory
29 o 656773 : gtk-doc fails to find a symbol declared as 'char* const'
30 o 656946 : gtk-doc unable to handle 'extern short int'
31 o 657377 : srcdir!=builddir builds discard contents of tmpl
51 GTK-Doc 1.17 (Feb 16 2011)
56 o 127049 : building reference documentation fails when builddir != srcdir
57 o 640241 : non-srcdir builds busted
65 GTK-Doc 1.16 (Jan 14 2011)
68 o gtkdoc-check can do more checks, one might need to update Makefile.am from
69 the examples/Makefile.am
73 o 625776 : serialise doubles and floats always with a decimal dot
74 o 627269 : link to signalflags docs from signal descriptions
75 o 467488 : GTK+ man pages request
76 o 481811 : Inline function bodies are confused with declarations
77 o 501107 : EXTRA_DIST automake warnings
78 o 512565 : add GTK_DOC_IGNORE
79 o 518427 : documentation best pratices needed
80 o 597937 : Function pointers as parameters to other functions are parsed improperly
81 o 612028 : gtkdoc-fixxref should call /usr/bin/vim -n -e -u NONE -T xterm
82 o 617478 : Tooltip is a nuisance
83 o 618379 : Navigation is hiding anchors title
84 o 620249 : invalid xml for object_index with (n_objects % 3) == 0
85 o 621931 : support GType and GVariant types
86 o 622971 : List of typos in the GTK-doc manual
87 o 623777 : G_TYPE_STRV in signals generate wrong docs
88 o 623968 : gtkdoc-mkdb generates invalid xml from sgml in inline comments
89 o 624199 : parser picks up contents of large macros
90 o 624200 : 'const' confuses the parser
91 o 627223 : gtkdoc-fixxref vim highlight fails on xhtml suffix
92 o 627920 : `make check` rule to list xml files missing from DOC_MAIN_SGML_FILE
93 o 628611 : gtk-doc > = 1.13 creates automagic dependencies on syntax highlighters
94 o 628794 : Issue in gtkdoc-mkman.in
95 o 630288 : Fix 'scope notified' annotation
96 o 631336 : remove lists of gtk+ signal args in gtkdoc-scanobj and -scangobj
97 o 632587 : gtkdoc-scanner fails to identify (closure) annotation
98 o 638330 : const in parameter list is ignored
99 o 638831 : Support GTK+ 3 cell properties
106 Gilles Dartiguelongue
122 GTK-Doc 1.15 (May 21 2010)
127 o 614496 : Support for multiple DOC_SOURCE_DIR directories
128 o 615550 : gtk-doc fails to recognize (scope ...) and (skip) annotations
138 GTK-Doc 1.14 (Mar 28 2010)
143 o 593282 : Append " _struct " prefix to every struct name
144 o 599514 : sane support for per-page images
145 o 604892 : checks fail
146 o 613611 : parameter descriptions with annotations truncated at first \n
147 o 115531 : add short description to index entries
148 o 165425 : gtk-doc fails to parse unions
149 o 512155 : gets confused by multiline typedef
150 o 568711 : undocumented enum values are not reported
151 o 590602 : secondly running gtkdoc-mkdb will generate DOCTYPE missing XML files
152 o 590625 : $(DOC_MODULE)-overrides.txt is required by " make dist "
153 o 591975 : Section_Id always embeds a trailing newline
154 o 604885 : Fix the use of gtkdocize --flavour option
155 o 604992 : gtkdoc-fixxref broken link warning is broken for functions
156 o 604995 : Syntax error in gtkdoc-mkman
157 o 604998 : Check for syntax errors in the test suite
158 o 605052 : put class structs to the generated section file
159 o 605211 : Many build failures with gtk-doc 1.13
160 o 605281 : Add " Since " and " Deprecated " tag to function example
161 o 605285 : Add < keycap > and < keycombo > example
162 o 605289 : Some documentation improvements
163 o 605452 : Added more info to " Documenting symbols " sectio
164 o 605564 : Env var equivalent to --flavour=no-tmpl
165 o 606661 : XInclude error while gnerating documentation
166 o 607445 : gtk-doc does not support long double as returned value type
167 o 607531 : Execute system() calls in subshells to ease debugging
168 o 609062 : [All-langs] [gtk-doc] Translated *.po files not available within ~/po directory
169 o 609194 : sort interface implementers
170 o 610255 : Self-test failure in git as of 2010-02-17: FAIL: gobject.sh
171 o 610257 : Patch to make GTK-DOC notice functions/variables with 'signed' prototypes
172 o 611848 : gtk-doc produces invalid DocBook markup if the SECTION ends with a tag that cannot be nested inside < para >
178 Emilio Pozuelo Monfort
179 Francisco Javier F. Serrador
197 GTK-Doc 1.13 (Dec 18 2009)
200 o 604891 : gtk-doc tarball does not build
206 GTK-Doc 1.12 (Dec 18 2009)
211 o 591450 : Build related fixes
212 o 466535 : generate documentation as pdf
213 o 502191 : acronym support
214 o 532395 : inline function parsing problems (e.g. in glib api docs)
215 o 536928 : have syntax highlghted and xrefs source code samples
216 o 562064 : index generation trouble
217 o 562310 : glib 2.18.3: /bin/sh: line 1: gtkdoc-rebase: command not found
218 o 562655 : doesn't produce deprecation note for signals
219 o 565126 : linking to struct members
220 o 565835 : Three spelling errors in gtk-doc-manual
221 o 566911 : add support for --help and --version to remaining tools
222 o 567132 : Take FOO_GET_INTERFACE as standard
223 o 568702 : gtkdoc-mkhtml no longer works when symlinked
224 o 568706 : gtkdoc-scan: use CamelCase id for interfaces
225 o 568708 : gtkdoc-scan should try not to scan files twice
226 o 568714 : Perl errors when syntax highlighting is not available
227 o 568732 : missing long descriptions undetected
228 o 568734 : configure check for gtk-doc prints that gtk-doc cannot be built
229 o 569339 : abbreviation are not expanded at the start of text
230 o 572396 : Fix to use shave + gtk-doc + libtool 1.x
231 o 572612 : Mistakenly substitute -1 with G_MAXULONG in x86_64
232 o 572967 : use g_strerror
233 o 574654 : --ignore-decorators does not ignore trailing stuff
234 o 575574 : Be more friendly for files with a space in their name
235 o 575623 : Update FSF address
236 o 575711 : < table > element mismatch in highlighted code
237 o 576313 : implicit declarations in testsuite ?
238 o 577059 : Gnome-doc support can't be disabled
239 o 577774 : Test suite run even when built with --disable-gtk-doc
240 o 580206 : gcc warnings in < module > -scan.c
241 o 580300 : gtkdoc-scan picks up _get_type functions it should not
242 o 580622 : xml dir is both part of distclean and dist rules
243 o 581237 : gtk-doc uses wrong gtkdoc-check in " make check " phase
244 o 584952 : " uninitialized value in concatenation " gtkdoc-mkdb line 938
245 o 587103 : return values of function-like macros
246 o 587196 : Typo in a string
247 o 589426 : Python is a required dependency
248 o 591789 : master FTBFS with automake 1.11
249 o 594224 : Please fix manual about inlined SECTION comments (and show warnings when invalid)
250 o 596730 : Signed vs. unsigned comparison in gtkdoc-scangobj.in causing compile errors
251 o 596731 : autogen.sh doesn't recognize automake-1.11
252 o 602026 : Warn if non-existing function gets referenced
253 o 602518 : Doesn't support " long int " return type
254 o 604798 : tests/fail.sh and tests/tools.sh.in use bashisms
276 GTK-Doc 1.11 (Nov 16 2008)
281 o 531572 : one-page generation option
282 o 448879 : Use a footer when generating HTML documentation
283 o 311857 : xsltproc very slow generating index for gtk-docs.sgml
284 o 335239 : Using gnome-doc-utils for gtk-doc documentation
285 o 460753 : enable vpath build in gtkdoc-mkhtml
286 o 473342 : Warn about repeated symbols in sections
287 o 487727 : DocBook XML DTD version
288 o 523669 : make check: Element publisher content does not follow the...
289 o 530758 : gtk-doc should not expand XML tags and their attributes
290 o 533262 : no-template mode scans different source files
291 o 534627 : gtk-doc uses non-standard HTML element
292 o 542137 : No declaration found for: gsf_output_*
293 o 543855 : Fix for Bug 460753 (enable vpath build in gtkdoc-mkhtml) ...
294 o 544172 : Fails to parse return value of 'char const *'
295 o 552822 : Add rules to create $(REPORT_FILES)
296 o 553407 : Example Makefile.am uses obsolete INCLUDES instead of AM_...
297 o 554718 : gtk-doc needs to allow versioned TARGET_DIR
298 o 554833 : Be more careful with " struct _ < struct_name > "
299 o 558082 : evince docs build fails with GTK_DISABLE_SINGLE_INCLUDES
300 o 559281 : Correct check for existance of gtkdoc-rebase
317 GTK-Doc 1.10 (Mar 20 2008)
322 o 460753 : enable vpath build in gtkdoc-mkhtml
323 o 503119 : Add dependency on content_files to SGML target
324 o 127049 : building reference documentation fails when builddir != s...
325 o 481811 : Inline function bodies are confused with declarations
326 o 448879 : Use a footer when generating HTML documentation
327 o 492005 : Deprecation guard warnings for properties and signals
328 o 498521 : Inconsistent compiler flags passed in gtk-doc.make
329 o 365913 : gtk-doc output is not predictable
330 o 446648 : gtk-doc does not handle forward typedef'd enums
331 o 468278 : Display proper types for properties
332 o 497367 : don't use US-ASCII for output encoding
333 o 501066 : Missing quotes around gtkdoc-rebase check cause a warning
334 o 508897 : [PATCH] Fix build when gtk-doc is not installed
335 o 509539 : Building documentation aborts when no .types file is present
336 o 512154 : Struct member type attributes are limited to one token
337 o 513318 : gtk-doc.el doesn't work fine with emacs22
357 GTK-Doc 1.9 (Sep 30 2007)
362 o 419308 : unsynced regexps for parameter parsing
363 o 449618 : Top navigation bar is in the way
364 o 453717 : fixxref logic to determine absolute path's is flawed
365 o 457173 : unit tests for gtk-doc
366 o 465920 : Use gtkdoc-rebase
367 o 467773 : default master doc should have proper extension
368 o 141869 : Poor error generated when faced with a type declared as '...
369 o 156643 : Avoid make error in gtk-doc.make
370 o 322035 : wrong macro parsing
371 o 323938 : gtk-doc.m4 check is silent
372 o 324535 : gtk-doc doesn't handle deprecation inside enumerations
373 o 355352 : If you don't have an instantiatable type for a gtypeinter...
374 o 379466 : Improve C parser to handle TYPE\nVARIABLE in function pro...
375 o 380824 : docs are truncated if line begins with '* returns '
376 o 383456 : ' make check ' test for 100% documentation
377 o 411739 : Gtk-doc fails to handle ' struct tm * function_name (); '
378 o 415388 : Please clean -undocumented.txt files
379 o 418027 : gtkdoc-mkdb does not handle #ifdef in enum {}
380 o 419997 : parameter name trouble
381 o 428596 : Warnings with gtk-doc.m4 macros
382 o 434134 : fixxrefs like sed for installing pregenerated docs
383 o 436565 : Report undeclared symbols into a file
384 o 445596 : Impossible to link a page with an anchor
385 o 445693 : Does not understand ' unsigned long ' as a type
386 o 450338 : Make gtk-doc.m4 fail when needed gtk-doc is not installed
387 o 454916 : gtk-doc should permit generation of URI-based cross-refer...
388 o 457077 : add --no-implicit-returns to gtkdoc-mkdb
389 o 459225 : Accept automake-1.10 in autogen.sh
390 o 459725 : ' jhbuild build gtk-doc ' fails on make
391 o 460127 : parsing nested union/structs confuses public/private state
392 o 465365 : [PATCH] gtk-doc does not compile
393 o 466559 : [CSS] styling <hr />;
394 o 471014 : G_CONST_RETURN * G_CONST_RETURN * function not picked up
395 o 477532 : function variables
396 o 479913 : gtk-doc.notmpl.make is not distributed
397 o 479923 : distclean test output properly
413 GTK-Doc 1.8 (Feb 16 2007)
416 o Made it easier to include example code in the source code comment blocks.
417 "|[ ... ]|" can be used to delineate example code (it just gets converted
418 to "<informalexample><programlisting>"), and most of the text in example
419 code is left as it is. The only thing that is still expanded is
420 '#' to allow links to a symbol's documentation, e.g. '#GtkWidget'.
421 o Made the field widths wider for the HTML output, so it looks a bit nicer.
422 o Added a '--rebuild-sections' option to gtkdoc-scan to automatically rebuild
423 the MODULE-sections.txt file. This only works if all the header files are
424 organized neatly and functions don't need rearranging in the docs.
425 o Added a '--rebuild-types' option to gtkdoc-scan to automatically rebuild
426 the MODULE.types file, so you don't need to add new types manually.
427 o Leave CDATA sections as they are, in the extra XML content files and within
428 source code comment blocks.
429 o Allow the section id and #include's to be set within the "SECTION:" comment
430 block, using "@Section_ID:xxx" and "@Include:".
431 o Added "--default-includes" option to specify the default #include's (for
432 people who are using --rebuild-sections and so can't specify it in
433 MODULE-sections.txt).
434 o Added a '--query-child-properties' argument to help document child
435 properties of arbitrary GObjects (used by things like canvas widgets).
436 o Fixed documentation of signals of interfaces.
439 GTK-Doc 1.7 (Jul 29 2006)
442 o Fixed bug that resulted in empty "@:" lines in the templates.
443 o Fixed a few bugs with the XSL code.
444 o Supported a few more variations of C syntax.
445 o Remove the internally-used '-struct' suffix from links to widget structs.
446 o Fixed a few missing build dependencies.
447 o Added a new "C-x4s" binding to the emacs lisp code, to insert a blank
448 section header in the source code.
449 o Fixed bug that ignored inline section header docs with '-' in their names.
450 o Added a 'make docs' target that can be used to build the docs even when
451 gtk-doc has been disabled at configure time.
454 GTK-Doc 1.6 (Apr 9 2006)
457 o Removed the hard dependancy on openjade or jade, since XML is used mainly
458 now rather than SGML.
459 o Install the .pc file in $(datadir) rather than $(libdir) since gtk-doc is
460 architecture-independant.
461 o Added "--ignore-decorators" option to ignore a list of declarators in
462 function declarations.
463 o Support '#Object::signal'/'#Object:property' to link to signals/properties
464 o Fixed missing index terms.
467 GTK-Doc 1.5 (Mar 7 2006)
470 o Output the new version of devhelp2 information, but still generate the old
471 devhelp files so older versions of DevHelp still work OK.
472 o Fixed the initial creation of the *-sections.txt file so the object
473 hierarchy, signals and properties all work automatically.
474 o Show information about signal flags (run first/last).
475 o Support a --source-suffixes argument specifying which source files to scan.
476 o Support other root object types besides GObject and GInterface.
477 o Use a fixed navigation bar for the generated documentation.
478 o New documentation from Stefan Kost.
479 o Handle more variations of C syntax.
482 GTK-Doc 1.4 (Jul 3 2005)
485 o Support section documentation (title, short description, long description
486 and 'see also') within the source code. I think everything can now be
487 documented within the source code.
488 o Support Stable/Unstable/Private stability levels for everything.
491 GTK-Doc 1.3 (Jan 9 2005)
494 o Use the new style.css stylesheet instead of hard-wiring the styles.
495 o Updated the documentation and example build files.
496 o Added support for a gallery of widget images.
497 o Output default values for widget properties and allowed ranges.
498 o Only underline links in the docs when the mouse hovers over them.
499 o Added support for placing the parameter table anywhere within the function
500 documentation (using the "<!--PARAMETERS-->" marker).
501 o Handle more variations of C syntax.
504 GTK-Doc 1.2 (Feb 16 2004)
507 o Added widget signals and properties to undocumented output and statistics.
508 o Added support for an index of all symbols.
509 o Emit "Since:" information for signals and properties.
510 o Added derived subclasses and interfaces to the widget hierarchies.
511 o Added .cat SGML catalog file.
512 o Support properties on interfaces.
513 o Added "--help" options to the scripts.
516 GTK-Doc 1.1 (Apr 18 2003)
519 o Add a gtk-doc.m4 macro that allows packages to provide consistent
520 checking for gtk-doc.
521 o Check to make sure that the XML catalog actually contains entries
522 for the DocBook XML DTD and XSLT stylesheets. Please consult the
523 README file if your system's XML catalog isn't set up.
524 o Add infrastructure for including the standard gtk-doc makefile
525 glue, so that maintainers of packages don't need to worry about
526 keeping it up to date. See glib head for an example of its use.
527 o Some updates to the devhelp contents file generation, as suggested
529 o Fix some bugs in the DocBook XML codepath that were preventing
530 inter-module cross references from being resolved.
531 o Fix some bugs in extraction of object property documentation.
534 GTK-Doc 1.0 (Jan 20 2003)
537 o Added support for "Since:" and "Deprecated:" tags, and look for deprecated
538 guard macros in header files.
539 o Support /*< public >*/ and /*< private >*/ markers for all structs.
540 o New "--ignore-files" option for gtkdoc-mkdb, to ignore files or directories.
541 o Used the "sgml-raw" output type with openjade, to avoid problems with Lynx.
542 o Added .pc pkg-config file which can be used to check the gtk-doc version.
545 GTK-Doc 0.10 (Nov 14 2002)
548 o --output-format option to select whether SGML or XML is generated.
549 o Use openjade or jade when converting SGML to HTML.
550 o Use xsltproc to convert XML to HTML, with a new look.
551 o In XML mode, support XIncludes as an alternative to entities.
552 o In XML mode, create .devhelp files.
553 o List interfaces in the object hierarchy.
554 o Create docs for signals on interfaces.
555 o Generate links between interface and their implementations and
557 o Create docs for child and style properties.
558 o Use blurbs for property documentation.
559 o Allow inline documentation for signals and properties.