1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438
|
GTK-Doc 1.15 (May 21 2010)
============
Changes
o 614496 : Support for multiple DOC_SOURCE_DIR directories
o 615550 : gtk-doc fails to recognize (scope ...) and (skip) annotations
Contributors
Andreas Rottmann
Jorge González
Nicola Fontana
Nikos Bakaoukas
Stefan Kost
GTK-Doc 1.14 (Mar 28 2010)
============
Changes
o 593282 : Append " _struct " prefix to every struct name
o 599514 : sane support for per-page images
o 604892 : checks fail
o 613611 : parameter descriptions with annotations truncated at first \n
o 115531 : add short description to index entries
o 165425 : gtk-doc fails to parse unions
o 512155 : gets confused by multiline typedef
o 568711 : undocumented enum values are not reported
o 590602 : secondly running gtkdoc-mkdb will generate DOCTYPE missing XML files
o 590625 : $(DOC_MODULE)-overrides.txt is required by " make dist "
o 591975 : Section_Id always embeds a trailing newline
o 604885 : Fix the use of gtkdocize --flavour option
o 604992 : gtkdoc-fixxref broken link warning is broken for functions
o 604995 : Syntax error in gtkdoc-mkman
o 604998 : Check for syntax errors in the test suite
o 605052 : put class structs to the generated section file
o 605211 : Many build failures with gtk-doc 1.13
o 605281 : Add " Since " and " Deprecated " tag to function example
o 605285 : Add < keycap > and < keycombo > example
o 605289 : Some documentation improvements
o 605452 : Added more info to " Documenting symbols " sectio
o 605564 : Env var equivalent to --flavour=no-tmpl
o 606661 : XInclude error while gnerating documentation
o 607445 : gtk-doc does not support long double as returned value type
o 607531 : Execute system() calls in subshells to ease debugging
o 609062 : [All-langs] [gtk-doc] Translated *.po files not available within ~/po directory
o 609194 : sort interface implementers
o 610255 : Self-test failure in git as of 2010-02-17: FAIL: gobject.sh
o 610257 : Patch to make GTK-DOC notice functions/variables with 'signed' prototypes
o 611848 : gtk-doc produces invalid DocBook markup if the SECTION ends with a tag that cannot be nested inside < para >
Contributors
Bruno Brouard
David Nečas
Emilio Pozuelo Monfort
Francisco Javier F. Serrador
Javier Jardón
Jorge González
Loïc Minier
Mario Blättermann
Marios Zindilis
Nicola Fontana
Philip Chimento
Runa Bhattacharjee
Ryan Lortie
Simon Josefsson
Simon McVittie
Stefan Kost
Sweta Kothari
Vincent Untz
Felix Iyadurai
krishnababu k
GTK-Doc 1.13 (Dec 18 2009)
============
o 604891 : gtk-doc tarball does not build
Contributors
Stefan Kost
GTK-Doc 1.12 (Dec 18 2009)
============
Changes
o 591450 : Build related fixes
o 466535 : generate documentation as pdf
o 502191 : acronym support
o 532395 : inline function parsing problems (e.g. in glib api docs)
o 536928 : have syntax highlghted and xrefs source code samples
o 562064 : index generation trouble
o 562310 : glib 2.18.3: /bin/sh: line 1: gtkdoc-rebase: command not found
o 562655 : doesn't produce deprecation note for signals
o 565126 : linking to struct members
o 565835 : Three spelling errors in gtk-doc-manual
o 566911 : add support for --help and --version to remaining tools
o 567132 : Take FOO_GET_INTERFACE as standard
o 568702 : gtkdoc-mkhtml no longer works when symlinked
o 568706 : gtkdoc-scan: use CamelCase id for interfaces
o 568708 : gtkdoc-scan should try not to scan files twice
o 568714 : Perl errors when syntax highlighting is not available
o 568732 : missing long descriptions undetected
o 568734 : configure check for gtk-doc prints that gtk-doc cannot be built
o 569339 : abbreviation are not expanded at the start of text
o 572396 : Fix to use shave + gtk-doc + libtool 1.x
o 572612 : Mistakenly substitute -1 with G_MAXULONG in x86_64
o 572967 : use g_strerror
o 574654 : --ignore-decorators does not ignore trailing stuff
o 575574 : Be more friendly for files with a space in their name
o 575623 : Update FSF address
o 575711 : < table > element mismatch in highlighted code
o 576313 : implicit declarations in testsuite ?
o 577059 : Gnome-doc support can't be disabled
o 577774 : Test suite run even when built with --disable-gtk-doc
o 580206 : gcc warnings in < module > -scan.c
o 580300 : gtkdoc-scan picks up _get_type functions it should not
o 580622 : xml dir is both part of distclean and dist rules
o 581237 : gtk-doc uses wrong gtkdoc-check in " make check " phase
o 584952 : " uninitialized value in concatenation " gtkdoc-mkdb line 938
o 587103 : return values of function-like macros
o 587196 : Typo in a string
o 589426 : Python is a required dependency
o 591789 : master FTBFS with automake 1.11
o 594224 : Please fix manual about inlined SECTION comments (and show warnings when invalid)
o 596730 : Signed vs. unsigned comparison in gtkdoc-scangobj.in causing compile errors
o 596731 : autogen.sh doesn't recognize automake-1.11
o 602026 : Warn if non-existing function gets referenced
o 602518 : Doesn't support " long int " return type
o 604798 : tests/fail.sh and tests/tools.sh.in use bashisms
Contributors
Claude Paroz
Dan Williams
Daniel Mustieles
Daniel Nylander
H. Habighorst
Jannis Pohlmann
Javier Jardón
Jennie Petoumenou
Jorge González
Mario Blättermann
Nicola Fontana
Philip Chimento
Philip Withnall
Simos Xenitellis
Stefan Kost
Sven Herzberg
GTK-Doc 1.11 (Nov 16 2008)
============
Changes
o 531572 : one-page generation option
o 448879 : Use a footer when generating HTML documentation
o 311857 : xsltproc very slow generating index for gtk-docs.sgml
o 335239 : Using gnome-doc-utils for gtk-doc documentation
o 460753 : enable vpath build in gtkdoc-mkhtml
o 473342 : Warn about repeated symbols in sections
o 487727 : DocBook XML DTD version
o 523669 : make check: Element publisher content does not follow the...
o 530758 : gtk-doc should not expand XML tags and their attributes
o 533262 : no-template mode scans different source files
o 534627 : gtk-doc uses non-standard HTML element
o 542137 : No declaration found for: gsf_output_*
o 543855 : Fix for Bug 460753 (enable vpath build in gtkdoc-mkhtml) ...
o 544172 : Fails to parse return value of 'char const *'
o 552822 : Add rules to create $(REPORT_FILES)
o 553407 : Example Makefile.am uses obsolete INCLUDES instead of AM_...
o 554718 : gtk-doc needs to allow versioned TARGET_DIR
o 554833 : Be more careful with " struct _ < struct_name > "
o 558082 : evince docs build fails with GTK_DISABLE_SINGLE_INCLUDES
o 559281 : Correct check for existance of gtkdoc-rebase
Contributors
Behdad Esfahbod
Christian Persch
David Nečas
Felix Riemann
Jeffrey Stedfast
Marc-Andre Lureau
Matthew Barnes
Peter Kjellerstedt
Sebastian Dröge
Simon Josefsson
Stefan Kost
GTK-Doc 1.10 (Mar 20 2008)
============
Changes
o 460753 : enable vpath build in gtkdoc-mkhtml
o 503119 : Add dependency on content_files to SGML target
o 127049 : building reference documentation fails when builddir != s...
o 481811 : Inline function bodies are confused with declarations
o 448879 : Use a footer when generating HTML documentation
o 492005 : Deprecation guard warnings for properties and signals
o 498521 : Inconsistent compiler flags passed in gtk-doc.make
o 365913 : gtk-doc output is not predictable
o 446648 : gtk-doc does not handle forward typedef'd enums
o 468278 : Display proper types for properties
o 497367 : don't use US-ASCII for output encoding
o 501066 : Missing quotes around gtkdoc-rebase check cause a warning
o 508897 : [PATCH] Fix build when gtk-doc is not installed
o 509539 : Building documentation aborts when no .types file is present
o 512154 : Struct member type attributes are limited to one token
o 513318 : gtk-doc.el doesn't work fine with emacs22
Contributors
Benjamin Otte
Carlos Garnacho
Damon Chaplin
David Nečas
Frederic Peters
Joe Marcus Clarke
Kouhei Sutou
Loïc Minier
Mathias Hasselmann
Petteri Räty
Rouslan Solomakhin
Stefan Kost
Sven Herzberg
Yeti
GTK-Doc 1.9 (Sep 30 2007)
===========
Changes
o 419308 : unsynced regexps for parameter parsing
o 449618 : Top navigation bar is in the way
o 453717 : fixxref logic to determine absolute path's is flawed
o 457173 : unit tests for gtk-doc
o 465920 : Use gtkdoc-rebase
o 467773 : default master doc should have proper extension
o 141869 : Poor error generated when faced with a type declared as '...
o 156643 : Avoid make error in gtk-doc.make
o 322035 : wrong macro parsing
o 323938 : gtk-doc.m4 check is silent
o 324535 : gtk-doc doesn't handle deprecation inside enumerations
o 355352 : If you don't have an instantiatable type for a gtypeinter...
o 379466 : Improve C parser to handle TYPE\nVARIABLE in function pro...
o 380824 : docs are truncated if line begins with '* returns '
o 383456 : ' make check ' test for 100% documentation
o 411739 : Gtk-doc fails to handle ' struct tm * function_name (); '
o 415388 : Please clean -undocumented.txt files
o 418027 : gtkdoc-mkdb does not handle #ifdef in enum {}
o 419997 : parameter name trouble
o 428596 : Warnings with gtk-doc.m4 macros
o 434134 : fixxrefs like sed for installing pregenerated docs
o 436565 : Report undeclared symbols into a file
o 445596 : Impossible to link a page with an anchor
o 445693 : Does not understand ' unsigned long ' as a type
o 450338 : Make gtk-doc.m4 fail when needed gtk-doc is not installed
o 454916 : gtk-doc should permit generation of URI-based cross-refer...
o 457077 : add --no-implicit-returns to gtkdoc-mkdb
o 459225 : Accept automake-1.10 in autogen.sh
o 459725 : ' jhbuild build gtk-doc ' fails on make
o 460127 : parsing nested union/structs confuses public/private state
o 465365 : [PATCH] gtk-doc does not compile
o 466559 : [CSS] styling <hr />;
o 471014 : G_CONST_RETURN * G_CONST_RETURN * function not picked up
o 477532 : function variables
o 479913 : gtk-doc.notmpl.make is not distributed
o 479923 : distclean test output properly
Contributors
Benjamin Otte
Damon Chaplin
David Nečas
Frederic Peters
Loic Minier
Petteri Räty
Rouslan Solomakhin
Stefan Kost
Sven Herzberg
Yeti
GTK-Doc 1.8 (Feb 16 2007)
===========
o Made it easier to include example code in the source code comment blocks.
"|[ ... ]|" can be used to delineate example code (it just gets converted
to "<informalexample><programlisting>"), and most of the text in example
code is left as it is. The only thing that is still expanded is
'#' to allow links to a symbol's documentation, e.g. '#GtkWidget'.
o Made the field widths wider for the HTML output, so it looks a bit nicer.
o Added a '--rebuild-sections' option to gtkdoc-scan to automatically rebuild
the MODULE-sections.txt file. This only works if all the header files are
organized neatly and functions don't need rearranging in the docs.
o Added a '--rebuild-types' option to gtkdoc-scan to automatically rebuild
the MODULE.types file, so you don't need to add new types manually.
o Leave CDATA sections as they are, in the extra XML content files and within
source code comment blocks.
o Allow the section id and #include's to be set within the "SECTION:" comment
block, using "@Section_ID:xxx" and "@Include:".
o Added "--default-includes" option to specify the default #include's (for
people who are using --rebuild-sections and so can't specify it in
MODULE-sections.txt).
o Added a '--query-child-properties' argument to help document child
properties of arbitrary GObjects (used by things like canvas widgets).
o Fixed documentation of signals of interfaces.
GTK-Doc 1.7 (Jul 29 2006)
===========
o Fixed bug that resulted in empty "@:" lines in the templates.
o Fixed a few bugs with the XSL code.
o Supported a few more variations of C syntax.
o Remove the internally-used '-struct' suffix from links to widget structs.
o Fixed a few missing build dependencies.
o Added a new "C-x4s" binding to the emacs lisp code, to insert a blank
section header in the source code.
o Fixed bug that ignored inline section header docs with '-' in their names.
o Added a 'make docs' target that can be used to build the docs even when
gtk-doc has been disabled at configure time.
GTK-Doc 1.6 (Apr 9 2006)
===========
o Removed the hard dependancy on openjade or jade, since XML is used mainly
now rather than SGML.
o Install the .pc file in $(datadir) rather than $(libdir) since gtk-doc is
architecture-independant.
o Added "--ignore-decorators" option to ignore a list of declarators in
function declarations.
o Support '#Object::signal'/'#Object:property' to link to signals/properties
o Fixed missing index terms.
GTK-Doc 1.5 (Mar 7 2006)
===========
o Output the new version of devhelp2 information, but still generate the old
devhelp files so older versions of DevHelp still work OK.
o Fixed the initial creation of the *-sections.txt file so the object
hierarchy, signals and properties all work automatically.
o Show information about signal flags (run first/last).
o Support a --source-suffixes argument specifying which source files to scan.
o Support other root object types besides GObject and GInterface.
o Use a fixed navigation bar for the generated documentation.
o New documentation from Stefan Kost.
o Handle more variations of C syntax.
GTK-Doc 1.4 (Jul 3 2005)
===========
o Support section documentation (title, short description, long description
and 'see also') within the source code. I think everything can now be
documented within the source code.
o Support Stable/Unstable/Private stability levels for everything.
GTK-Doc 1.3 (Jan 9 2005)
===========
o Use the new style.css stylesheet instead of hard-wiring the styles.
o Updated the documentation and example build files.
o Added support for a gallery of widget images.
o Output default values for widget properties and allowed ranges.
o Only underline links in the docs when the mouse hovers over them.
o Added support for placing the parameter table anywhere within the function
documentation (using the "<!--PARAMETERS-->" marker).
o Handle more variations of C syntax.
GTK-Doc 1.2 (Feb 16 2004)
===========
o Added widget signals and properties to undocumented output and statistics.
o Added support for an index of all symbols.
o Emit "Since:" information for signals and properties.
o Added derived subclasses and interfaces to the widget hierarchies.
o Added .cat SGML catalog file.
o Support properties on interfaces.
o Added "--help" options to the scripts.
GTK-Doc 1.1 (Apr 18 2003)
===========
o Add a gtk-doc.m4 macro that allows packages to provide consistent
checking for gtk-doc.
o Check to make sure that the XML catalog actually contains entries
for the DocBook XML DTD and XSLT stylesheets. Please consult the
README file if your system's XML catalog isn't set up.
o Add infrastructure for including the standard gtk-doc makefile
glue, so that maintainers of packages don't need to worry about
keeping it up to date. See glib head for an example of its use.
o Some updates to the devhelp contents file generation, as suggested
by Hallski.
o Fix some bugs in the DocBook XML codepath that were preventing
inter-module cross references from being resolved.
o Fix some bugs in extraction of object property documentation.
GTK-Doc 1.0 (Jan 20 2003)
===========
o Added support for "Since:" and "Deprecated:" tags, and look for deprecated
guard macros in header files.
o Support /*< public >*/ and /*< private >*/ markers for all structs.
o New "--ignore-files" option for gtkdoc-mkdb, to ignore files or directories.
o Used the "sgml-raw" output type with openjade, to avoid problems with Lynx.
o Added .pc pkg-config file which can be used to check the gtk-doc version.
GTK-Doc 0.10 (Nov 14 2002)
============
o --output-format option to select whether SGML or XML is generated.
o Use openjade or jade when converting SGML to HTML.
o Use xsltproc to convert XML to HTML, with a new look.
o In XML mode, support XIncludes as an alternative to entities.
o In XML mode, create .devhelp files.
o List interfaces in the object hierarchy.
o Create docs for signals on interfaces.
o Generate links between interface and their implementations and
prerequisites.
o Create docs for child and style properties.
o Use blurbs for property documentation.
o Allow inline documentation for signals and properties.
|