GTK-Doc 1.17 (Feb 16 2011)
============
Changes
o 127049 : building reference documentation fails when builddir != srcdir
o 640241 : non-srcdir builds busted
Contributors
Daniel Mustieles
Javier Jardón
Stefan Kost
GTK-Doc 1.16 (Jan 14 2011)
============
o gtkdoc-check can do more checks, one might need to update Makefile.am from
the examples/Makefile.am
Changes
o 625776 : serialise doubles and floats always with a decimal dot
o 627269 : link to signalflags docs from signal descriptions
o 467488 : GTK+ man pages request
o 481811 : Inline function bodies are confused with declarations
o 501107 : EXTRA_DIST automake warnings
o 512565 : add GTK_DOC_IGNORE
o 518427 : documentation best pratices needed
o 597937 : Function pointers as parameters to other functions are parsed improperly
o 612028 : gtkdoc-fixxref should call /usr/bin/vim -n -e -u NONE -T xterm
o 617478 : Tooltip is a nuisance
o 618379 : Navigation is hiding anchors title
o 620249 : invalid xml for object_index with (n_objects % 3) == 0
o 621931 : support GType and GVariant types
o 622971 : List of typos in the GTK-doc manual
o 623777 : G_TYPE_STRV in signals generate wrong docs
o 623968 : gtkdoc-mkdb generates invalid xml from sgml in inline comments
o 624199 : parser picks up contents of large macros
o 624200 : 'const' confuses the parser
o 627223 : gtkdoc-fixxref vim highlight fails on xhtml suffix
o 627920 : `make check` rule to list xml files missing from DOC_MAIN_SGML_FILE
o 628611 : gtk-doc > = 1.13 creates automagic dependencies on syntax highlighters
o 628794 : Issue in gtkdoc-mkman.in
o 630288 : Fix 'scope notified' annotation
o 631336 : remove lists of gtk+ signal args in gtkdoc-scanobj and -scangobj
o 632587 : gtkdoc-scanner fails to identify (closure) annotation
o 638330 : const in parameter list is ignored
o 638831 : Support GTK+ 3 cell properties
Contributors
Bruno Brouard
Christian Persch
Claude Paroz
Gilles Dartiguelongue
Javier Jardón
Jorge González
Maarten Bosmans
Mario Blättermann
Matej Urbančič
Matthias Clasen
Pablo Castellano
P. F. Chimento
Philip Withnall
Rodrigo Aliste
Simón Pena
Stefan Kost
Tim-Philipp Müller
Vasilis Tsivikis
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
Shared directories can now be created independently by the pacakges
needing them and will be removed automatically by pkg_delete when empty.
Packages needing empty directories can use the @pkgdir command in PLIST.
Discussed and ok'd in thread starting at
http://mail-index.netbsd.org/tech-pkg/2009/06/30/msg003546.html
This changes the buildlink3.mk files to use an include guard for the
recursive include. The use of BUILDLINK_DEPTH, BUILDLINK_DEPENDS,
BUILDLINK_PACKAGES and BUILDLINK_ORDER is handled by a single new
variable BUILDLINK_TREE. Each buildlink3.mk file adds a pair of
enter/exit marker, which can be used to reconstruct the tree and
to determine first level includes. Avoiding := for large variables
(BUILDLINK_ORDER) speeds up parse time as += has linear complexity.
The include guard reduces system time by avoiding reading files over and
over again. For complex packages this reduces both %user and %sys time to
half of the former time.
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
pkgsrc change: make SGML output optional, off per default, which saves
the heavyweight dependency on jade
other changes:
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.
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.
(Yeah, I know I updated it to 1.6 earlier today... thanks to wiz@ for
pointing out the newest version.)
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.
and add a new helper target and script, "show-buildlink3", that outputs
a listing of the buildlink3.mk files included as well as the depth at
which they are included.
For example, "make show-buildlink3" in fonts/Xft2 displays:
zlib
fontconfig
iconv
zlib
freetype2
expat
freetype2
Xrender
renderproto
RECOMMENDED is removed. It becomes ABI_DEPENDS.
BUILDLINK_RECOMMENDED.foo becomes BUILDLINK_ABI_DEPENDS.foo.
BUILDLINK_DEPENDS.foo becomes BUILDLINK_API_DEPENDS.foo.
BUILDLINK_DEPENDS does not change.
IGNORE_RECOMMENDED (which defaulted to "no") becomes USE_ABI_DEPENDS
which defaults to "yes".
Added to obsolete.mk checking for IGNORE_RECOMMENDED.
I did not manually go through and fix any aesthetic tab/spacing issues.
I have tested the above patch on DragonFly building and packaging
subversion and pkglint and their many dependencies.
I have also tested USE_ABI_DEPENDS=no on my NetBSD workstation (where I
have used IGNORE_RECOMMENDED for a long time). I have been an active user
of IGNORE_RECOMMENDED since it was available.
As suggested, I removed the documentation sentences suggesting bumping for
"security" issues.
As discussed on tech-pkg.
I will commit to revbump, pkglint, pkg_install, createbuildlink separately.
Note that if you use wip, it will fail! I will commit to pkgsrc-wip
later (within day).
This is to add an explicit dependency on this utility so that gtk-doc does
not install unmanaged files when scrollkeeper is already installed.
Bump PKGREVISION to 2.
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.
developer is officially maintaining the package.
The rationale for changing this from "tech-pkg" to "pkgsrc-users" is
that it implies that any user can try to maintain the package (by
submitting patches to the mailing list). Since the folks most likely
to care about the package are the folks that want to use it or are
already using it, this would leverage the energy of users who aren't
developers.
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.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.
in the process. (More information on tech-pkg.)
Bump PKGREVISION and BUILDLINK_DEPENDS of all packages using libtool and
installing .la files.
Bump PKGREVISION (only) of all packages depending directly on the above
via a buildlink3 include.
2004-02-16 Damon Chaplin <damon@gnome.org>
* Released 1.2.
2004-02-16 Damon Chaplin <damon@gnome.org>
* gtk-doc.cat.in: removed public ID for gtk-doc.dtd, since we don't
use it any more.
Sat Feb 14 02:14:27 2004 Matthias Clasen <maclas@gmx.de>
* gtk-doc.m4: Avoid unnecessary checks if gtk-doc is
disabled. (#134221, Julio M. Merino Vidal)
Sat Feb 14 02:03:01 2004 Matthias Clasen <maclas@gmx.de>
* gtk-doc.make: Don't create unneeded empty
directories. (#134319, Julio M. Merino Vidal)
Sat Feb 14 01:37:38 2004 Matthias Clasen <maclas@gmx.de>
* gtk-doc.make: Add an empty all-local target to make it work
with non-GNU make. (#134343, Julio M. Merino Vidal)
Wed Jan 28 00:52:00 2004 Matthias Clasen <maclas@gmx.de>
* gtkdoc-mkdb.in (OutputObjectList): Avoid emitting invalid
docbook markup if there are no objects. Partial fix for #132661.
Sun Jan 25 22:01:15 2004 Matthias Clasen <maclas@gmx.de>
* gtkdoc-mkdb.in: Accept both the old and the new XInclude
namespace. (#131675, Edd Dumbill)
2004-01-23 Thomas Vander Stichele <thomas at apestaart dot org>
* gtkdoc-mkhtml.in: exit when tools return non-zero so errors can
be caught.
Thu Jan 15 23:06:10 2004 Matthias Clasen <maclas@gmx.de>
* gtk-doc.xsl: Set the chunk.fast parameter, to gain some
speed.
Thu Jan 15 23:05:23 2004 Matthias Clasen <maclas@gmx.de>
* gtkdoc-fixxref.in: Make it work again without explicit
--module.
Sat Dec 27 01:36:08 2003 Matthias Clasen <maclas@gmx.de>
* gtkdoc-scangobj.in:
* gtkdoc-mktmpl.in:
* gtkdoc-scan.in:
* gtkdoc-fixxref.in: Add --help. (#126915)
Sat Dec 27 00:43:42 2003 Matthias Clasen <maclas@gmx.de>
* gtkdoc-mkdb.in (ParseEnumDeclaration):
* gtkdoc-mktmpl.in (ParseEnumDeclaration): Support a trailing ,
in enum declarations. These are a GNU C extension, but also
blessed by C99. (#129949, Thomas Vander Stichele)
Sun Nov 16 00:29:03 2003 Matthias Clasen <maclas@gmx.de>
* gtkdoc-scangobj.in: Don't use g_strdown(). (#127028,
David Schleef)
Sun Nov 16 00:26:05 2003 Matthias Clasen <maclas@gmx.de>
* gtkdoc-scangobj.in: If compiled against GLib >= 2.3.0, look
for properties on interfaces. (#127068, James M. Cape)
2003-11-03 Dan Winship <danw@ximian.com>
* gtkdoc-scangobj.in: Clean up $MODULE-scan.o even when using
libtool
* gtkdoc-scanobj.in: Likewise
* gtk-doc.make (CLEANFILES): Remove $(MODULE)-scan.o from here
(clean-local): rm -rf .libs
Wed Oct 8 01:21:54 2003 Matthias Clasen <maclas@gmx.de>
* gtkdoc-scan.in (ScanHeader): Make gtkdoc-scan grok
typedef struct { } foo; in addition to the more baroque
typedef struct _foo foo; struct _foo { };
(#116807, Malcolm Tredinnick)
Wed Oct 8 01:21:35 2003 Matthias Clasen <maclas@gmx.de>
* gtkdoc-mkdb.in (OutputParamDescriptions): Remove a pointless
warning.
2003-10-01 Matthias Clasen <maclas@gmx.de>
Make signals and properties end up in the right template
file (#116569, Owen Taylor):
* gtkdoc-mktmpl.in (OutputSignalTemplates):
(OutputArgTemplates): Return a string rather than directly
writing to OUTPUT.
(OutputTemplateFile): Don't interpret $title as the name of
the object to print signal and property templates for.
(UpdateTemplates): Collect signal and property templates for all
objects contained in the section.
2003-08-10 James Henstridge <james@daa.com.au>
* acinclude.m4 (JH_PATH_XML_CATALOG): allow caller to specify
actions if found or not found.
(JH_CHECK_XML_CATALOG): when requiring JH_PATH_XML_CATALOG, don't
error out if it is not found.
2003-08-03 Matthias Clasen <maclas@gmx.de>
* doc/gnome.txt: Add some hints regarding markup of examples.
2003-07-22 Matthias Clasen <maclas@gmx.de>
* configure.in:
* gtk-doc.cat: Fix a problem with the previous commit.
2003-07-21 Matthias Clasen <maclas@gmx.de>
Applied patches from Sebastian Rittau to add maintainer mode and an
SGML catalog. (#117955, #117956)
* gtk-doc.cat.in: New catalog file.
* configure.in: Added gtk-doc.catalog to output files.
* Makefile.am: Install gtk-doc.catalog.
* configure.in: Added AM_MAINTAINER_MODE.
* autogen.sh: Added --enable-maintainer-mode to configure options.
2003-07-09 Matthias Clasen <maclas@gmx.de>
* gtkdoc-mktmpl.in (ParseStructDeclaration):
* gtkdoc-mkdb.in (ParseStructDeclaration): Accept volatile struct
members, which have just made their appearance in glib.
2003-06-29 Matthias Clasen <maclas@gmx.de>
* gtkdoc-mkdb.in (ExpandAbbreviations): When expanding @param, catch
the common @param->field and @param.field, to reduce the need for
littering the C sources with <literal>foo->bar</literal>.
2003-06-25 Matthias Clasen <maclas@gmx.de>
Changes for #115528:
* gtkdoc-mkdb.in (OutputSGML): Collect hierarchy, interfaces,
implementations, prerequisites and derived interfaces separately.
(OutputSGMLFile): Take two more arguments: implementations and derived
interfaces.
(GetHierarchy): Also put immediate children in the local tree.
(GetInterfaces): Split into GetInterfaces and GetImplementations.
(GetImplementations): New function to get the implementations of an
interface.
(GetDerived): New function to get the known derived interfaces of an
interface.
* gtkdoc-mkdb.in (MakeXRef): Accept a second, optional parameter for the
text of the link.
(ExpandAbbreviations): Add semantic markup inside the links, so that
non-crossreferenced symbols come out properly formatted after link
removal. (#61345)
2003-06-15 Matthias Clasen <maclas@gmx.de>
Support for a flat index of all symbols. (#92861)
To use, put an empty <index/> element in your driver document.
* gtkdoc-mkdb.in (MakeIndexterms): New function, emits an indexterm.
(OutputMacro, OutputTypedef, OutputStruct, OutputEnum,
OutputUnion, OutputVariable, OutputFunction): Use MakeIndexterms.
to emit indexterms for symbols.
* gtkdoc-mkdb.in (GetSignals):
(GetArgs): Emit Since: information for signals and properties.
Thu Jun 12 15:55:57 2003 Owen Taylor <otaylor@redhat.com>
* gtkdoc-mkhtml.in (declaration): Replace head -1 with -n 1.
(Merge change by Elliot Lee from Red Hat package)
2003-06-11 Matthias Clasen <maclas@gmx.de>
* doc/gnome.txt: Updates to the documentation of inline comments.
2003-06-03 Matthias Clasen <maclas@gmx.de>
* gtk-doc.spec.in: Add a missing Provides: and include the .pc file.
(#106568, Joe Pranevich)
2003-05-27 Matthias Clasen <maclas@gmx.de>
* gtkdoc-mkdb.in (GetSignals):
(GetArgs): Add signals and properties to the statistics.
(OutputMissingDocumentation): Emit undocumented signals and
properties. (#113645)
2003-04-21 Matthias Clasen <maclas@gmx.de>
* tools/docpercentages.pl: Fix autolinkification for undocumented
symbols.
* doc/style-guide.txt: Typo fix.
