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.
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.
2003-04-18 James Henstridge <james@daa.com.au>
* NEWS: add news items.
* configure.in: increment version number.
2003-03-14 Matthias Clasen <maclas@gmx.de>
* gtkdoc-mkdb.in (OutputBook): Fix the public identifier for
DocBook V3.0: Davenport, not DavenPort.
(#108343, Mariano Suarez-Alvarez)
2003-03-10 James Henstridge <james@daa.com.au>
* configure.in: associate the chmod commands with the files they
are chmod'ing. This way config.status will always run the correct
chmod command.
2003-03-04 James Henstridge <james@daa.com.au>
* configure.in: look up the docbook DTD by public id rather than
system id.
2003-02-26 Matthias Clasen <maclas@gmx.de>
* gtkdoc-mkdb.in (GetArgs): Prefer template or comment docs over
blurbs only if they're nonempty, otherwise the empty docs from the
templates override all the blurbs.
2003-02-26 James Henstridge <james@daa.com.au>
* autogen.sh (THEDIR): set up so that it will choose automake 1.7
or 1.6 in preference to 1.4. Passes distcheck okay.
* configure.in: update configure.in script to match
recommendations of newer autoconf's, and add an AC_PREREQ()
statement, since the xml catalog checks are using new autoconf
features.
* gtk-doc.make (xml-build.stamp): since other bits of the makefile
were assuming xml, may as well hard code --output-format=xml.
2003-02-19 James Henstridge <james@daa.com.au>
* Makefile.am: get rid of the dist-hook, and just include the
given files in EXTRA_DIST instead.
* configure.in: provide meaningful names for the commands.
* acinclude.m4 (JH_CHECK_XML_CATALOG): add some extra arguments: a
friendly name for the catalog entry, and actions to run if the
entry was found or not. Also include a bit more information in
the config.log file if an error occurs.
2003-02-18 Matthias Clasen <maclas@gmx.de>
* gtkdoc-mkhtml.in (declaration): Avoid the unportable grep
option -q. (#105311)
2003-02-19 James Henstridge <james@daa.com.au>
* devhelp.xsl: put chapters that aren't at the top level into the
toc tree (to make gtk's .devhelp tree look better).
* gtk-doc.spec.in (Requires): make the requires lines match
current requirements ...
* gtkdoc-mkhtml.in (XSLTPROC): pass --nonet to xsltproc, so we
don't try to download DTDs and XSLT over the net. The configure
checks should catch people who don't have the correct files in
their catalog.
2003-02-17 James Henstridge <james@daa.com.au>
* gtkdocize.in (--version): add --version argument.
2003-02-14 James Henstridge <james@daa.com.au>
* gtkdoc-mkdb.in (GetOptions): actually accept --tmpl-dir as a
command line option. Based on a patch from Simon Josefsson
<jas@extundo.com>.
* gtk-doc.xsl: remove the xmlns declaration. Not really needed
for html output anyway ...
2003-02-13 James Henstridge <james@daa.com.au>
* devhelp.xsl: remove refsect1's and refsect2's from book tree, as
suggested by Hallski.
* gtk-doc.make (install-data-local): the change to install images
was superfluous, so I have removed it.
(CLEANFILES): move some more stuff to CLEANFILES from the
distclean-local rule.
2003-02-12 James Henstridge <james@daa.com.au>
* gtk-doc.make: add some chmod calls to work arround distcheck on
automake >= 1.6.
(install-data-local): copy the images as well as the html files
during install.
(uninstall-local): add an uninstall rule to remove the docs.
(CLEANFILES): add $(DOC_MODULE)-scan.o to the list of files to be
cleaned up.
2003-02-09 James Henstridge <james@daa.com.au>
* gtkdocize.in: script used to copy gtk-doc.make into another
module.
* gtk-doc.make: automake makefile fragment to handle gtk-doc
support in other modules.
* configure.in: check to make sure DocBook XML DTD and XSLT
stylesheets are present in the XML catalog.
* acinclude.m4 (JH_CHECK_XML_CATALOG): new macro to check for
entries in the XML catalog.
2003-02-04 James Henstridge <james@daa.com.au>
* gtk-doc.m4: a macro to check for gtk-doc.
* Makefile.am (gtkdocdata_DATA): don't bother installing xml.dcl.
It isn't used anymore (since switching xml mode to xsltproc).
* gtkdoc-mkhtml.in (gtkdocdir): and here.
* Makefile.am (gtkdocdatadir): change dir.
* configure.in: put data files in $(datadir)/gtk-doc/data, so that
they don't all get mixed up with the html docs installed by other
packages.
* examples/Makefile.am: added SCANOBJ_OPTIONS in case the module needs
to pass options to gtkdoc-scanobj or gtkdoc-scangobj.
* tools/gtk-doc.el: added Zucchi's emacs lisp for automatically adding
skeleton comment blocks above functions. Very handy!
* gtkdoc-scangobj.in: we now default to calling g_type_init() to
initialize the type system, rather than gtk_init(). This means you
don't need an X connection to build the docs any more. Hurrah!
Also added a '--type-init-func' argument so you can change the
function to be called. GTK+ uses --type-init-func="gtk_type_init(0)".
* gtkdoc-scan.in (ScanHeader): removed 'Found object' debug message.
The GTK+ Reference Documentation Project (RDP) aims to provide a
complete set of reference material for the GLib, GDK, and GTK+
libraries.
It is created using the gtk-doc system, which parses C header files
and creates 'template' files which are then filled in by the authors.
These template files are then converted into DocBook SGML, and from
there to HTML or printed output.
