1 GTK-Doc 1.16 (Jan 14 2011)
4 o gtkdoc-check can do more checks, one might need to update Makefile.am from
5 the examples/Makefile.am
9 o 625776 : serialise doubles and floats always with a decimal dot
10 o 627269 : link to signalflags docs from signal descriptions
11 o 467488 : GTK+ man pages request
12 o 481811 : Inline function bodies are confused with declarations
13 o 501107 : EXTRA_DIST automake warnings
14 o 512565 : add GTK_DOC_IGNORE
15 o 518427 : documentation best pratices needed
16 o 597937 : Function pointers as parameters to other functions are parsed improperly
17 o 612028 : gtkdoc-fixxref should call /usr/bin/vim -n -e -u NONE -T xterm
18 o 617478 : Tooltip is a nuisance
19 o 618379 : Navigation is hiding anchors title
20 o 620249 : invalid xml for object_index with (n_objects % 3) == 0
21 o 621931 : support GType and GVariant types
22 o 622971 : List of typos in the GTK-doc manual
23 o 623777 : G_TYPE_STRV in signals generate wrong docs
24 o 623968 : gtkdoc-mkdb generates invalid xml from sgml in inline comments
25 o 624199 : parser picks up contents of large macros
26 o 624200 : 'const' confuses the parser
27 o 627223 : gtkdoc-fixxref vim highlight fails on xhtml suffix
28 o 627920 : `make check` rule to list xml files missing from DOC_MAIN_SGML_FILE
29 o 628611 : gtk-doc > = 1.13 creates automagic dependencies on syntax highlighters
30 o 628794 : Issue in gtkdoc-mkman.in
31 o 630288 : Fix 'scope notified' annotation
32 o 631336 : remove lists of gtk+ signal args in gtkdoc-scanobj and -scangobj
33 o 632587 : gtkdoc-scanner fails to identify (closure) annotation
34 o 638330 : const in parameter list is ignored
35 o 638831 : Support GTK+ 3 cell properties
58 GTK-Doc 1.15 (May 21 2010)
63 o 614496 : Support for multiple DOC_SOURCE_DIR directories
64 o 615550 : gtk-doc fails to recognize (scope ...) and (skip) annotations
74 GTK-Doc 1.14 (Mar 28 2010)
79 o 593282 : Append " _struct " prefix to every struct name
80 o 599514 : sane support for per-page images
81 o 604892 : checks fail
82 o 613611 : parameter descriptions with annotations truncated at first \n
83 o 115531 : add short description to index entries
84 o 165425 : gtk-doc fails to parse unions
85 o 512155 : gets confused by multiline typedef
86 o 568711 : undocumented enum values are not reported
87 o 590602 : secondly running gtkdoc-mkdb will generate DOCTYPE missing XML files
88 o 590625 : $(DOC_MODULE)-overrides.txt is required by " make dist "
89 o 591975 : Section_Id always embeds a trailing newline
90 o 604885 : Fix the use of gtkdocize --flavour option
91 o 604992 : gtkdoc-fixxref broken link warning is broken for functions
92 o 604995 : Syntax error in gtkdoc-mkman
93 o 604998 : Check for syntax errors in the test suite
94 o 605052 : put class structs to the generated section file
95 o 605211 : Many build failures with gtk-doc 1.13
96 o 605281 : Add " Since " and " Deprecated " tag to function example
97 o 605285 : Add < keycap > and < keycombo > example
98 o 605289 : Some documentation improvements
99 o 605452 : Added more info to " Documenting symbols " sectio
100 o 605564 : Env var equivalent to --flavour=no-tmpl
101 o 606661 : XInclude error while gnerating documentation
102 o 607445 : gtk-doc does not support long double as returned value type
103 o 607531 : Execute system() calls in subshells to ease debugging
104 o 609062 : [All-langs] [gtk-doc] Translated *.po files not available within ~/po directory
105 o 609194 : sort interface implementers
106 o 610255 : Self-test failure in git as of 2010-02-17: FAIL: gobject.sh
107 o 610257 : Patch to make GTK-DOC notice functions/variables with 'signed' prototypes
108 o 611848 : gtk-doc produces invalid DocBook markup if the SECTION ends with a tag that cannot be nested inside < para >
114 Emilio Pozuelo Monfort
115 Francisco Javier F. Serrador
133 GTK-Doc 1.13 (Dec 18 2009)
136 o 604891 : gtk-doc tarball does not build
142 GTK-Doc 1.12 (Dec 18 2009)
147 o 591450 : Build related fixes
148 o 466535 : generate documentation as pdf
149 o 502191 : acronym support
150 o 532395 : inline function parsing problems (e.g. in glib api docs)
151 o 536928 : have syntax highlghted and xrefs source code samples
152 o 562064 : index generation trouble
153 o 562310 : glib 2.18.3: /bin/sh: line 1: gtkdoc-rebase: command not found
154 o 562655 : doesn't produce deprecation note for signals
155 o 565126 : linking to struct members
156 o 565835 : Three spelling errors in gtk-doc-manual
157 o 566911 : add support for --help and --version to remaining tools
158 o 567132 : Take FOO_GET_INTERFACE as standard
159 o 568702 : gtkdoc-mkhtml no longer works when symlinked
160 o 568706 : gtkdoc-scan: use CamelCase id for interfaces
161 o 568708 : gtkdoc-scan should try not to scan files twice
162 o 568714 : Perl errors when syntax highlighting is not available
163 o 568732 : missing long descriptions undetected
164 o 568734 : configure check for gtk-doc prints that gtk-doc cannot be built
165 o 569339 : abbreviation are not expanded at the start of text
166 o 572396 : Fix to use shave + gtk-doc + libtool 1.x
167 o 572612 : Mistakenly substitute -1 with G_MAXULONG in x86_64
168 o 572967 : use g_strerror
169 o 574654 : --ignore-decorators does not ignore trailing stuff
170 o 575574 : Be more friendly for files with a space in their name
171 o 575623 : Update FSF address
172 o 575711 : < table > element mismatch in highlighted code
173 o 576313 : implicit declarations in testsuite ?
174 o 577059 : Gnome-doc support can't be disabled
175 o 577774 : Test suite run even when built with --disable-gtk-doc
176 o 580206 : gcc warnings in < module > -scan.c
177 o 580300 : gtkdoc-scan picks up _get_type functions it should not
178 o 580622 : xml dir is both part of distclean and dist rules
179 o 581237 : gtk-doc uses wrong gtkdoc-check in " make check " phase
180 o 584952 : " uninitialized value in concatenation " gtkdoc-mkdb line 938
181 o 587103 : return values of function-like macros
182 o 587196 : Typo in a string
183 o 589426 : Python is a required dependency
184 o 591789 : master FTBFS with automake 1.11
185 o 594224 : Please fix manual about inlined SECTION comments (and show warnings when invalid)
186 o 596730 : Signed vs. unsigned comparison in gtkdoc-scangobj.in causing compile errors
187 o 596731 : autogen.sh doesn't recognize automake-1.11
188 o 602026 : Warn if non-existing function gets referenced
189 o 602518 : Doesn't support " long int " return type
190 o 604798 : tests/fail.sh and tests/tools.sh.in use bashisms
212 GTK-Doc 1.11 (Nov 16 2008)
217 o 531572 : one-page generation option
218 o 448879 : Use a footer when generating HTML documentation
219 o 311857 : xsltproc very slow generating index for gtk-docs.sgml
220 o 335239 : Using gnome-doc-utils for gtk-doc documentation
221 o 460753 : enable vpath build in gtkdoc-mkhtml
222 o 473342 : Warn about repeated symbols in sections
223 o 487727 : DocBook XML DTD version
224 o 523669 : make check: Element publisher content does not follow the...
225 o 530758 : gtk-doc should not expand XML tags and their attributes
226 o 533262 : no-template mode scans different source files
227 o 534627 : gtk-doc uses non-standard HTML element
228 o 542137 : No declaration found for: gsf_output_*
229 o 543855 : Fix for Bug 460753 (enable vpath build in gtkdoc-mkhtml) ...
230 o 544172 : Fails to parse return value of 'char const *'
231 o 552822 : Add rules to create $(REPORT_FILES)
232 o 553407 : Example Makefile.am uses obsolete INCLUDES instead of AM_...
233 o 554718 : gtk-doc needs to allow versioned TARGET_DIR
234 o 554833 : Be more careful with " struct _ < struct_name > "
235 o 558082 : evince docs build fails with GTK_DISABLE_SINGLE_INCLUDES
236 o 559281 : Correct check for existance of gtkdoc-rebase
253 GTK-Doc 1.10 (Mar 20 2008)
258 o 460753 : enable vpath build in gtkdoc-mkhtml
259 o 503119 : Add dependency on content_files to SGML target
260 o 127049 : building reference documentation fails when builddir != s...
261 o 481811 : Inline function bodies are confused with declarations
262 o 448879 : Use a footer when generating HTML documentation
263 o 492005 : Deprecation guard warnings for properties and signals
264 o 498521 : Inconsistent compiler flags passed in gtk-doc.make
265 o 365913 : gtk-doc output is not predictable
266 o 446648 : gtk-doc does not handle forward typedef'd enums
267 o 468278 : Display proper types for properties
268 o 497367 : don't use US-ASCII for output encoding
269 o 501066 : Missing quotes around gtkdoc-rebase check cause a warning
270 o 508897 : [PATCH] Fix build when gtk-doc is not installed
271 o 509539 : Building documentation aborts when no .types file is present
272 o 512154 : Struct member type attributes are limited to one token
273 o 513318 : gtk-doc.el doesn't work fine with emacs22
293 GTK-Doc 1.9 (Sep 30 2007)
298 o 419308 : unsynced regexps for parameter parsing
299 o 449618 : Top navigation bar is in the way
300 o 453717 : fixxref logic to determine absolute path's is flawed
301 o 457173 : unit tests for gtk-doc
302 o 465920 : Use gtkdoc-rebase
303 o 467773 : default master doc should have proper extension
304 o 141869 : Poor error generated when faced with a type declared as '...
305 o 156643 : Avoid make error in gtk-doc.make
306 o 322035 : wrong macro parsing
307 o 323938 : gtk-doc.m4 check is silent
308 o 324535 : gtk-doc doesn't handle deprecation inside enumerations
309 o 355352 : If you don't have an instantiatable type for a gtypeinter...
310 o 379466 : Improve C parser to handle TYPE\nVARIABLE in function pro...
311 o 380824 : docs are truncated if line begins with '* returns '
312 o 383456 : ' make check ' test for 100% documentation
313 o 411739 : Gtk-doc fails to handle ' struct tm * function_name (); '
314 o 415388 : Please clean -undocumented.txt files
315 o 418027 : gtkdoc-mkdb does not handle #ifdef in enum {}
316 o 419997 : parameter name trouble
317 o 428596 : Warnings with gtk-doc.m4 macros
318 o 434134 : fixxrefs like sed for installing pregenerated docs
319 o 436565 : Report undeclared symbols into a file
320 o 445596 : Impossible to link a page with an anchor
321 o 445693 : Does not understand ' unsigned long ' as a type
322 o 450338 : Make gtk-doc.m4 fail when needed gtk-doc is not installed
323 o 454916 : gtk-doc should permit generation of URI-based cross-refer...
324 o 457077 : add --no-implicit-returns to gtkdoc-mkdb
325 o 459225 : Accept automake-1.10 in autogen.sh
326 o 459725 : ' jhbuild build gtk-doc ' fails on make
327 o 460127 : parsing nested union/structs confuses public/private state
328 o 465365 : [PATCH] gtk-doc does not compile
329 o 466559 : [CSS] styling <hr />;
330 o 471014 : G_CONST_RETURN * G_CONST_RETURN * function not picked up
331 o 477532 : function variables
332 o 479913 : gtk-doc.notmpl.make is not distributed
333 o 479923 : distclean test output properly
349 GTK-Doc 1.8 (Feb 16 2007)
352 o Made it easier to include example code in the source code comment blocks.
353 "|[ ... ]|" can be used to delineate example code (it just gets converted
354 to "<informalexample><programlisting>"), and most of the text in example
355 code is left as it is. The only thing that is still expanded is
356 '#' to allow links to a symbol's documentation, e.g. '#GtkWidget'.
357 o Made the field widths wider for the HTML output, so it looks a bit nicer.
358 o Added a '--rebuild-sections' option to gtkdoc-scan to automatically rebuild
359 the MODULE-sections.txt file. This only works if all the header files are
360 organized neatly and functions don't need rearranging in the docs.
361 o Added a '--rebuild-types' option to gtkdoc-scan to automatically rebuild
362 the MODULE.types file, so you don't need to add new types manually.
363 o Leave CDATA sections as they are, in the extra XML content files and within
364 source code comment blocks.
365 o Allow the section id and #include's to be set within the "SECTION:" comment
366 block, using "@Section_ID:xxx" and "@Include:".
367 o Added "--default-includes" option to specify the default #include's (for
368 people who are using --rebuild-sections and so can't specify it in
369 MODULE-sections.txt).
370 o Added a '--query-child-properties' argument to help document child
371 properties of arbitrary GObjects (used by things like canvas widgets).
372 o Fixed documentation of signals of interfaces.
375 GTK-Doc 1.7 (Jul 29 2006)
378 o Fixed bug that resulted in empty "@:" lines in the templates.
379 o Fixed a few bugs with the XSL code.
380 o Supported a few more variations of C syntax.
381 o Remove the internally-used '-struct' suffix from links to widget structs.
382 o Fixed a few missing build dependencies.
383 o Added a new "C-x4s" binding to the emacs lisp code, to insert a blank
384 section header in the source code.
385 o Fixed bug that ignored inline section header docs with '-' in their names.
386 o Added a 'make docs' target that can be used to build the docs even when
387 gtk-doc has been disabled at configure time.
390 GTK-Doc 1.6 (Apr 9 2006)
393 o Removed the hard dependancy on openjade or jade, since XML is used mainly
394 now rather than SGML.
395 o Install the .pc file in $(datadir) rather than $(libdir) since gtk-doc is
396 architecture-independant.
397 o Added "--ignore-decorators" option to ignore a list of declarators in
398 function declarations.
399 o Support '#Object::signal'/'#Object:property' to link to signals/properties
400 o Fixed missing index terms.
403 GTK-Doc 1.5 (Mar 7 2006)
406 o Output the new version of devhelp2 information, but still generate the old
407 devhelp files so older versions of DevHelp still work OK.
408 o Fixed the initial creation of the *-sections.txt file so the object
409 hierarchy, signals and properties all work automatically.
410 o Show information about signal flags (run first/last).
411 o Support a --source-suffixes argument specifying which source files to scan.
412 o Support other root object types besides GObject and GInterface.
413 o Use a fixed navigation bar for the generated documentation.
414 o New documentation from Stefan Kost.
415 o Handle more variations of C syntax.
418 GTK-Doc 1.4 (Jul 3 2005)
421 o Support section documentation (title, short description, long description
422 and 'see also') within the source code. I think everything can now be
423 documented within the source code.
424 o Support Stable/Unstable/Private stability levels for everything.
427 GTK-Doc 1.3 (Jan 9 2005)
430 o Use the new style.css stylesheet instead of hard-wiring the styles.
431 o Updated the documentation and example build files.
432 o Added support for a gallery of widget images.
433 o Output default values for widget properties and allowed ranges.
434 o Only underline links in the docs when the mouse hovers over them.
435 o Added support for placing the parameter table anywhere within the function
436 documentation (using the "<!--PARAMETERS-->" marker).
437 o Handle more variations of C syntax.
440 GTK-Doc 1.2 (Feb 16 2004)
443 o Added widget signals and properties to undocumented output and statistics.
444 o Added support for an index of all symbols.
445 o Emit "Since:" information for signals and properties.
446 o Added derived subclasses and interfaces to the widget hierarchies.
447 o Added .cat SGML catalog file.
448 o Support properties on interfaces.
449 o Added "--help" options to the scripts.
452 GTK-Doc 1.1 (Apr 18 2003)
455 o Add a gtk-doc.m4 macro that allows packages to provide consistent
456 checking for gtk-doc.
457 o Check to make sure that the XML catalog actually contains entries
458 for the DocBook XML DTD and XSLT stylesheets. Please consult the
459 README file if your system's XML catalog isn't set up.
460 o Add infrastructure for including the standard gtk-doc makefile
461 glue, so that maintainers of packages don't need to worry about
462 keeping it up to date. See glib head for an example of its use.
463 o Some updates to the devhelp contents file generation, as suggested
465 o Fix some bugs in the DocBook XML codepath that were preventing
466 inter-module cross references from being resolved.
467 o Fix some bugs in extraction of object property documentation.
470 GTK-Doc 1.0 (Jan 20 2003)
473 o Added support for "Since:" and "Deprecated:" tags, and look for deprecated
474 guard macros in header files.
475 o Support /*< public >*/ and /*< private >*/ markers for all structs.
476 o New "--ignore-files" option for gtkdoc-mkdb, to ignore files or directories.
477 o Used the "sgml-raw" output type with openjade, to avoid problems with Lynx.
478 o Added .pc pkg-config file which can be used to check the gtk-doc version.
481 GTK-Doc 0.10 (Nov 14 2002)
484 o --output-format option to select whether SGML or XML is generated.
485 o Use openjade or jade when converting SGML to HTML.
486 o Use xsltproc to convert XML to HTML, with a new look.
487 o In XML mode, support XIncludes as an alternative to entities.
488 o In XML mode, create .devhelp files.
489 o List interfaces in the object hierarchy.
490 o Create docs for signals on interfaces.
491 o Generate links between interface and their implementations and
493 o Create docs for child and style properties.
494 o Use blurbs for property documentation.
495 o Allow inline documentation for signals and properties.