1 2005-08-15 Stefan Kost <ensonic@users.sf.net>
8 adding the infrastructure for installation of gtkdoc manual
10 2005-08-12 Stefan Kost <ensonic@users.sf.net>
13 fix warning about uninitialized var EXPAND_CONTENT_FILES
15 Tue Aug 9 12:01:27 2005 tjlocal <timj@imendio.com>
17 * autogen.sh: bail out with exit $? for failing programs.
19 2005-07-26 Damon Chaplin <damon@gnome.org>
21 * gtk-doc.make: Pass DOC_MAIN_SGML_FILE as the main filename to
22 gtkdoc-mkdb. Avoids creating spurious foo.sgml files in an XML build.
23 Patch from Malcolm Tredinnick. (#311344)
25 Prefix build messages with "gtk-doc: " rather than surrounding them
26 with "***" which looks like an error. (#170008)
28 2005-07-26 Damon Chaplin <damon@gnome.org>
30 * README: removed comment about not being able to add section
31 documentation to source code files, which is not true any more.
33 2005-07-03 Damon Chaplin <damon@gnome.org>
37 2005-06-20 Matthias Clasen <mclasen@redhat.com>
39 * gtkdoc-mkdb.in: Fix typos in warnings.
41 2005-06-17 Mikael Hallendal <micke@imendio.com>
43 * README: Updated Devhelp web address.
45 2005-05-16 Matthias Clasen <mclasen@redhat.com>
47 * gtkdoc-mkdb.in: Add "expand-content-files:s" to the GetOptions() call.
49 2005-05-10 Owen Taylor <otaylor@redhat.com>
51 * gtkdoc-mkdb.in: Add an --expand-content-files option
52 to specify extra files to expand abbreviations in and
53 copy into the output directory.
55 * gtk-doc.make examples/Makefile.am: Add expand_content_files
58 * gtkdoc-mktmpl.in (OutputTemplateFile): Add an
59 --only-section-tmpl flag so that projects that keep everything
60 but section descriptions inline can avoid cvs conflicts.
62 * gtk-doc.make examples/Makefile.am: Add support for
65 * configure.in: Up version to 1.4.
67 2005-05-02 Matthias Clasen <mclasen@redhat.com>
69 * gtkdoc-mkdb.in: Accept C comments between struct name
70 and struct definition. GObject has an instance of this.
72 2005-03-21 Matthias Clasen <mclasen@redhat.com>
74 * gtk-doc.dcl: Allow ':' in names. (#169087)
76 2005-03-21 James Henstridge <james@jamesh.id.au>
78 * gtk-doc.xsl (encoding): output US-ASCII instead of ISO-8859-1.
79 This ensures that the output will be display correctly when served
80 as either ISO-8859-1 or UTF-8.
82 2005-02-26 Sven Neumann <sven@gimp.org>
84 * gtkdoc-mkdb.in (MakeIndexterms): allow space in Since: keywords,
85 only strip leading and trailing whitespace (bug #168384).
87 2005-02-16 Damon Chaplin <damon@gnome.org>
89 * gtkdoc-mkdb.in (ScanSourceFile): add support for "@stability:"
90 in the inline section docs (Brian Cameron).
92 2005-02-07 Damon Chaplin <damon@gnome.org>
94 * gtkdoc-mkdb.in (MergeSourceDocumentation): allow use of "@...:" in
95 the source code as well as "@Varargs:". Patch from Benjamin Otte.
98 2005-02-04 Damon Chaplin <damon@gnome.org>
100 * gtkdoc-mkdb.in (ParseStabilityLevel): don't reset $stability if it
101 isn't Stable/Unstable/Private (Brian Cameron).
102 (ScanSourceFile): skip whitespace after "SECTION:".
104 2005-02-01 Damon Chaplin <damon@gnome.org>
106 * gtkdoc-mkdb.in (ScanSourceFile, MergeSourceDocumentation): patch
107 from Stefan Kost to support section documentation within the source
108 code (long description, short description, see also and title).
111 * gtkdoc-mktmpl.in: patch from Brian Cameron to support stability
114 * gtkdoc-mkdb.in (OutputFunction):
115 * gtkdoc-mktmpl.in (OutputDeclaration):
116 * gtkdoc-common.pl.in (ParseStructDeclaration): patch from Roger Leigh
117 to add support for the "restrict" keyword.
119 * gtkdoc-scan.in (ScanHeader): patch from Roger Leigh to add support
120 for "unsigned" to one of the regexps.
122 2005-01-31 Damon Chaplin <damon@gnome.org>
124 * gtk-doc.make (scan-build.stamp): added "2>&1" to grep command to
127 * gtkdoc-mkdb.in: patch from Stefan Kost to not add '<' '>' around
128 include files that already have '"' '"' around them, and to try to
129 gather more information about undocumented symbols. #164462.
131 2005-01-28 Damon Chaplin <damon@gnome.org>
133 * gtk-doc.make: use dist-hook rather than EXTRA_DIST to copy the
134 $(DOC_MODULE).types file over, so we can skip this if it doesn't exist.
137 2005-01-12 Damon Chaplin <damon@gnome.org>
139 * README: patch from Stefan Kost to mention GObject classes
140 and describe the transformation process to XML/SGML and HTML,
141 and to mention Devhelp.
143 2005-01-09 Damon Chaplin <damon@gnome.org>
147 2005-01-09 Damon Chaplin <damon@gnome.org>
149 * gtkdoc-mkdb.in (MergeSourceDocumentation): output better warnings
150 using the type information. Patch from Stefan Kost. #161979
152 * gtkdoc-scan.in (ScanHeader): support "typedef struct a *b;". Fixes
153 last part of #156318.
155 * gtkdoc-common.pl.in (ParseStructDeclaration): return an empty array
156 for forward struct declarations. Part of #156318.
159 * gtkdoc-mkdb.in: updated a few of the warnings to make them a bit
160 easier to understand.
162 2004-11-22 James Henstridge <james@jamesh.id.au>
164 * acconfig.h: remove file, since we don't have a config.h
166 * configure.in: make sure $ACLOCAL_FLAGS is passed to aclocal on a
169 * autogen.sh: use Automake-1.9 if available, and call aclocal,
170 autoconf, automake, etc in the same order as autoreconf does.
172 * gtkdocize.in: if the AC_CONFIG_MACRO_DIR option is used in the
173 configure script, copy gtk-doc.m4 to that directory in the source
176 2004-11-16 Damon Chaplin <damon@gnome.org>
178 * gtkdoc-mkdb.in (OutputFunction): output "const" rather than
179 "G_CONST_RETURN". #157674.
181 * gtkdoc-mktmpl.in (OutputDeclaration): skip "void" return types but
182 not if it has modifiers e.g. "void *". #156963.
184 * gtkdoc-scan.in (ScanHeader): handle __attribute__. Patch from
185 Simon Josefsson. #156962.
187 2004-10-31 Damon Chaplin <damon@gnome.org>
189 * gtkdoc-mkdb.in (OutputStruct): handle opaque/forward struct
190 declarations. #156318 again. Tiny fix to avoid warnings.
192 2004-10-28 Damon Chaplin <damon@gnome.org>
194 * gtkdoc-mktmpl.in (ReadDeclarationsFile):
195 * gtkdoc-mkdb.in (ReadDeclarationsFile):
196 * gtkdoc-scan.in (ScanHeader): handle opaque/forward struct
197 declarations. #156318.
199 2004-10-25 Damon Chaplin <damon@gnome.org>
201 * gtkdoc-mkdb.in (OutputParamDescriptions): use a after Returns:
202 so it doesn't break before the colon.
204 2004-10-24 Damon Chaplin <damon@gnome.org>
206 * gtkdoc-common.pl (ParseEnumDeclaration): handle "typedef enum XXX {"
207 #156297. Patch from Simon Josefsson.
209 2004-10-20 Damon Chaplin <damon@gnome.org>
211 * gtkdoc-mkdb.in (ReadDeclarationsFile): set a flag to indicate a
212 struct has a typedef declaration.
213 (OutputStruct): better output for structs with typedefs. #83269.
215 * gtkdoc-scan.in (ScanHeader): leave the struct declaration as it is.
216 Don't strip out 'typedef'. Also allow simple "struct foo {".
218 2004-10-19 Damon Chaplin <damon@gnome.org>
220 * gtkdoc-fixxref.in: use pkg-config to find where GLib is installed
221 and scan that directory for index files. Also scan $GNOME2_PATH.
222 These are only used as a last resort. If they are used we have to
223 output links as absolute URLs, rather than the default relative ones.
225 2004-10-18 Damon Chaplin <damon@gnome.org>
227 * gtkdoc-common.pl.in (ParseStructDeclaration): support function
228 pointers that return "foo const *" #141870.
230 * gtkdoc-scan.in (ScanHeader):
231 * gtkdoc-mkdb.in (OutputFunction):
232 * gtkdoc-mktmpl.in (OutputDeclaration): handle functions with const
233 or struct return types. #141870 and #148507.
235 2004-10-15 Damon Chaplin <damon@gnome.org>
237 * gtkdoc-common.pl.in (ParseStructDeclaration)
238 (ParseEnumDeclaration): moved these here, rather than have 2 copies
239 in gtkdoc-mkdb.in and gtkdoc-mktmpl.in.
241 * gtkdoc-common.pl.in (ParseStructDeclaration): handle struct fields
242 better. We can now handle things like *foo, ***bar, *baz[12][23],
243 foo : 25 all on one line. Fixes part of #151219.
244 Also support the 'short' modifier to fix #90565.
245 And use $nbsp; rather than spaces to try to avoid splitting
246 declarations in the output.
247 Also take an extra arg specifying whether to include parameters in
248 the function pointer fields.
250 * gtkdoc-scan.in (ScanHeader): Deal with array types in typedefs.
251 (Eg, "typedef unsigned char MD5Digest[16];") From Dan Winship.
254 2004-10-14 Damon Chaplin <damon@gnome.org>
256 * gtkdoc-mkdb.in (CreateValidSGMLID): use ":CAPS" rather than
257 "-CAPS" to distinguish all-caps identifiers, to avoid clashing with
258 identifiers ending in _caps! Bug #113120.
260 * gtkdoc-mkdb.in (MergeSourceDocumentation): if it looks like a
261 parameter has been described, but not in the right place, output
262 a better error message. Bug #141871.
264 * gtkdoc-mkdb.in (OutputMacro, OutputFunction, GetSignals): allow
265 the author to use <!--PARAMETERS--> to specify the position of the
266 parameter table if they want. Hopefully good enough for bug #99567.
267 (MergeSourceDocumentation): end the paragraph before <!--PARAMETERS-->
268 and start a new one after it.
270 * doc/authors.txt: document <!--PARAMETERS-->.
272 * style.css: don't underline links normally, as we output lots of
273 them and it makes it very cluttered. Only underline links when the
274 mouse hovers over them, and change the color. Fixes #108037.
276 * gtk-doc.make (scan-build.stamp): depend on $(CFILE_GLOB) as well,
277 since changes in properties need to be picked up by gtkdoc-scangobj.
280 * gtkdoc-mkdb.in: (ParseStructDeclaration): for fields that are
281 function pointers, only return the function name, as otherwise the
282 output gets really messy. Fixes #66618.
288 * gtkdoc-scangobj.in: use '@PACKAGE_DATA_DIR@' instead of
289 "@PACKAGE_DATA_DIR@" so that it isn't interpolated. It failed when
290 $prefix was /software/@sys/usr. Fixes #113456.
292 2004-10-13 Damon Chaplin <damon@gnome.org>
295 * gtkdoc-scangobj.in: patch from Olexiy Avramchenko to add 3 new
299 * gtkdoc-scangobj.in: patch from Benjamin Otte to get rid of
300 -Wsign-compare warnings. Bug #137013.
302 Fri Sep 17 01:13:24 2004 Matthias Clasen <maclas@gmx.de>
304 * gtk-doc.xsl: Add the images from the gallery on top
305 of the refentry they point to.
307 * style.css: Move the css bits of the gallery implementation
310 Fri Sep 17 00:30:16 2004 Matthias Clasen <maclas@gmx.de>
312 * gtk-doc.xsl: Don't generate <link rel="refentry">
313 links, since e.g. the GTK+ docs contain MANY refentries.
315 2004-09-10 Damon Chaplin <damon@gnome.org>
317 * autogen.sh: support automake 1.8. (part of #151219).
319 * examples/Makefile.am: require automake 1.6.
321 * gtkdoc-scan.in: create an empty MODULE-overrides.txt file if it
322 doesn't exist. gtkdoc.make expects one to exist.
324 * doc/setting-up.txt: updated to document new procedure using
327 * examples/Makefile.am: updated to use gtkdoc.make.
329 * examples/configure.in: removed this. gtkdoc.make is used instead
332 * examples/README: updated.
334 * Makefile.am (EXTRA_DIST): removed examples/configure.in.
336 Wed Sep 8 01:12:25 2004 Matthias Clasen <maclas@gmx.de>
338 * gtkdoc-scan.in (ScanHeader):
339 * gtkdoc-mktmpl.in (OutputDeclaration):
340 * gtkdoc-mkdb.in (OutputFunction): Accept mixtures of *
341 and const in return types.
343 Wed Sep 01 05:58:08 2004 Matthias Clasen <maclas@gmx.de>
345 * gtkdoc-mkdb.in: Remove a debug printf
347 Tue Aug 24 02:30:08 2004 Matthias Clasen <maclas@gmx.de>
349 * gtk-doc.xsl: Add support for a gallery of widget images.
351 Wed Jul 28 13:00:54 2004 Jonathan Blandford <jrb@gnome.org>
353 * gtk-doc.xsl: remove the examples from the toc.
355 2004-07-28 Damon Chaplin <damon@gnome.org>
357 * doc/sections-file.txt: mention use of '#' for comments.
359 * gtkdoc-mkdb.in: removed HEADER_FILE stuff, since it isn't used now.
361 2004-07-23 Damon Chaplin <damon@gnome.org>
363 * examples/Makefile.am (all-local): add empty all-local target for
364 when ENABLE_GTK_DOC is false. (#148209, Martin Quinson)
366 Fri Jul 23 13:21:34 2004 Matthias Clasen <maclas@gmx.de>
368 * gtkdoc-mkdb.in (ScanSourceFile): Fix regexps for matching
369 ignored files. (#148211, Martin Quinson)
371 2004-07-03 Matthias Clasen <mclasen@redhat.com>
373 * style.css: Add a missing '}' and align arguments to the
374 top of their descriptions. (#145363, #145364, Mariano
377 2004-05-18 Matthias Clasen <mclasen@redhat.com>
379 * gtk-doc.xsl: Let the docbook stylesheets generate
380 extra <link rel=...> elements. (#140221, Geert Stappers)
382 2004-05-10 Geert Stappers <stappers@stappers.nl>
384 * TODO: new file, basicly a reference to bugzilla.
386 * examples/README: tell about gtk-doc.make.
388 2004-05-06 Geert Stappers <stappers@stappers.nl>
390 * MAINTAINERS: Add myself.
392 2004-05-05 Matthias Clasen <mclasen@redhat.com>
394 * gtk-doc.xsl: Correct the docbook stylesheet version
395 in which filtered index support will appear to 1.66.
397 2004-04-27 Geert Stappers <stappers@stappers.nl>
399 * README: Updated the information on Debian packages.
400 Removed old author and time stamp line.
402 2004-04-21 Matthias Clasen <mclasen@redhat.com>
404 * doc/sections-file.txt: Add hint about private types.
408 * MAINTAINERS: Add myself.
410 * gtkdoc-mkdb.in (ReadKnownSymbols): New function which
411 extracts information about public and private symbols from
412 the $MODULE-sections.txt file.
413 (ReadObjectHierarchy): Prune the tree, based on the information
414 collected by ReadKnownSymbols.
415 (ReadInterfaces): Also filter out private interfaces here
416 (ReadPrerequisites): ...and here.
418 2004-04-19 Matthias Clasen <mclasen@redhat.com>
420 * Makefile.am: Add version-greater-or-equal.xsl.
422 * version-greater-or-equal.xsl: New file, implementing
423 the version-greater-or-equal template for comparing version
426 * gtk-doc.xsl: Import version-greater-or-equal.xsl and
427 use the version-greater-or-equal template to a) check that
428 the xsl stylesheets are not too old and b) to avoid creating
429 multiple indices if the xsl stylesheets don't support filtered
432 * gtkdoc-mkdb.in (MakeIndexterms): Emit role attributes
433 on indexterms which can be used to create filtered indices
434 with sufficiently new xsl stylesheets. The required functionality
435 will appear in version 1.62 of the xsl stylesheets. (#115530)
437 2004-04-16 Matthias Clasen <mclasen@redhat.com>
439 * style.css: Style information in a separate stylesheet.
441 * gtkdoc-mkhtml.in: Copy css files.
443 * Makefile.am (gtkdocdata_DATA): Add style.css
445 * gtk-doc.xsl: Use a stylesheet instead of hardwiring
446 styles. (#134683, Vincent Torri)
448 * gtkdoc-mkdb.in (GetSignals): Organize the properties
449 descriptions to fit better with the other sections, and
450 also display information about allowed and default values.
452 2004-04-15 Matthias Clasen <mclasen@redhat.com>
454 * gtkdoc-scangobj.in: Use introspection more fully to emit
455 allowed ranges for integral types and default values.
457 * gtkdoc-mkdb.in (GetSignals): Handle missing signal parameter
460 2004-03-04 Damon Chaplin <damon@gnome.org>
462 * autogen.sh: fixed URLs to download autoconf/automake/libtool.
463 Patch from Frederic L. W. Meunier.
465 2004-02-16 Damon Chaplin <damon@gnome.org>
467 * .cvsignore: added gtk-doc.cat and gtkdocize.
469 2004-02-16 Damon Chaplin <damon@gnome.org>
473 2004-02-16 Damon Chaplin <damon@gnome.org>
475 * gtk-doc.cat.in: removed public ID for gtk-doc.dtd, since we don't
478 Sat Feb 14 02:14:27 2004 Matthias Clasen <maclas@gmx.de>
480 * gtk-doc.m4: Avoid unnecessary checks if gtk-doc is
481 disabled. (#134221, Julio M. Merino Vidal)
483 Sat Feb 14 02:03:01 2004 Matthias Clasen <maclas@gmx.de>
485 * gtk-doc.make: Don't create unneeded empty
486 directories. (#134319, Julio M. Merino Vidal)
488 Sat Feb 14 01:37:38 2004 Matthias Clasen <maclas@gmx.de>
490 * gtk-doc.make: Add an empty all-local target to make it work
491 with non-GNU make. (#134343, Julio M. Merino Vidal)
493 Wed Jan 28 00:52:00 2004 Matthias Clasen <maclas@gmx.de>
495 * gtkdoc-mkdb.in (OutputObjectList): Avoid emitting invalid
496 docbook markup if there are no objects. Partial fix for #132661.
498 Sun Jan 25 22:01:15 2004 Matthias Clasen <maclas@gmx.de>
500 * gtkdoc-mkdb.in: Accept both the old and the new XInclude
501 namespace. (#131675, Edd Dumbill)
503 2004-01-23 Thomas Vander Stichele <thomas at apestaart dot org>
505 * gtkdoc-mkhtml.in: exit when tools return non-zero so errors can
508 Thu Jan 15 23:06:10 2004 Matthias Clasen <maclas@gmx.de>
510 * gtk-doc.xsl: Set the chunk.fast parameter, to gain some
513 Thu Jan 15 23:05:23 2004 Matthias Clasen <maclas@gmx.de>
515 * gtkdoc-fixxref.in: Make it work again without explicit
518 Sat Dec 27 01:36:08 2003 Matthias Clasen <maclas@gmx.de>
520 * gtkdoc-scangobj.in:
523 * gtkdoc-fixxref.in: Add --help. (#126915)
525 Sat Dec 27 00:43:42 2003 Matthias Clasen <maclas@gmx.de>
527 * gtkdoc-mkdb.in (ParseEnumDeclaration):
528 * gtkdoc-mktmpl.in (ParseEnumDeclaration): Support a trailing ,
529 in enum declarations. These are a GNU C extension, but also
530 blessed by C99. (#129949, Thomas Vander Stichele)
532 Sun Nov 16 00:29:03 2003 Matthias Clasen <maclas@gmx.de>
534 * gtkdoc-scangobj.in: Don't use g_strdown(). (#127028,
537 Sun Nov 16 00:26:05 2003 Matthias Clasen <maclas@gmx.de>
539 * gtkdoc-scangobj.in: If compiled against GLib >= 2.3.0, look
540 for properties on interfaces. (#127068, James M. Cape)
542 2003-11-03 Dan Winship <danw@ximian.com>
544 * gtkdoc-scangobj.in: Clean up $MODULE-scan.o even when using
547 * gtkdoc-scanobj.in: Likewise
549 * gtk-doc.make (CLEANFILES): Remove $(MODULE)-scan.o from here
550 (clean-local): rm -rf .libs
552 Wed Oct 8 01:21:54 2003 Matthias Clasen <maclas@gmx.de>
554 * gtkdoc-scan.in (ScanHeader): Make gtkdoc-scan grok
555 typedef struct { } foo; in addition to the more baroque
556 typedef struct _foo foo; struct _foo { };
557 (#116807, Malcolm Tredinnick)
559 Wed Oct 8 01:21:35 2003 Matthias Clasen <maclas@gmx.de>
561 * gtkdoc-mkdb.in (OutputParamDescriptions): Remove a pointless
564 2003-10-01 Matthias Clasen <maclas@gmx.de>
566 Make signals and properties end up in the right template
567 file (#116569, Owen Taylor):
569 * gtkdoc-mktmpl.in (OutputSignalTemplates):
570 (OutputArgTemplates): Return a string rather than directly
572 (OutputTemplateFile): Don't interpret $title as the name of
573 the object to print signal and property templates for.
574 (UpdateTemplates): Collect signal and property templates for all
575 objects contained in the section.
577 2003-08-10 James Henstridge <james@daa.com.au>
579 * acinclude.m4 (JH_PATH_XML_CATALOG): allow caller to specify
580 actions if found or not found.
581 (JH_CHECK_XML_CATALOG): when requiring JH_PATH_XML_CATALOG, don't
582 error out if it is not found.
584 2003-08-03 Matthias Clasen <maclas@gmx.de>
586 * doc/gnome.txt: Add some hints regarding markup of examples.
588 2003-07-22 Matthias Clasen <maclas@gmx.de>
591 * gtk-doc.cat: Fix a problem with the previous commit.
593 2003-07-21 Matthias Clasen <maclas@gmx.de>
595 Applied patches from Sebastian Rittau to add maintainer mode and an SGML catalog. (#117955, #117956)
597 * gtk-doc.cat.in: New catalog file.
598 * configure.in: Added gtk-doc.catalog to output files.
599 * Makefile.am: Install gtk-doc.catalog.
601 * configure.in: Added AM_MAINTAINER_MODE.
602 * autogen.sh: Added --enable-maintainer-mode to configure options.
604 2003-07-09 Matthias Clasen <maclas@gmx.de>
606 * gtkdoc-mktmpl.in (ParseStructDeclaration):
607 * gtkdoc-mkdb.in (ParseStructDeclaration): Accept volatile struct members, which have just
608 made their appearance in glib.
610 2003-06-29 Matthias Clasen <maclas@gmx.de>
612 * gtkdoc-mkdb.in (ExpandAbbreviations): When expanding @param, catch the common @param->field
613 and @param.field, to reduce the need for littering the C sources with <literal>foo->bar</literal>.
615 2003-06-25 Matthias Clasen <maclas@gmx.de>
619 * gtkdoc-mkdb.in (OutputSGML): Collect hierarchy, interfaces, implementations, prerequisites
620 and derived interfaces separately.
621 (OutputSGMLFile): Take two more arguments: implementations and derived interfaces.
622 (GetHierarchy): Also put immediate children in the local tree.
623 (GetInterfaces): Split into GetInterfaces and GetImplementations.
624 (GetImplementations): New function to get the implementations of an interface.
625 (GetDerived): New function to get the known derived interfaces of an interface.
627 * gtkdoc-mkdb.in (MakeXRef): Accept a second, optional parameter for the
629 (ExpandAbbreviations): Add semantic markup inside the links, so that
630 non-crossreferenced symbols come out properly formatted after link
633 2003-06-15 Matthias Clasen <maclas@gmx.de>
635 Support for a flat index of all symbols. (#92861)
636 To use, put an empty <index/> element in your driver document.
638 * gtkdoc-mkdb.in (MakeIndexterms): New function, emits an indexterm.
639 (OutputMacro, OutputTypedef, OutputStruct, OutputEnum,
640 OutputUnion, OutputVariable, OutputFunction): Use MakeIndexterms.
641 to emit indexterms for symbols.
643 * gtkdoc-mkdb.in (GetSignals):
644 (GetArgs): Emit Since: information for signals and properties.
646 Thu Jun 12 15:55:57 2003 Owen Taylor <otaylor@redhat.com>
648 * gtkdoc-mkhtml.in (declaration): Replace head -1 with -n 1.
649 (Merge change by Elliot Lee from Red Hat package)
651 2003-06-11 Matthias Clasen <maclas@gmx.de>
653 * doc/gnome.txt: Updates to the documentation of inline comments.
655 2003-06-03 Matthias Clasen <maclas@gmx.de>
657 * gtk-doc.spec.in: Add a missing Provides: and include the .pc file.
658 (#106568, Joe Pranevich)
660 2003-05-27 Matthias Clasen <maclas@gmx.de>
662 * gtkdoc-mkdb.in (GetSignals):
663 (GetArgs): Add signals and properties to the statistics.
664 (OutputMissingDocumentation): Emit undocumented signals and
665 properties. (#113645)
667 2003-04-21 Matthias Clasen <maclas@gmx.de>
669 * tools/docpercentages.pl: Fix autolinkification for undocumented
672 * doc/style-guide.txt: Typo fix.
674 2003-04-18 James Henstridge <james@daa.com.au>
678 2003-04-18 James Henstridge <james@daa.com.au>
680 * NEWS: add news items.
682 * configure.in: increment version number.
684 2003-03-14 Matthias Clasen <maclas@gmx.de>
686 * gtkdoc-mkdb.in (OutputBook): Fix the public identifier for
687 DocBook V3.0: Davenport, not DavenPort.
688 (#108343, Mariano Suarez-Alvarez)
690 2003-03-10 James Henstridge <james@daa.com.au>
692 * configure.in: associate the chmod commands with the files they
693 are chmod'ing. This way config.status will always run the correct
696 2003-03-04 James Henstridge <james@daa.com.au>
698 * configure.in: look up the docbook DTD by public id rather than
701 2003-02-26 Matthias Clasen <maclas@gmx.de>
703 * gtkdoc-mkdb.in (GetArgs): Prefer template or comment docs over
704 blurbs only if they're nonempty, otherwise the empty docs from the
705 templates override all the blurbs.
707 2003-02-26 James Henstridge <james@daa.com.au>
709 * autogen.sh (THEDIR): set up so that it will choose automake 1.7
710 or 1.6 in preference to 1.4. Passes distcheck okay.
712 * configure.in: update configure.in script to match
713 recommendations of newer autoconf's, and add an AC_PREREQ()
714 statement, since the xml catalog checks are using new autoconf
717 * gtk-doc.make (xml-build.stamp): since other bits of the makefile
718 were assuming xml, may as well hard code --output-format=xml.
720 2003-02-19 James Henstridge <james@daa.com.au>
722 * Makefile.am: get rid of the dist-hook, and just include the
723 given files in EXTRA_DIST instead.
725 * configure.in: provide meaningful names for the commands.
727 * acinclude.m4 (JH_CHECK_XML_CATALOG): add some extra arguments: a
728 friendly name for the catalog entry, and actions to run if the
729 entry was found or not. Also include a bit more information in
730 the config.log file if an error occurs.
732 2003-02-18 Matthias Clasen <maclas@gmx.de>
734 * gtkdoc-mkhtml.in (declaration): Avoid the unportable grep
737 2003-02-19 James Henstridge <james@daa.com.au>
739 * devhelp.xsl: put chapters that aren't at the top level into the
740 toc tree (to make gtk's .devhelp tree look better).
742 * gtk-doc.spec.in (Requires): make the requires lines match
743 current requirements ...
745 * gtkdoc-mkhtml.in (XSLTPROC): pass --nonet to xsltproc, so we
746 don't try to download DTDs and XSLT over the net. The configure
747 checks should catch people who don't have the correct files in
750 2003-02-17 James Henstridge <james@daa.com.au>
752 * gtkdocize.in (--version): add --version argument.
754 2003-02-14 James Henstridge <james@daa.com.au>
756 * gtkdoc-mkdb.in (GetOptions): actually accept --tmpl-dir as a
757 command line option. Based on a patch from Simon Josefsson
760 * gtk-doc.xsl: remove the xmlns declaration. Not really needed
761 for html output anyway ...
763 2003-02-13 James Henstridge <james@daa.com.au>
765 * devhelp.xsl: remove refsect1's and refsect2's from book tree, as
766 suggested by Hallski.
768 * gtk-doc.make (install-data-local): the change to install images
769 was superfluous, so I have removed it.
770 (CLEANFILES): move some more stuff to CLEANFILES from the
771 distclean-local rule.
773 2003-02-12 James Henstridge <james@daa.com.au>
775 * gtk-doc.make: add some chmod calls to work arround distcheck on
777 (install-data-local): copy the images as well as the html files
779 (uninstall-local): add an uninstall rule to remove the docs.
780 (CLEANFILES): add $(DOC_MODULE)-scan.o to the list of files to be
783 2003-02-09 James Henstridge <james@daa.com.au>
785 * gtkdocize.in: script used to copy gtk-doc.make into another
788 * gtk-doc.make: automake makefile fragment to handle gtk-doc
789 support in other modules.
791 * configure.in: check to make sure DocBook XML DTD and XSLT
792 stylesheets are present in the XML catalog.
794 * acinclude.m4 (JH_CHECK_XML_CATALOG): new macro to check for
795 entries in the XML catalog.
797 2003-02-04 James Henstridge <james@daa.com.au>
799 * gtk-doc.m4: a macro to check for gtk-doc.
801 * Makefile.am (gtkdocdata_DATA): don't bother installing xml.dcl.
802 It isn't used anymore (since switching xml mode to xsltproc).
804 * gtkdoc-mkhtml.in (gtkdocdir): and here.
806 * Makefile.am (gtkdocdatadir): change dir.
808 * configure.in: put data files in $(datadir)/gtk-doc/data, so that
809 they don't all get mixed up with the html docs installed by other
812 2003-01-20 Damon Chaplin <damon@gnome.org>
816 2003-01-20 Damon Chaplin <damon@gnome.org>
818 * configure.in: bumped version to 1.0, and added SGML_OUTPUT_TYPE
819 variable, which we set to 'sgml-raw' if we have openjade, or 'sgml'
820 if we have jade. Added gtk-doc.pc to AC_OUTPUT.
822 * gtkdoc-mkhtml.in: used SGML_OUTPUT_TYPE variable to set the output
823 type of jade/openjade.
825 * gtk-doc.pc.in: new pkg-config file, which apps can use to reliably
826 check the gtk-doc version in future.
828 * Makefile.am (pkgconfigdir): install .pc file, and add it to
831 * examples/configure.in: updated example to use pkg-config for the
834 2003-01-18 James Henstridge <james@daa.com.au>
836 * gtkdoc-mkhtml.in (declaration): switch the output type from
837 "sgml" to "sgml-raw" when using Jade to process docs. This gets
838 rid of the line breaks inside the tags, which were confusing Lynx.
840 2003-01-15 Matthias Clasen <maclas@gmx.de>
842 * gtkdoc-scan.in (ScanHeader): Remove special cases for Pango and
844 * gtkdoc-mkdb.in (OutputDeclaration):
845 * gtkdoc-mktmpl.in (OutputDeclaration): Remove special cases for
846 structs named BlablaClass. (#95398)
848 * gtkdoc-mkdb.in (GetInterfaces): Fix an off-by-one error.
849 (#103466, Josh Parsons)
851 2002-12-28 Chema Celorio <chema@celorio.com>
853 * gtkdoc-scan[g]obj.in: add "void" to functions with no parameters,
854 avoids warning with -Wmissing-prototypes when compiling
857 2002-12-16 James Henstridge <james@daa.com.au>
859 * gtk-doc.spec.in: require perl >= 5.6.0
861 * configure.in: require Perl >= 5.6.0
863 * gtkdoc-fixxref.in: add "use bytes;" to fix malformed UTF-8
864 character errors when run with a UTF-8 locale.
866 2002-12-16 Matthias Clasen <maclas@gmx.de>
868 * gtkdoc-mkdb.in (OutputSGMLFile): Don't emit the additional
869 anchors in the title which breaks the generated html (the title
870 text is copied around). Instead, put the anchors before the
871 synopsis. This isn't perfect, but the best we can achieve without
874 2002-12-13 Matthias Clasen <maclas@gmx.de>
876 * gtkdoc-mkdb.in: Add an --ignore-files option which can be used
877 to omit files or directories from scanning.
878 (OutputSGMLFile): Emit anchors for all objects contained in the
879 file to avoid dangling links.
880 (OutputMissingDocumentation): Emit deprecated symbols after
883 2002-12-12 Matthias Clasen <maclas@gmx.de>
885 * gtkdoc-scan.in (ScanHeader): Also recognize "positive" guards
886 like #ifdef GTK_ENABLE_BROKEN.
888 2002-12-11 Matthias Clasen <maclas@gmx.de>
890 * gtk-doc.xsl: Change XPath path to "//anchor|//refentry" for the
891 generation of index.sgml. The previous path "//anchor|refentry"
892 was not matching any refentrys.
894 2002-12-09 Matthias Clasen <maclas@gmx.de>
896 * gtkdoc-mktmpl.in (UpdateTemplates): Emit unused class structs
897 to $MODULE-unused.txt.
899 2002-12-08 Matthias Clasen <maclas@gmx.de>
901 * gtkdoc-mkdb.in (OutputStruct): Don't emit private parts
902 of class structs to parameter lists in docs. Remove leftover
905 * gtkdoc-mktmpl.in (OutputDeclaration): Don't emit private parts
906 of class structs to parameter lists in templates.
908 2002-12-06 Matthias Clasen <maclas@gmx.de>
910 Improved /*< private >*/ handling: (#95398)
912 * gtkdoc-mkdb.in (OutputStruct): Handle /*< public >*/ and
913 /*< private >*/ for all structs. Default to private for object and
914 class structs, to public for all other structs.
916 * gtkdoc-scan.in (ScanHeader): Emit declarations for class structs
919 2002-12-05 Matthias Clasen <maclas@gmx.de>
921 * gtkdoc-mktmpl.in (OutputDeclaration):
922 * gtkdoc-mkdb.in (ReadTemplateFile): Support @Since: and
923 @Deprecated: as a way to specify since and deprecated information
924 in template files. This works for all kinds of symbols, even those
925 which normally don't have parameter lists.
927 2002-12-02 Matthias Clasen <maclas@gmx.de>
929 * gtkdoc-mkdb.in (MakeDeprecationNote): Support multi-paragraph
932 2002-11-29 James Henstridge <james@daa.com.au>
934 * gtkdoc-mkhtml.in: copy the navigation images for both XML and
937 * gtk-doc.dsl.in: update DSSSL stylesheets to match layout of XSL
940 2002-11-29 Matthias Clasen <maclas@gmx.de>
942 * gtkdoc-scan.in (ScanHeader): Make deprecation guards work with
944 #ifndef DEPRECATION_GUARD
945 #if !defined(DEPRECATION_GUARD) || defined(FOO_COMPILATION)
946 The second form is used in GDK and GTK+ to include selected
947 deprecated symbols when compiling the library itself.
949 2002-11-27 Matthias Clasen <maclas@gmx.de>
951 * gtkdoc-mkdb.in: Parse to new tags in inline doc comments,
952 Since: and Deprecated:, which can be placed after the Returns:
953 tag. Emit the Since: information (which is expected to be just a
954 version number) after the parameters and the Deprecated:
955 information (which is expected to be one or more full sentences)
956 inside the deprecation warning.
957 Warn if a Deprecated: tag is found on a symbol which is not
958 guarded by a deprecation guard in the header.
960 2002-11-26 James Henstridge <james@daa.com.au>
962 * gtkdoc-mkhtml.in: set gtkdoc-bookname and gtkdoc-version
963 parameters in sgml mode, and don't bother with the sed run after
964 processing with jade.
965 In XML mode, pass the version number in as a parameter too.
967 * gtk-doc.dsl.in ($user-html-header$): add <meta> tag if
968 gtkdoc-version is set.
969 (generate-index-mode): if gtkdoc-bookname is set, add it to the
970 hrefs in the index file, like the XSLT sheets do.
972 * gtk-doc.xsl: add gtkdoc.version parameter, and use it to add a
973 <meta> tag with the gtk-doc version number.
975 2002-11-16 Damon Chaplin <damon@gnome.org>
979 2002-11-16 Damon Chaplin <damon@gnome.org>
981 * configure.in: bumped version to 0.10.
983 * Makefile.am (EXTRA_DIST): added MAINTAINERS.
985 * README: updated requirements info, mainly to add XML stuff.
987 * NEWS: added news for 0.10
990 * AUTHORS: updated my email address.
992 2002-11-16 James Henstridge <james@daa.com.au>
994 * gtk-doc.xsl: output HTML in ISO-8859-1 (latin1), as using UTF-8
995 can trigger misinterpretation of web pages when the web server
996 asserts that the document is encoded in latin1 in the mime type.
998 2002-11-15 James Henstridge <james@daa.com.au>
1000 * gtk-doc.xsl: small changes to make the output closer to valid
1003 * gtkdoc-fixxref.in (MakeXRef): when substituting in cross
1004 references, use lower case element and attribute names, and quote
1005 the attribute value.
1007 2002-11-12 James Henstridge <james@daa.com.au>
1009 * gtkdoc-mkdb.in: put content of parameter descriptions in
1010 <simpara> elements instead of <para>'s. This makes the generated
1011 HTML more compact, as it will omit the <p> tag inside the list
1014 * gtk-doc.xsl: adjust stylesheet a little.
1016 2002-11-10 James Henstridge <james@daa.com.au>
1018 * gtk-doc.xsl: change style for documentation.
1020 * gtkdoc-mkhtml.in (declaration): copy PNG files to the html
1023 2002-11-10 Matthias Clasen <maclas@gmx.de>
1025 * gtkdoc-mkdb.in (GetArgs): Expand abbreviations in source doc
1028 2002-11-09 Matthias Clasen <maclas@gmx.de>
1030 * gtkdoc-mktmpl.in (OutputSignalTemplates): Don't replace template
1031 param names with meaningless argn names generated by gtkdoc-scangobj.
1033 * gtkdoc-mkdb.in (GetSignals): Use argument names from source doc
1034 comments, if available.
1035 (GetArgs): Use source doc comments instead of blurb, if available.
1036 (ScanSourceFile): Also accept object::signal and object:property
1038 (MergeSourceDocumentation): For signals only, prefer source doc
1039 param names over template param names.
1041 Fri Nov 8 15:10:57 2002 Owen Taylor <otaylor@redhat.com>
1043 * gtkdoc-mkdb.in (GetPrerequisites): Add missing <para>
1046 Mon Nov 4 17:17:40 2002 Owen Taylor <otaylor@redhat.com>
1048 * gtkdoc-mkdb.in (MergeSourceDocumentation): Warn
1049 when overriding docs in template file by inline comments.
1051 * gtkdoc-mkdb.in (GetInterfaces): Add missing <para> in
1052 "Implemented interfaces" output.
1054 2002-10-29 Damon Chaplin <damon@ximian.com>
1056 * gtkdoc-scangobj.in: in get_type_name() set is_pointer to TRUE for
1057 subtypes of G_TYPE_BOXED and G_TYPE_POINTER. This means we get things
1058 like "GtkTreeIter *iter" rather than "GtkTreeIter iter" which was
1059 incorrect. Also return 'GParamSpec*' for G_TYPE_PARAM.
1060 in lookup_signal_arg_names() changed GtkNotebook::switch-page
1061 page argument to guint. And fixed a few other entries.
1062 Also fixed argument numbering, so we don't get 2 "widget" arguments.
1064 * gtkdoc-scanobj.in: add ';' after unlink command to avoid warning.
1066 2002-10-20 Matthias Clasen <maclas@gmx.de>
1068 * examples/Makefile.am (SCANOBJ_FILES): Add $(DOC_MODULE).prerequisites.
1070 * gtkdoc-mkdb.in: Read $MODULE.prerequisites and put list of
1071 prerequisites below the object hierarchy for interfaces.
1073 * gtkdoc-scangobj.in: Write information about interface
1074 prerequisites to $MODULE.prerequisites.
1076 2002-10-15 Matthias Clasen <maclas@gmx.de>
1078 * gtkdoc-scangobj.in: Sort paramspec arrays for
1079 greater stability and less random tmpl file diffs.
1081 2002-10-14 Matthias Clasen <maclas@gmx.de>
1083 * examples/Makefile.am (SCANOBJ_FILES): Add $(DOC_MODULE).interfaces.
1085 * gtkdoc-mkdb.in: Read $MODULE.interfaces and put lists of
1086 implemented interfaces/known implementations below the object
1087 hierarchy for classes/interfaces.
1089 * gtkdoc-scangobj.in: Write interface information to
1092 2002-10-12 Matthias Clasen <maclas@gmx.de>
1094 * gtkdoc-scangobj.in: Make interface appear in the object hierarchy.
1096 2002-10-11 Matthias Clasen <maclas@gmx.de>
1098 * gtk-doc.xsl: use 'UTF-8', not UTF-8 for default.encoding, to
1099 make the encoding actually appear in the resulting HTML.
1101 2002-10-09 James Henstridge <james@daa.com.au>
1103 * gtkdoc-mkdb.in: set $doctype_header to "" for the SGML case, as
1104 we don't add a doctype to the beginning of SGML fragments.
1106 Tue Sep 17 01:07:51 2002 Jonathan Blandford <jrb@gnome.org>
1108 * gtk-doc.xsl: output the chunks in UTF-8 so other tools can use
1111 2002-09-03 James Henstridge <james@daa.com.au>
1113 * gtk-doc.xsl: turn on rendering of variablelists as tables, and
1114 set CSS rules to style .variablelist instead of .informaltable.
1116 * gtk-doc.dsl.in (variablelist): override the variablelist handler
1117 instead of the tgroups.
1119 * gtkdoc-mkdb.in (OutputStruct): use a <variablelist> for listing
1120 the field descriptions.
1121 (OutputEnum): same here.
1122 (OutputParamDescriptions): and here.
1124 2002-08-12 James Henstridge <james@daa.com.au>
1126 * gtk-doc.xsl: include devhelp.xsl, and call generate.devhelp when
1127 processing the docbook/xml input.
1129 * devhelp.xsl: new file, implements .devhelp file output.
1131 2002-08-18 Havoc Pennington <hp@pobox.com>
1133 * autogen.sh: hardcode aclocal-1.4/automake-1.4 so that users with
1134 both automake 1.6 and 1.4 installed get the right automake. Means
1135 compilation from CVS will now require the latest automake 1.4
1136 release, or manually creating symlinks called "automake-1.4" and
1139 2002-08-08 Matthias Clasen <maclas@gmx.de>
1141 * gtkdoc-scangobj.in: Make sure blurbs end with a '.'
1143 2002-08-08 James Henstridge <james@daa.com.au>
1145 * gtk-doc.xsl: add a gtkdoc.bookname param, and include it in the
1146 index.sgml output (if not empty).
1148 * gtkdoc-mkhtml.in: only perform the sed operation if we are using
1149 Jade, and pass the module name as a parameter when using xsltproc.
1151 2002-08-04 Matthias Clasen <maclas@gmx.de>
1153 * gtkdoc-scangobj.in: Don't try to list signals on types which
1154 don't support signals, e.g. boxed types.
1156 2002-06-14 jacob berkman <jacob@ximian.com>
1158 * gtkdoc-mkdb.in: do the version check before help, so --version
1159 doesn't output --help (should fix recent build bustage)
1161 2002-06-12 Matthias Clasen <maclas@gmx.de>
1163 * gtkdoc-mkdb.in: Make header-grabbing work without an explicit
1164 --main-sgml-file argument.
1166 * gtkdoc-mkdb.in: Emit the object hierarchy as a <screen> rather
1167 than a <literallayout>, since the Docbook XSL stylesheets don't
1168 handle <link>s inside <literallayout>.
1170 * gtkdoc-mkdb.in: Decide wether to generate standalone documents
1171 for XIncluding or entities based on the presence of the XInclude
1172 namespace declaration on the document element.
1174 2002-06-09 James Henstridge <james@daa.com.au>
1176 * gtkdoc-mkdb.in: try to grab the header off the top of the main
1179 2002-05-31 James Henstridge <james@daa.com.au>
1181 * gtkdoc-mkdb.in (OutputSGML): put XIncludes in the $book_bottom
1183 (OutputBook): add the XInclude namespace declaration to the book
1186 * gtkdoc-mkhtml.in (declaration): if the document looks like XML,
1187 process it with xsltproc.
1189 * configure.in: check for xsltproc.
1191 * gtk-doc.xsl: start of XSLT template for converting docbook/xml
1194 2002-06-03 Matthias Clasen <maclas@gmx.de>
1196 * gtkdoc-mkdb.in (ConvertSGMLChars): Don't use Posix character
1197 classes. Perl < 5.6 doesn't have them; and the API doc autobuilder
1198 on widget.gnome.org has an old Perl.
1200 2002-05-29 Matthias Clasen <maclas@gmx.de>
1204 * gtkdoc-mkdb.in (OutputSGML): Call GetSignals, GetArgs and
1205 GetHierarchy for each symbol here and accumulate.
1206 (OutputSGMLFile): Get signal, argument and hierarchy information
1208 (GetSignals, GetArgs, GetHierarchy): Don't wrap the return value
1209 in a refsect1, so that the results of multiple calls can be accumulated.
1211 2002-05-28 Matthias Clasen <maclas@gmx.de>
1213 * gtkdoc-mkdb.in (ConvertSGMLChars): Make this work correctly
1214 for empty elements and XML comments in doc comments.
1216 2002-05-27 Matthias Clasen <maclas@gmx.de>
1218 * gtkdoc-mkdb.in (ReadTemplateFile, OutputSGMLFile):
1219 Use only the basename of the template file in the key for the
1220 symbol table, in order to decouple the file extensions of the
1221 template files and the generated entities (we want to generate
1222 .xml entities from .sgml template files when emitting XML).
1224 2002-05-25 Matthias Clasen <maclas@gmx.de>
1226 * gtkdoc-mkdb.in (ConvertSGMLChars): New function which tries to
1227 be a bit more clever when escaping SGML syntax characters.
1228 (ScanSourceFile): Use ConvertSGMLChars instead of CreateValidSGML.
1229 This reduces the work needed to make gtk-doc emit XML (where <, &
1230 and friends must always be escaped).
1232 2002-05-18 Matthias Clasen <maclas@gmx.de>
1234 * gtkdoc-mkhtml.in: Detect whether we're processing SGML or XML.
1236 * gtkdoc-mkdb.in: New option --output-format to switch between
1237 SGML and XML output.
1239 * Makefile.am (EXTRA_DIST): Add xml.dcl
1241 * xml.dcl: The XML declaration.
1243 2002-05-06 jacob berkman <jacob@ximian.com>
1245 * gtkdoc-scangobj.in: add an include for the GTK_CHECK_VERSION
1248 2002-05-05 Matthias Clasen <maclas@gmx.de>
1250 * gtkdoc-scangobj.in: Output style properties. (#80659)
1252 * gtkdoc-mkdb.in (GetArgs): Return separate sections for
1253 properties, child properties and style properties. (#80659)
1255 2002-05-03 Matthias Clasen <maclas@gmx.de>
1257 * gtkdoc-scangobj.in: Fix for segfault in scangobj-generated C
1258 program on Solaris. (#80606, Jacob Berkman)
1260 2002-05-01 Matthias Clasen <maclas@gmx.de>
1262 * tools/docpercentages.pl: Add the script which Owen uses for the
1263 d.g.o online API docs. Its easier to keep in sync here.
1265 * gtkdoc-mkdb.in (OutputMissingDocumentation): Fix
1266 $MODULE-undocumented.txt for d.g.o online API docs.
1268 * gtkdoc-mkdb.in (GetArgs): Use blurbs for property documentation.
1270 * gtkdoc-scangobj.in: Output child properties. Output nicks and
1271 blurbs for properties.
1273 2002-04-28 Matthias Clasen <maclas@gmx.de>
1275 * gtkdoc-mkdb.in (ScanSourceFile): Don't scan for return value
1276 descriptions unnecessarily. (#65997)
1278 2002-03-11 Matthias Clasen <maclas@gmx.de>
1280 * gtkdoc-scangobj.in, gtkdoc-mkdb.in: Create docs for signals on interfaces.
1282 2002-02-01 Damon Chaplin <damon@ximian.com>
1284 * configure.in: check for openjade or jade. Patch from Stefan Kost
1285 <kost@imn.htwk-leipzig.de>.
1287 * gtkdoc-mkhtml.in: use @JADE@ so the correct version of jade is used.
1289 * autogen.sh: commented out autoheader since we don't have a config.h.
1291 2002-01-18 Damon Chaplin <damon@ximian.com>
1295 2002-02-01 Damon Chaplin <damon@ximian.com>
1297 * examples/Makefile.am: added SCANOBJ_OPTIONS in case the module needs
1298 to pass options to gtkdoc-scanobj or gtkdoc-scangobj.
1300 2002-01-24 Damon Chaplin <damon@ximian.com>
1302 * tools/gtk-doc.el: added Zucchi's emacs lisp for automatically adding
1303 skeleton comment blocks above functions. Very handy!
1305 2002-01-23 Damon Chaplin <damon@ximian.com>
1307 * configure.in: bumped the version to 0.9, so GTK+ can depend on this
1310 * gtkdoc-scangobj.in: we now default to calling g_type_init() to
1311 initialize the type system, rather than gtk_init(). This means you
1312 don't need an X connection to build the docs any more. Hurrah!
1313 Also added a '--type-init-func' argument so you can change the
1314 function to be called. GTK+ uses --type-init-func="gtk_type_init(0)".
1316 * gtkdoc-scan.in (ScanHeader): removed 'Found object' debug message.
1318 2002-01-18 Damon Chaplin <damon@ximian.com>
1322 2002-01-18 Damon Chaplin <damon@ximian.com>
1324 * Makefile.am (EXTRA_DIST): added gtk-doc.dcl to EXTRA_DIST.
1326 2002-01-18 Damon Chaplin <damon@ximian.com>
1328 * gtkdoc-scangobj.in: Reverted jacob's patch for this release, since
1329 it breaks GTK+ and possibly other packages. I'll re-apply it after
1330 the release, so we can fix everything in CVS.
1332 2002-01-18 jacob berkman <jacob@ximian.com>
1334 * gtkdoc-scangobj.in: default to calling g_type_init(), remove
1335 --nogtkinit argument and replace with a more flexible
1338 2002-01-18 Damon Chaplin <damon@ximian.com>
1340 * gtkdoc-mkdb.in (ScanSourceFile): patch from Matthias Clasen
1341 <matthiasc@poet.de> to only strip first space after '*' in source
1342 code comment blocks, so example code can be indented as desired.
1345 Wed Nov 21 16:50:35 2001 Owen Taylor <otaylor@redhat.com>
1347 * gtkdoc-mkdb,tmpl.in: Add some extra quoting to
1348 error messages to make it clearer what is going on
1349 with trailing commas on enumeration declarations.
1351 Wed Nov 21 16:00:45 2001 Owen Taylor <otaylor@redhat.com>
1353 * Applied patch from Matthias Clasen to use a modified
1354 .dcl file with the 44 character name length limit removed.
1357 2001-10-17 Damon Chaplin <damon@ximian.com>
1359 * gtkdoc-mkdb.in: applied patch from Matthias Clasen
1360 <matthiasc@poet.de> to take a --sgml-mode argument which means
1361 all comment blocks in the source code are assumed to be DocBook
1362 (i.e. we don't convert '<', '>' and '&' to '<' etc.
1364 2001-10-09 Damon Chaplin <damon@ximian.com>
1366 * gtkdoc-mkdb.in (OutputMissingDocumentation): changed %.2f to %.0f
1367 so hopefully the automated reports on developer.gnome.org will work
1370 2001-10-02 Damon Chaplin <damon@ximian.com>
1372 * gtkdoc-mktmpl.in (OutputDeclaration):
1373 * gtkdoc-mkdb.in (OutputFunction): applied patch from
1374 matthiasc@poet.de (Matthias Clasen) to handle G_CONST_RETURN in a
1375 parameter list. Bug #61341.
1377 2001-10-02 Damon Chaplin <damon@ximian.com>
1379 * gtkdoc-mkdb.in (OutputMissingDocumentation): applied patch from
1380 matthiasc@poet.de (Matthias Clasen) to output percentages better.
1382 Also set percent to 100 if total is 0, avoiding divide-by-zero.
1384 2001-10-02 Damon Chaplin <damon@ximian.com>
1386 * examples/Makefile.am (DOC_OVERRIDES): define as an empty string,
1389 2001-09-13 Damon Chaplin <damon@ximian.com>
1391 * gtkdoc-mkdb.in (OutputMissingDocumentation): initialize buffer to "".
1392 Fix for SGI from David Kaelbling <drk@sgi.com>.
1394 Sat Sep 8 14:08:51 2001 Jonathan Blandford <jrb@webwynk.net>
1396 * gtkdoc-scan.in (ScanHeader): recognize GET_IFACE macros
1398 2001-09-08 Havoc Pennington <hp@pobox.com>
1400 * gtkdoc-mkdb.in (GetArgs): Title the section on object properties
1401 "Properties" instead of "Args"
1403 2001-08-14 Laszlo Peter <laca@ireland.sun.com>
1405 * gtkdoc-scanobj.in:
1406 * gtkdoc-scangobj.in: change \n's to \\n's in perl scripts
1409 2001-08-12 Jens Finke <jens@gnome.org>
1411 * Updated gtk-doc.spec.in file to match gpp standard.
1413 2001-08-04 Damon Chaplin <damon@ximian.com>
1417 2001-08-04 Damon Chaplin <damon@ximian.com>
1419 * gtkdoc-mkdb.in (OutputFunction):
1420 * gtkdoc-mktmpl.in (OutputDeclaration): patch from Lowell Johnson
1421 <ldjohn@usgs.gov> to accept things like "long long", "short int",
1422 "char test[][CLEN]" as function parameters.
1424 2001-07-20 Anders Carlsson <andersca@gnome.org>
1426 * gtkdoc-scangobj.in: Remove argument to g_type_init ();
1428 2001-07-09 Damon Chaplin <damon@ximian.com>
1430 * gtkdoc-mkdb.in (ParseStructDeclaration): accept G_CONST_RETURN
1431 modifier for function return values. gtkdoc-mktmpl.in already had this.
1433 Thu Jun 21 11:57:16 2001 Owen Taylor <otaylor@redhat.com>
1435 * gtkdoc-scangobj.in: Conform to changes in GObject API
1436 for property retrieval.
1438 2001-05-25 Peter Williams <peterw@ximian.com>
1440 * gtkdoc-mkdb.in (ScanSourceFile): Skip single-line comments --
1441 prevents barfing on ORBit-generated files.
1443 2001-05-20 Damon Chaplin <damon@ximian.com>
1445 * examples/Makefile.am (sgml-build.stamp): replaced use of wildcard
1446 (which isn't portable) with original *.sgml. I think this just means
1447 that the first time you try to build the docs it will fail, but if
1448 you run make again it will work.
1450 * doc/setting-up.txt: explained that make may fail the first time.
1452 2001-05-19 Damon Chaplin <damon@ximian.com>
1456 * doc/setting-up.txt:
1457 * doc/sections-file.txt:
1458 * doc/authors.txt: updated docs to cover simpler setup procedure.
1460 * doc/gtk_button.txt:
1463 * doc/notes.txt: removed out-of date stuff.
1465 * Makefile.am (dist-hook): updated so it doesn't try to remove old
1466 examples subdirectory stuff.
1468 2001-05-19 Damon Chaplin <damon@ximian.com>
1471 * examples/gnomeui/*: removed out-of-date example files.
1473 * examples/configure.in:
1474 * examples/Makefile.am: new example setup mostly copied from GTK+.
1476 * examples/README: describe the example configure.in/Makefile.am.
1478 2001-05-19 Damon Chaplin <damon@ximian.com>
1480 * gtkdoc-mkdb.in: added --help option and changed output slightly to
1481 make more compatable with XML. Patch from Toshio Kuratomi
1482 <badger@prtr-13.ucsc.edu>
1484 2001-05-19 Damon Chaplin <damon@ximian.com>
1486 * gtkdoc-mktmpl.in (OutputDeclaration):
1487 * gtkdoc-mkdb.in (OutputFunction): changed a '?' to a '*' so we accept
1488 multi-dimensional array function parameters. Patch from Paolo Casarini
1489 <casarini@CS.UniBO.IT>
1491 2001-05-12 Damon Chaplin <damon@ximian.com>
1493 * gtkdoc-scangobj.in:
1494 * gtkdoc-scanobj.in: used "*pos = 0" to avoid problems with backslashes
1497 * configure.in: removed dsssl dirs stuff, since we use public entities
1500 * gtkdoc-mkdb.in (OutputBook): if there is no main SGML file we create
1501 it here. Also added a --main-sgml-file option so we know where to put
1504 * gtkdoc-scan.in: if there is no MODULE-sections.txt file, we copy
1505 the MODULE-decl-list.txt file to it. The user can tweak it later.
1507 2001-05-11 Damon Chaplin <damon@ximian.com>
1509 * gtk-doc.spec.in: applied patch from Toshio Kuratomi
1510 <badger@prtr-13.ucsc.edu>.
1512 2001-05-07 Joakim Ziegler <joakim@ximian.com>
1514 * gtkdoc-mkdb.in: Added option --outputallsymbols to create a symbol list
1515 in the module doc dir.
1517 * gtkdoc-mkdb.in: Added functionality to output a list of undocumented
1518 symbols in a module, most of is is in OutputMissingDocumentation.
1520 * gtkdoc-scan.in: Small scanning fixes to facilitate the doc coverage
1521 output mentioned above.
1523 2001-04-25 Federico Mena Quintero <federico@ximian.com>
1525 * gtkdoc-scanobj.in: Added missing output-dir in the call to
1528 2001-04-24 Damon Chaplin <damon@ximian.com>
1530 * gtkdoc-scanobj.in: copied --outputdir option from gtkdoc-scangobj.in.
1532 Fri Apr 13 15:25:44 2001 Owen Taylor <otaylor@redhat.com>
1534 * gtkdoc-mkdb.in: Restore call to OutputBook that was accidentally
1537 Thu Apr 12 17:57:12 2001 Owen Taylor <otaylor@redhat.com>
1539 * gtkdoc-scangobj.in: Add a --outputdir option (sort of hacky.
1540 Need this because $CC, $LD can include relative paths if they
1541 are based on $LIBTOOL)
1543 2001-03-26 Damon Chaplin <damon@ximian.com>
1545 * gtkdoc-mkdb.in (ReadSourceDocumentation): scan .h files as well,
1546 so macros can be documented there if desired. Patch from
1547 Yoann Vandoorselaere <yoann@mandrakesoft.com>
1549 * gtkdoc-mkhtml.in (gtkdocdir): use 'test -f' rather than 'test -e'
1550 which is GNU-specific.
1552 Thu Mar 8 17:26:29 2001 Tim Janik <timj@gtk.org>
1554 * gtkdoc-scangobj.in: fix signal param type handling.
1556 Tue Mar 6 23:21:46 2001 Jonathan Blandford <jrb@redhat.com>
1558 * gtkdoc-scanobj.in: Add gobject support. Now works on files that
1559 don't link against GTK.
1561 Sat Mar 3 17:43:42 2001 Owen Taylor <otaylor@redhat.com>
1563 * gtkdoc-{scan,mktmpl,mkdb}.in: Add support for G_CONST_RETURN.
1564 (Right now, it will appear as G_CONST_RETURN in the output -
1565 I'm not sure that's right - perhaps it should be converted
1568 2001-02-20 Michael Meeks <michael@ximian.com>
1570 * gtkdoc-mktmpl.in: s/TRUE/1/
1572 2001-02-19 Damon Chaplin <damon@ximian.com>
1574 * gtkdoc-mktmpl.in (UpdateTemplates): fixed bug handling the $changed
1577 2001-02-17 Damon Chaplin <damon@ximian.com>
1579 * gtkdoc-scan.in (ScanHeaders):
1580 (ScanHeader): patch from Johannes Stezenbach <js@convergence.de>
1581 so we don't use '\b' in the regexp to match files/dirs to ignore.
1582 '\b' can match '_' so we matched things we shouldn't have.
1584 Mon Feb 12 12:50:57 2001 Owen Taylor <otaylor@redhat.com>
1586 * configure.in: Up version.
1588 Sun Feb 11 18:35:07 2001 Owen Taylor <otaylor@redhat.com>
1590 * gtkdoc-mktmpl.in: Add a timestamp file for the
1591 templates like sgml.stamp
1593 * gtkdoc-mktmpl.in (OutputUnusedTemplates): Write the
1594 symbols out in sorted order instead of hash table
1595 order to reduce conflicts.
1597 Mon Feb 5 16:48:51 2001 Owen Taylor <otaylor@redhat.com>
1599 * configure.in gtk-doc.dsl.in: Remove checks for DSSSL - use a
1600 public entity instead.
1602 * gtkdoc-scangobj.in: Fix to work with libtool better.
1604 2001-01-30 Havoc Pennington <hp@pobox.com>
1606 * gtkdoc-fixxref.in, gtkdoc-mkdb.in, gtkdoc-mktmpl.in,
1607 gtkdoc-scan.in, gtkdoc-scangobj.in, gtkdoc-scanobj.in:
1608 Added -*- cperl -*- magic, and --deprecated-guards
1611 2001-01-23 Damon Chaplin <damon@helixcode.com>
1613 * gtkdoc-scangobj.in:
1614 * gtkdoc-scanobj.in:
1617 * gtkdoc-mktmpl.in: changed so that they only update files when
1618 necessary (they write new versions of the files out, then use 'cmp'
1619 to compare with the existing versions to see if they have changed.)
1620 This should make it easier to do proper dependency rules in Makefiles,
1621 and it may cut down on CVS traffic.
1623 * gtkdoc-mkhtml.in: update a timestamp file (html.stamp) after running.
1624 * gtkdoc-mkdb.in: update a timestamp file (sgml.stamp) if any of the
1625 DocBook SGML files have been changed. So hopefully you can now use
1626 rules like this to avoid unnecessary regeneration of the HTML:
1634 html.stamp: sgml.stamp $(EXTRA_SGML_FILES)
1637 (I've tried this with the old GTK+ reference API docs and it seems to
1640 * gtkdoc-scangobj.in:
1641 * gtkdoc-scanobj.in:
1647 * gtkdoc-fixxref.in:
1648 Added '--version' command-line arg to all shell & perl scripts, so
1649 you can check for version 0.5 if you want to use the above rules.
1650 (If 0.4 is used make will probably complain about not knowing how to
1651 to build sgml.stamp.)
1653 * gtkdoc-common.pl.in: new file to contain shared routines.
1654 For now it just contains the UpdateFileIfChanged routine for the above.
1655 We can move the duplicated routines here in future, though the use of
1656 global variables makes this a bit awkward.
1658 * configure.in (PACKAGE_DATA_DIR): calculates the data dir and
1659 substitutes it so that the scripts know where gtkdoc-common.pl
1660 is installed. Also added gtkdoc-common.pl to AC_OUTPUT.
1662 * Makefile.am: added gtkdoc-common.pl to gtkdocdata_DATA.
1664 * gtkdoc-mkhtml.in: deleted the old index.sgml file, since it causes
1665 problems if it is owned by root (e.g. after you run 'make install' as
1666 root. jade prompts you about overwriting it, which is annoying.
1668 2001-01-10 Havoc Pennington <hp@redhat.com>
1670 * gtkdoc-mktmpl.in: Only move old file to backup if the old file
1671 exists, and have better error messages when doing the backups
1673 Mon Jan 8 14:57:29 2001 Owen Taylor <otaylor@redhat.com>
1675 * gtkdoc-mktmpl.in: Canonicalize signal and argument
1678 * gtkdoc-scangobj.in: Fix up for GParamSpec.
1680 2001-01-04 Frédéric Gobry <frederic.gobry@smartdata.ch>
1682 * gtkdoc-scan.in: fixed matching of < private_header > directive
1684 2000-12-19 Damon Chaplin <damon@helixcode.com>
1686 * gtkdoc-scanobj.in:
1687 * gtkdoc-scangobj.in: added default cases to get_type_name().
1689 2000-12-10 Arturo Tena <arturo@directmail.org>
1691 * gtkdoc-scanobj.in (get_type_name):
1692 * gtkdoc-scangobj.in (get_type_name): fixed syntax error: forgotten
1693 to close a switch statement.
1695 2000-12-10 Damon Chaplin <damon@helixcode.com>
1697 * gtk-doc.spec.in: added spec.in file from John Gotts
1698 <jgotts@linuxsavvy.com>.
1700 * configure.in (AC_OUTPUT): added spec file.
1702 * Makefile.am: uncommented spec file stuff, now that we have one.
1704 * gtkdoc-scanobj.in (get_type_name):
1705 * gtkdoc-scangobj.in (get_type_name): updated to use the type numbers
1706 rather than the type names, which were changed in GTK+ 1.2. This
1707 should fix a problem where GTK_TYPE_STRING arguments were output as
1708 'GtkString *arg' instead of 'gchar *arg'.
1710 I'm still not sure what to output for the structured types such as
1711 GTK_TYPE_SIGNAL/ARGS/FOREIGN/CALLBACK/C_CALLBACK. Should these be
1712 expanded to several arguments to the signal handler?
1714 2000-11-25 Dan Mueth <d-mueth@uchicago.edu>
1716 * help/manual/C/: created this path
1717 * gtk-doc-manual.sgml: Put part of the outline into SGML.
1718 Chris plans to put rest of outline in here and start
1720 * fdl-appendix.sgml: The FDL in SGML. We will probably post
1721 these on the web as a single document (book) so we will
1722 need the FDL to be included as an appendix.
1724 Fri Nov 3 07:21:34 2000 Tim Janik <timj@gtk.org>
1727 (ParseStructDeclaration):
1730 (ParseStructDeclaration):
1731 support /*<protected>*/ equivalently to /*<private>*/
1733 Fri Nov 3 07:15:58 2000 Tim Janik <timj@gtk.org>
1737 (ReadTemplateFile): only eat up the first space (if at all
1738 present) after "@param:" to preserve indentation for multiline
1739 parameter descriptions.
1741 2000-10-30 Raja R Harinath <harinath@cs.umn.edu>
1743 * gtkdoc-mkdb.in (ParseStructDeclaration):
1744 Stop scanning at '}' only when it starts a line.
1745 * gtkdoc-mktmpl.in (ParseStructDeclaration): Likewise.
1747 Mon Oct 30 02:59:54 2000 Tim Janik <timj@gtk.org>
1749 * gtkdoc-scangobj.in: use g_signal_list_ids().
1751 Sun Oct 29 02:54:51 2000 Owen Taylor <otaylor@redhat.com>
1753 * gtkdoc-scangobj.in: Sort signal types arrays for
1754 greater stability and less random tmpl file diffs.
1756 Sun Oct 29 01:02:35 2000 Owen Taylor <otaylor@redhat.com>
1758 * gtkdoc-scangobj.in: Work properly with GSignal
1760 2000-10-21 Damon Chaplin <damon@helixcode.com>
1764 2000-10-14 Damon Chaplin <damon@helixcode.com>
1767 * MAINTAINERS: changed my email address.
1769 * Makefile.am (dist-hook): remove the CVS dirs from the dist.
1771 * doc/setting-up.txt: typo.
1773 Fri Oct 6 17:51:50 2000 <otaylor@redhat.com>
1775 * gtkdoc-scan.in gtkdoc-mkdb.in: Allow multiple
1776 --source-dir options.
1778 Thu Sep 7 11:41:12 2000 Owen Taylor <otaylor@redhat.com>
1780 * gtkdoc-mkdb.in: Ignore all . files when scanning directories.
1782 * gtkdoc-scan.in: Add support for GLIB_VAR, GDKVAR,
1783 etc when looking for variable declarations.
1785 * gtkdoc-scan.in: Recognize GET_CLASS macros.
1787 * gtkdoc-scangobj.in: Support .lo intermediate files
1790 Wed Sep 6 17:57:33 2000 Owen Taylor <otaylor@redhat.com>
1792 * gtkdoc-scangobj.in: Add gtkdoc-scangobj scanner for
1793 GObject type system.
1795 * gtkdoc-scanobj.in: Allow setting $LD to allow separating
1796 compilation and linking and thus to allow using libtool.
1798 * gtkdoc-fixxref.in (ScanIndices): Allow HTMLDIR
1799 not to be present yet.
1801 Tue Sep 5 23:37:53 2000 Owen Taylor <otaylor@redhat.com>
1803 * gtkdoc-fixxref.in: Add a --extra-dir option to
1804 allow scanning of additional uninstalled HTML
1807 * gtkdoc-scan.in (ScanHeaders): Honor subdirectories
1808 appearing in --ignore-headers.
1810 * gtkdoc-mkdb.in: Append -CAPS to all all-caps identifiers
1811 to prevent an infinite expansion of special cases.
1813 * gtkdoc-fixxref.in: Add a --module-dir option to
1814 allow fixing references in an uninstalled tree.
1816 * gtkdoc-mkdb.in gtkdoc-mkhtml.in: Simple handling
1817 for macros with embedded commas in enumeration
1820 Mon Aug 28 18:18:53 2000 Owen Taylor <otaylor@redhat.com>
1822 * configure.in (DSSSL_DIR): Remove check for AM_PATH_GTK
1823 since the dependency is only run-time not install-time,
1824 and to avoid dependency loops.
1826 2000-06-21 Damon Chaplin <damon@helixcode.com>
1828 * gtkdoc-mkdb.in: fixed <INCLUDES> bug, I think.
1830 Wed Feb 9 11:29:25 2000 Owen Taylor <otaylor@redhat.com>
1832 * gtkdoc-scan.in: Hack to avoid misidentifying structures
1833 as GtkObjects within Pango.
1835 1999-12-15 Raja R Harinath <harinath@cs.umn.edu>
1837 * gtk-doc.dsl.in ($generate-chapter-toc$): Add missing close
1840 1999-11-23 Raja R Harinath <harinath@cs.umn.edu>
1842 * gtk-doc.dsl.in: Use the (define (foo) ...) syntax rather than
1843 the uglier (define foo (lambda () ...)) syntax.
1844 ($generate-chapter-toc$): Simplify.
1845 ($shade-verbatim-attr$): Simplify. Use ($table-width$) instead of
1846 "100%" for width (See docs. of NWalsh Docbook DSSSL Stylesheets
1847 for an explanation).
1849 1999-09-20 Damon Chaplin <damon@karuna.freeserve.co.uk>
1851 * gtk-doc.dsl.in: If a Chapter has role="no-toc" we don't generate a
1852 table of contents. This is useful if a better contents page has been
1853 added manually, e.g. for the GTK+ Widgets & Objects page. (But it is
1856 * gtkdoc-scanobj.in: added --nogtkinit flag which will make it call
1857 gtk_type_init() rather than gtk_init(). This is useful when it is
1858 run automatically to update the docs by a cron job or similar and a
1859 connection to an X server is not desirable. However, if any widgets
1860 need a connection to X in their class init function then this can't
1861 be used (e.g. GtkFontSelection at present).
1863 Mon Sep 20 09:09:12 1999 Owen Taylor <otaylor@redhat.com>
1865 * gtkdoc-mkdb.in gtkdoc-mktmpl.in: (ParseStructDeclaration):
1866 Fixed up the code to do /*< private >*/ ... stripping.
1868 1999-09-10 Martin Baulig <martin@home-of-linux.org>
1870 * gtkdoc.dsl.in ($generate-chapter-toc$): Return #t, not #f.
1872 1999-09-09 Martin Baulig <martin@home-of-linux.org>
1874 * gtkdoc-scan.in (ScanHeader): Don't force typedefs and other
1875 things to start in column 0; allow some spaces in front of them.
1876 Output `typedef struct { ... } name' structs as typedef, not as
1879 1999-09-08 Martin Baulig <martin@home-of-linux.org>
1881 * gtkdoc-mkdb.in (CreateValidSGMLID): `s/::/-/g;' for CORBA objects.
1883 1999-08-22 Erik Walthinsen <omega@cse.ogi.edu>
1885 * gtkdoc-scan.in: modified so it will find any Class, not just Gtk
1886 and Gnome classes. Introduces the possibility of extraneous Class
1887 definitions (verified), which should be pruned somehow (haven't
1888 analyzed the false positive yet).
1890 1999-08-22 Damon Chaplin <damon@karuna.freeserve.co.uk>
1893 * gtkdoc-mkdb.in: a few fixes to ParseStructDeclaration. It still
1894 has problems with nested structs/unions like those which occur in
1895 gtkclist.h and gtktypeutils.h.
1897 * configure.in: removed gtk-doc.spec from AC_OUTPUT, as whoever wrote
1898 this forgot to add gtk-doc.spec.in to CVS.
1899 * Makefile.am: commented out gtk-doc.spec.
1901 Wed Aug 18 03:55:30 1999 Owen Taylor <otaylor@redhat.com>
1903 * gtkdoc-mktmpl.in: Propagate fix from gtkdoc-mkdb.in.
1904 :-(; need to libraryize, need to libraryize.
1906 Wed Aug 18 03:55:30 1999 Owen Taylor <otaylor@redhat.com>
1908 * gtkdoc-mkdb.in: Fix bug that was preventing
1909 structure field definitions from being output.
1911 Wed Aug 18 23:25:23 1999 Owen Taylor <otaylor@redhat.com>
1913 * configure.in: Add /usr/lib/sgml/stylesheet to list
1914 of stylesheet directories. (Found in recent Debian
1917 1999-08-15 Damon Chaplin <damon@karuna.freeserve.co.uk>
1919 * gtkdoc-mkdb.in: Output $decl_out as the struct rather than the
1920 original $declaration.
1922 1999-08-12 Damon Chaplin <damon@karuna.freeserve.co.uk>
1925 * gtkdoc-mktmpl.in: Added special case in ParseEnumDeclaration to
1926 handle GIOCondition which uses strange macros like this:
1929 G_IO_IN GLIB_SYSDEF_POLLIN,
1931 The GLIB_SYSDEF_POLLIN macro expands to something like '=1'
1933 1999-08-05 Damon Chaplin <damon@karuna.freeserve.co.uk>
1935 * gtk-doc.dsl.in: output <br clear=all> after sections and at end of
1936 page so that right-aligned images aren't messed up quite as much.
1938 Wed Aug 4 04:04:55 1999 Owen Taylor <otaylor@redhat.com>
1940 * gtkdoc-mk{db,tmpl}.in (ParseStructDeclaration): Allow
1943 * gtkdoc-mktmpl.in (ReadObjectHierarchy): Remove
1944 call to MakeXref that slipped in accidentally.
1946 Wed Aug 4 03:30:19 1999 Owen Taylor <otaylor@redhat.com>
1948 * doc/style-guide.txt: Removed references to creating
1949 tables explicitely in favor of demonstrating new
1950 syntax. Added a short section on /<* public >*/
1951 and /*< private *>/.
1953 Wed Aug 4 03:15:19 1999 Owen Taylor <otaylor@redhat.com>
1955 * gtkdoc-mktmpl.in gtkdoc-mkhtml.in: Handle Struct and
1956 Enumerations in approximately the same way as we
1957 handle parameters. That is, instead of (as before)
1958 coding in the tables by hand, one uses lines like:
1960 @width: the width of the rectangle in pixels.
1962 To support migration from the older hand-coded
1963 tables, if none of the members of a structure or
1964 enumeration have a description in a @... line, then
1965 we don't generate the table at all.
1967 Also, gtkdoc-mktmpl now loads up the object heirarchy,
1968 because we need to be able to check if structures
1969 are widget structures.
1971 In general, the coding here is pretty clean, though
1972 the style is a little different. (I'm interating
1973 through strings with m/.../msg; instead of
1974 s/^...//; for one thing.) However, there are a some
1975 of FIXME's where I've whimped out on try to handle
1976 real C syntax, and the need to split out and librarize
1977 a bunch of duplicated code is greater than ever.
1979 1999-06-06 Damon Chaplin <damon@karuna.freeserve.co.uk>
1981 * configure.in: updated version to 0.3.
1983 * doc/style-guide.txt: A couple of minor changes.
1985 * gtkdoc-mkdb.in: Get rid of a couple of messages.
1986 Output an empty <para> if an Arg isn't documented, to keep Jade happy.
1988 1999-05-22 Damon Chaplin <damon@karuna.freeserve.co.uk>
1990 * gtk-doc.dsl.in: Renamed %shade-verbatim-attr-2% to
1991 $shade-verbatim-attr$ and removed our redefinition of
1992 $verbatim-display$ since the stylesheets version now calls
1993 $shade-verbatim-attr$ as a function which is just what we wanted.
1995 * README: Updated info on stylesheet versions supported - 1.40 is
1996 known to be OK (with this version of gtk-doc), 1.19+ may work.
1998 1999-03-31 Damon Chaplin <damon@karuna.freeserve.co.uk>
2000 * configure.in: update version to 0.2 for next release.
2003 * gtkdoc-mkdb.in: added support for 'See Also' section.
2005 * gtk-doc.dsl.in: changed green background color slightly, and
2006 set background color for enum tables.
2008 1999-03-21 Damon Chaplin <damon@karuna.freeserve.co.uk>
2010 * gtkdoc-mkhtml.in (gtkdocdir): use '-w no-idref' to suppress all the
2011 warnings about references to non-existent IDs.
2013 1999-03-18 Damon Chaplin <damon@karuna.freeserve.co.uk>
2015 * gtkdoc-mkdb.in (OutputParamDescriptions): use role="params" for the
2016 table so we can adjust the stylesheet code.
2017 (OutputSGMLFile): Don't output 'one line description goes here'.
2018 (ExpandAbbreviations): allow '-' in #symbol abbreviations, so we can
2019 use #GtkWidget-struct.
2020 (MakeXRef): get rid of special '-struct' suffix, for #GtkWidget-struct.
2022 * gtk-doc.dsl.in: use the "role" attribute on tables to set the
2025 * gtkdoc-scan.in (ScanHeader): fix for scanning functions declared
2026 over multiple lines - was catching things which weren't functions.
2028 1999-03-11 Damon Chaplin <damon@karuna.freeserve.co.uk>
2030 * examples/gnomeui/Makefile.am (clean-local):
2031 * examples/gnome/Makefile.am (clean-local): added *.args
2033 * gtkdoc-mkdb.in: added support for Args and variables. Also a few
2034 minor changes in the output, e.g. don't show macros > 2 lines long.
2037 * gtkdoc-scanobj.in: added support for Args.
2039 * gtkdoc-scan.in: added support for extern'ed variables. Also
2040 accept 'extern' before function declarations.
2042 * gtk-doc.dsl.in: made output prettier. Changed the navigation bars
2043 and the colours used for the various backgrounds.
2045 * doc/style-guide.txt: new file containinf a style guide for writing
2046 the GTK+ documentation.
2048 * doc/README: added description of style-guide.txt
2050 * doc/setting-up.txt: fixed a typo
2052 * README: added a bit about Args.
2054 1999-02-07 Damon Chaplin <damon@karuna.freeserve.co.uk>
2056 * Makefile.am: Removed all the scripts from EXTRA_DIST, as they are
2057 now generated from the .in files which automatically go in the dist.
2059 1999-02-02 Damon Chaplin <damon@karuna.freeserve.co.uk>
2061 * doc/setting-up.txt (scan): removed text which incorrectly said that
2062 changing section titles means you have to recreate the main SGML file.
2064 1999-02-03 Sebastian Wilhelmi <wilhelmi@ira.uka.de>
2066 * configure.in: find perl in $PATH, generate the perl programs
2067 from their *.in counterparts.
2069 * gtkdoc-fixxref, gtkdoc-mkdb, gtkdoc-mktmpl, gtkdoc-scan,
2070 gtkdoc-scanobj: Renamed to *.in and changed /usr/bin/perl to
2071 @PERL@, as determined by configure.
2073 * .cvsignore: Added diverse config* stuff and the new generated
2076 1999-01-28 Damon Chaplin <damon@karuna.freeserve.co.uk>
2078 * gtk-doc.dsl.in: I forgot to make the new refentry code process the
2079 child elements, so it was only outputting anchors for each page.
2081 * doc/setting-up.txt (scan): added step to create MODULE.types file
2082 for modules which contain widgets (or objects).
2084 * gtkdoc-mkdb (OutputStruct): allow spaces inside the public/private
2085 markers, e.g. "/* < public > */"
2087 1999-01-27 Damon Chaplin <damon@karuna.freeserve.co.uk>
2089 * Makefile.am: added scripts to EXTRA_DIST and copied examples, doc
2090 and db2man dirs in dist-hook.
2092 * doc/sections-file.txt: added a couple of examples.
2094 * doc/setting-up.txt: new document describing how to set up a module
2097 * doc/README: added description of setting-up.txt
2099 * README: added short 'Installation' section describing the
2100 --with-dsssl-dir option.
2102 * gtk-doc.dsl.in: also output links to each RefEntry page in the
2103 index.sgml file, so libgnomeui docs can link to widgets. (The widget
2104 hierarchy links were not working before.)
2106 1999-01-26 Damon Chaplin <damon@karuna.freeserve.co.uk>
2108 * gtkdoc-scan (ScanHeader): parse function declarations that have the
2109 return type and name on one line, and the '(' and args on the next.
2110 NOTE: functions with the start of the declaration split over 3 lines
2111 will not be parsed (e.g. return type on one line, function name on
2112 next, and '(' and first argument on the third.) I hope there aren't
2115 * gtkdoc-mkdb (OutputStruct): Use a different SGML ID for widget
2116 structs, since the original ID is used for the entire RefEntry.
2117 Also only show parts of widget structs which are marked with a
2118 comment '/*<public>*/'. Use '/*<private>*/' for private fields.
2120 * gtkdoc-mktmpl (UpdateTemplates): We include widget structs now,
2121 so we do want warnings if they aren't used.
2123 * examples/gnomeui/gnomeui-docs.sgml:
2124 * examples/gnomeui/gnomeui-sections.txt:
2125 * examples/gnomeui/gnomeui.types:
2126 * examples/gnome/gnome-docs.sgml:
2127 * examples/gnome/gnome-sections.txt: sync with latest source.
2129 * examples/configure.in: Add --with-gnome-libs-dir option, so it can
2130 be configured easily.
2131 * examples/gnomeui/Makefile.am (DOC_SOURCE_DIR):
2132 * examples/gnome/Makefile.am (DOC_SOURCE_DIR): use the new
2135 * gtkdoc-mkdb (MergeSourceDocumentation): accept parameters names in
2136 the source which use the wrong case, since there are quite a few of
2139 1999-01-25 Damon Chaplin <damon@karuna.freeserve.co.uk>
2141 * gtkdoc-mktmpl: parse G_GNUC_EXTENSION before typedef'ed types.
2143 * gtkdoc-mkdb: added support for specifying include files in the
2144 MODULE-sections.txt file, to be output at the top of the synopsis.
2146 * doc/sections-file.txt: added description of <INCLUDE> tag.
2148 * examples/gnomeui/gnomeui-sections.txt:
2149 * examples/gnome/gnome-sections.txt: added use of <INCLUDE>
2151 * examples/configure.in: changed 'gtk-reference' to
2152 'gnome-libs-reference'.
2154 1999-01-18 Damon Chaplin <damon@karuna.freeserve.co.uk>
2156 * README: updated my email address & noted that version 1.15+ of the
2157 DocBook modular stylesheets is needed (for $table-width$).
2159 * AUTHORS: updated my email address.
2161 1998-12-20 Jeff Garzik <jgarzik@pobox.com>
2163 * examples/gnomeui/gnomeui-docs.sgml,
2164 examples/gnomeui/gnomeui-sections.txt,
2165 examples/gnomeui/gnomeui.types:
2166 s/gtkspell/gnome-spell/g
2168 1998-12-16 Damon Chaplin <DAChaplin@msn.com>
2170 * gtkdoc-mkdb (ExpandAbbreviations): Allow -ve contants, e.g. %-1.
2171 (ScanSourceFile): Try to handle function descriptions that start
2172 with 'Returns'. It was assuming that they were describing the return
2174 Gets rid of 'Description:' which is sometimes included
2175 at the start of the function description in the source comment blocks.
2176 Makes sure newlines are preserved in the description, as consecutive
2177 newlines are converted to paragraph separators later.
2179 1998-12-15 Damon Chaplin <DAChaplin@msn.com>
2180 * Major changes to the scripts to merge in comments within source code
2181 * gtk-doc-fixxref added
2182 * examples directory added with an example for setting up modules to
2184 * documentation updated
2187 1998-11-28 Damon Chaplin <DAChaplin@msn.com>
2192 * gtkdoc-mkdb: Major changes to make it easy to update the docs
2193 when the API changes. It's pretty much all automatic now.
2194 Also added licenses and function comments, and added 'use strict'.
2195 The Gnome widgets should now be visible in the hierarchy.
2196 Removed a few 'mkdir's which I don't think are necessary now.
2198 Tue Nov 24 16:32:23 1998 Owen Taylor <otaylor@redhat.com>
2200 * README doc/authors.txt: Updated to describe the
2201 new generic scripts instead of the old ones hard-coded
2204 Tue Nov 24 01:06:17 1998 Owen Taylor <otaylor@redhat.com>
2206 * .cvsignore: Added .cvsignore
2208 Tue Nov 24 01:03:47 1998 Owen Taylor <otaylor@redhat.com>
2210 * autogen.sh configure.in: Minor touchups so the newly
2211 imported stuff autogen's correctly.