1 2007-08-02 Stefan Kost <ensonic@users.sf.net>
3 patch by: David Nečas <yeti@physics.muni.cz>
8 Allow rebasing crossreferences in generated docs. Fixes #434134.
10 2007-08-02 Stefan Kost <ensonic@users.sf.net>
13 Add a hack to gtkdoc-mkhtml to run uninstalled too.
15 2007-08-02 Stefan Kost <ensonic@users.sf.net>
17 Patch by: David Nečas <yeti@physics.muni.cz>
20 Generate ONLINE tag in index.sgml.
23 Allow to base links against online versions of xreffed docs.
27 Add releaseinfo to doctemplates.
29 * tests/bugs/docs/tester-docs.sgml:
30 * tests/gobject/docs/tester-docs.sgml:
33 2007-08-02 Stefan Kost <ensonic@users.sf.net>
35 * tests/bugs/docs/Makefile.am:
36 * tests/gobject/docs/Makefile.am:
38 Use PERL5LIB envvar to use uninstalled gtkdoc-common.pl for tests.
39 Use tee to both show and redirect logs.
40 Build test-docs in check-local instead of all-local.
43 2007-07-25 Stefan Kost <ensonic@users.sf.net>
47 Some more debug prints and code cleaning.
49 2007-07-23 Stefan Kost <ensonic@users.sf.net>
51 Patch by: Yeti <yeti@physics.muni.cz>
55 Report undeclared symbols into a file. Fixes #436565.
57 2007-07-18 Stefan Kost <ensonic@users.sf.net>
60 Readd two debug prints and remove one obsolete one.
62 * tests/bugs/Makefile.am:
63 * tests/gobject/Makefile.am:
64 Enforce 'make clean' before 'make check'.
66 2007-07-18 Stefan Kost <ensonic@users.sf.net>
68 Patch by: Yeti <yeti@physics.muni.cz>
71 Cleanup broek-return handling and add ignore_broken_returns for
72 section docs. Fixes #457077
74 * tests/bugs/docs/Makefile.in:
75 * tests/gobject/docs/Makefile.in:
79 Use the local tools so that 'make check' works uninstalled.
82 2007-07-18 Stefan Kost <ensonic@users.sf.net>
84 * tests/bugs/docs/tester-sections.txt:
85 * tests/bugs/src/tester.c: (bug_419997):
86 * tests/bugs/src/tester.h:
87 * tests/gobject/src/tester.c: (gtkdoc_tester_class_init):
88 * tests/gobject/src/tester.h:
91 2007-07-17 Stefan Kost <ensonic@users.sf.net>
93 * tests/bugs/docs/Makefile.in:
94 * tests/bugs/docs/tester-sections.txt:
95 * tests/bugs/src/tester.c: (bug_141869_a), (bug_141869_b),
96 (bug_379466), (bug_445693):
97 * tests/bugs/src/tester.h:
99 * tests/gtkdoctest.sh:
102 2007-07-17 Stefan Kost <ensonic@users.sf.net>
104 Patch by: Yeti <yeti@physics.muni.cz>
106 * gtkdoc-common.pl.in:
110 Improve paramenter parsing to allow parameter names that contain
111 const or restricted. Fixes #419997
112 Also fix the signed/unsigned more.
114 2007-07-17 Stefan Kost <ensonic@users.sf.net>
121 * tests/bugs/Makefile.am:
122 * tests/bugs/docs/Makefile.am:
123 * tests/bugs/docs/Makefile.in:
124 * tests/bugs/docs/tester-docs.sgml:
125 * tests/bugs/docs/tester-sections.txt:
126 * tests/bugs/docs/tester.types:
127 * tests/bugs/src/Makefile.am:
128 * tests/bugs/src/tester.c: (bug_445693), (bug_141869_a),
130 * tests/bugs/src/tester.h:
132 * tests/gobject/Makefile.am:
133 * tests/gobject/docs/Makefile.am:
134 * tests/gobject/docs/Makefile.in:
135 * tests/gobject/docs/tester-docs.sgml:
136 * tests/gobject/docs/tester-sections.txt:
137 * tests/gobject/docs/tester.types:
138 * tests/gobject/src/Makefile.am:
139 * tests/gobject/src/tester.c: (gtkdoc_tester_new),
140 (gtkdoc_tester_get_property), (gtkdoc_tester_set_property),
141 (gtkdoc_tester_class_init), (gtkdoc_tester_get_type):
142 * tests/gobject/src/tester.h:
143 * tests/gtk-doc.make:
144 * tests/gtkdoctest.sh:
145 Add test-suite. Fixes #457173
147 2007-07-16 Stefan Kost <ensonic@users.sf.net>
149 Patch by: Yeti <yeti@physics.muni.cz>
152 Avoid useless $return_start access.
154 2007-07-16 Stefan Kost <ensonic@users.sf.net>
156 Patch by: Petteri Räty <betelgeuse@gentoo.org>
159 Make gtk-doc.m4 fail when needed gtk-doc is not installed and notify
160 user. Fixes #323938 and #450338.
162 2007-07-15 Stefan Kost <ensonic@users.sf.net>
166 Handle signed/unsigned without int. Fixes #141869.
168 2007-07-15 Stefan Kost <ensonic@users.sf.net>
170 Patch by: Yeti <yeti@physics.muni.cz>
173 Improve handling of legacy "return" statement doc parsing. Warn about
176 2007-07-15 Stefan Kost <ensonic@users.sf.net>
179 Fix perl warning about usage of undefined symbol.
181 2007-07-15 Stefan Kost <ensonic@users.sf.net>
185 Sync the function decl arg parsing. Fixes #419308.
187 2007-07-15 Stefan Kost <ensonic@users.sf.net>
190 Improve the ---help output a little.
192 2007-07-15 Stefan Kost <ensonic@users.sf.net>
195 Improve detection of absolute/relatives paths. Skip duplicate paths.
198 2007-06-14 Lo�c Minier <lool@dooz.org>
201 Cleanup $(DOC_MODULE)-undocumented.txt files in
202 maintainer-clean-local. Fixes #415388.
204 2007-06-14 Lo�c Minier <lool@dooz.org>
207 Fix warnings in m4 macros when running "autoreconf -fi -Wall";
208 Guillem Jover. Fixes #428596.
210 2007-06-11 Damon Chaplin <damon@gnome.org>
212 * gtkdoc-mkdb.in (ExpandAbbreviations): just output "signal" and
213 "property" as the text for cross-reference links to signals and
214 properties, rather than something like "Object::signal" which can get
215 a bit long. Also tidied up the code a little.
216 (GetArgs): put the " inside the literal element.
217 (GetSignals): use a literal element for the signal name in the title,
218 to match the properties.
220 2007-03-16 Stefan Kost <ensonic@users.sf.net>
222 * gtkdoc-common.pl.in: handle preprocessor statements in enum and
223 struct declarations. Fixes #418027.
225 2007-02-27 Stefan Kost <ensonic@users.sf.net>
227 * gtk-doc.xsl: create toc for part and reference
229 * style.css: Fix placement of div.reference
231 2007-02-16 Damon Chaplin <damon@gnome.org>
235 2007-02-16 Damon Chaplin <damon@gnome.org>
237 * gtkdoc-scan.in: only rebuild the .types file automatically on the
238 very first run (i.e. when there are no sections or types files).
240 * gtkdoc-scangobj.in: skip gnome_keyring_item_info_get_type if it is
241 in the .types file as it isn't a real GObject type. This is a hack to
242 avoid breaking the GNOME build. See bug #386508.
244 2007-02-11 Stefan Kost <ensonic@users.sf.net>
246 * gtk-doc.xsl: fix prerequisite section in nav-header
248 2007-02-07 Stefan Kost <ensonic@users.sf.net>
250 * style.css: fixing footnote subscripts, make tables look nicer.
253 2007-02-07 Damon Chaplin <damon@gnome.org>
255 * gtk-doc.make: make $(DOC_MODULE)-sections.txt and
256 $(DOC_MODULE)-overrides.txt depend on scan-build.stamp, so that
257 parallel make works. #404122, Ed Catmur.
259 2007-02-07 Damon Chaplin <damon@gnome.org>
261 * gtkdoc-scangobj.in: don't return if !G_TYPE_IS_OBJECT (object_type)
262 as that means interface properties don't get output. This was broken
263 by the patch for #348058.
265 2007-01-21 Damon Chaplin <damon@gnome.org>
267 * gtkdoc-mkdb.in: added "--default-includes" option to specify the
268 default "#include"s to place at the top of the synopsis of each
269 section. Normally this is specified in a <INCLUDE>...</INCLUDE> line
270 in MODULE-sections.txt, but if you are using the "--rebuild-sections"
271 option to automatically rebuild the MODULE-sections.txt file you can't
274 2007-01-21 Damon Chaplin <damon@gnome.org>
276 * gtkdoc-mktmpl.in (ReadTemplateFile):
277 * gtkdoc-mkdb.in (ReadTemplateFile): improved param regexp to handle
278 weird macro vararg names like "format...". #398971.
280 2007-01-16 Damon Chaplin <damon@gnome.org>
282 * gtkdoc-mkdb.in: support "Include" setting in section docs in source
283 code, same as <INCLUDE>...</INCLUDE> setting in sections.txt file.
286 2007-01-16 Damon Chaplin <damon@gnome.org>
288 * gtkdoc-mkdb.in (OutputMacro): try to line up multiple lines of
289 arguments if possible. #384249
291 2007-01-16 Damon Chaplin <damon@gnome.org>
293 * gtkdoc-scan.in (ScanHeader): for headers marked private, return
294 immediately so we don't add anything to the sections file. #395005.
296 2007-01-16 Damon Chaplin <damon@gnome.org>
298 * gtkdoc-mkdb.in: a number of changes to help when adding example code
299 to the docs (#368382):
301 a) Support CDATA in source code comments. (We don't touch anything in
303 b) Support |[ ... ]| to include example code. (Just gets converted to
304 <informalexample><programlisting>)
305 c) Improve <programlisting> handling, by not inserting <para></para>
306 and not expanding "()", "@" or "%". (It still expands '#' so people
307 can use cross-references to any symbols if they want to.).
308 d) Improve '#' links a bit by skipping symbols that look like C
309 preprocessor directives (e.g. "#include").
310 e) Improve '&' handling a bit by converting to '&' if it doesn't
311 already look like the start of an entity reference.
312 f) Added special case for "#include <xxxx>" in <programlisting> so the
313 "<" and ">" get replaced by entities.
315 * gtkdoc-mktmpl.in (ReadTemplateFile):
316 * gtkdoc-mkdb.in (ReadTemplateFile): fixed param regexp so it handles
317 "@...:" for varargs again. It also cleans up messed up template files
320 2007-01-04 Damon Chaplin <damon@gnome.org>
322 * gtk-doc.make (dist-hook): abort dist if html docs aren't generated.
323 #166462, Gustavo Carneiro.
325 2007-01-03 Damon Chaplin <damon@gnome.org>
327 * gtkdoc-mkdb.in: improved output a little - made field widths larger,
328 removed signal prototypes from synopsis, and capitalized all signal
329 flags (to be consistent with argument capitalization). #384247,
332 2007-01-03 Damon Chaplin <damon@gnome.org>
334 * gtkdoc-mktmpl.in (OutputDeclaration):
335 * gtkdoc-mkdb.in (OutputFunction): fix parsing of "char * const"
336 arguments, with an extra "\s*". #387681
338 2007-01-03 Damon Chaplin <damon@gnome.org>
341 * xmldocs.make: updated to new versions from gnome-common. #363622
342 Also reverted the changes made for #316508 since they may cause
343 problems. We'll let the scrollkeeper/gnome-common/autoconf people
346 2006-12-07 Ross Burton <ross@burtonini.com>
348 * help/manual/C/gtk-doc-manual.xml:
349 Add examples of how to document structs, properties and signals
352 2006-12-04 Damon Chaplin <damon@gnome.org>
354 * gtkdoc-scangobj.in: added a '--query-child-properties' argument to
355 allow you to specify a function to return a list of child properties
356 for a class (similar to GtkContainer child properties). #379203
358 2006-10-16 Damon Chaplin <damon@gnome.org>
360 * gtkdoc-scangobj.in: remove a shadow declaration to avoid compiler
363 2006-10-15 Damon Chaplin <damon@gnome.org>
365 * gtkdoc-scan.in: added a '--rebuild-sections' option that will
366 automatically recreate the MODULE-sections.txt file each time.
367 (This only works for projects with very neat header files.) #310494.
369 2006-10-15 Damon Chaplin <damon@gnome.org>
371 Bug #338517: Automatically creating/updating .types file:
373 * gtkdoc-scan.in: added a '--rebuild-types' option which will
374 automatically update the .types file using all _get_type() functions
375 found in the headers. (It will also do this if no .types file is found,
376 i.e. when gtk-doc is first run on a project.)
378 * gtk-doc.make (scan-build.stamp): run gtkdoc-scan before
379 gtkdoc-scangobj so we can use the generated .types file.
381 * gtkdoc-scangobj.in: if the .types file doesn't have any #include
382 directives, just output "extern GType *get_type();" declarations for
383 each *_get_type() function.
385 2006-10-14 Damon Chaplin <damon@gnome.org>
387 * gtkdoc-mkdb.in (ExpandAbbreviationsExceptCDATA): new function used
388 to expand abbreviations in extra files, but leaving CDATA sections
389 as they are. (#360579)
391 2006-10-14 Damon Chaplin <damon@gnome.org>
393 * gtkdoc-mkdb.in (OutputSGML): Allow the section id to be set from
394 within the source code "SECTION:" comment block. (#349855)
396 2006-10-13 Damon Chaplin <damon@gnome.org>
398 * style.css: added missing comma from previous fix (#360967).
400 2006-10-13 Damon Chaplin <damon@gnome.org>
402 * gtkdoc-mkdb.in (OutputSymbolTraits): new function to output the
403 "Since" and "Stability Level:" paragraphs, with roles to allow
404 XSLT styling. (#348046)
406 2006-10-13 Damon Chaplin <damon@gnome.org>
408 * gtkdoc-scangobj.in: support interfaces on non-GObject types.
409 (#348058, Josh Parsons).
411 2006-10-13 Damon Chaplin <damon@gnome.org>
413 * gtkdoc-scangobj.in: make sure interfaces are initialized so the
414 signals query works. (#355352)
416 2006-10-13 Damon Chaplin <damon@gnome.org>
418 * style.css: Make sure appendix title isn't obscured by navigation bar
419 (#360967, Philip Kovacs).
421 2006-09-09 Matthias Clasen <mclasen@redhat.com>
423 * gtkdoc-scangobj.in (get_type_name): Don't set is_pointer
424 to TRUE for enum and flags types. (#354880, Yevgen Muntyan)
426 2006-07-29 Damon Chaplin <damon@gnome.org>
430 2006-06-30 Damon Chaplin <damon@gnome.org>
432 * gtkdoc-mkdb.in (ScanSourceFile): fix regexp to allow section names
435 * gtk-doc.make (all-local, docs): added separate 'docs' target that can
436 be used even when the '--disable-gtk-doc' configure option is used.
438 2006-06-15 Jody Goldberg <jody@gnome.org>
440 * gtkdoc-mkdb.in (OutputFunction) : finish off #341872
441 Support 'T const * const *foo' and other more complex types.
442 Support ptr2ptr2func as a func argument.
443 'void foo (void (**func) (void))'
444 * gtkdoc-mktmpl.in : ditto.
446 (committed by Damon with minor changes to spacing so GTK+ docs are
449 2006-06-09 Damon Chaplin <damon@gnome.org>
452 * gtk-doc.xsl: use the 'role' attribute rather than the 'id' attribute
453 to identify the different sections for the navigation bar, since 'id'
454 must be unique throughout the entire document. Also fixed a few minor
455 issues with the output. (#342861, Leonardo Boshell)
457 2006-05-30 Damon Chaplin <damon@gnome.org>
459 * gtkdoc-fixxref.in (FixHTMLFile): Use the 's' modifier to the
460 substitution so we handle links spanning more than one line.
463 2006-05-22 Damon Chaplin <damon@gnome.org>
468 * help/manual/Makefile.am: use a separate Makefile.am for each
469 subdirectory rather than using "SUBDIRS=help/manual/C".
471 2006-05-21 Jody Goldberg <jody@gnome.org>
473 * gtkdoc-common.pl.in (ParseStructDeclaration) : Support
474 'long double foo' and
475 'T const * const *foo' (#341872)
476 * gtkdoc-mktmpl.in (OutputDeclaration) : handle ptrs to ptrs to
477 functions 'void func (void (**ptr2ptr2func)(int a))'
479 2006-05-21 Damon Chaplin <damon@gnome.org>
481 * gtkdoc-mkdb.in (ScanSourceFile): don't check basename for '.[hc]'
482 suffix since we allow other suffixes as well now. (#340199)
484 * gtkdoc-mktmpl.in (OutputSignalTemplates): check if the parameter
485 is actually in the source code comment block. If not, use the default
486 name. Otherwise we were outputting an empty "@:" in the templates.
487 (ReadTemplateFile): remove empty "@:" lines caused by above bug.
489 2006-04-15 Damon Chaplin <damon@gnome.org>
491 * xmldocs.make: use gtkdochelpdir rather than docdir to avoid clash
492 with autoconf. (#316508)
494 * tools/gtk-doc.el: Output "Returns:" rather than "Return value:",
495 and a "C-x4s" binding for inserting a blank section header.
497 * gtk-doc.make (sgml-build.stamp): added $(DOC_MODULE)-sections.txt
498 to the dependencies, since although the templates depend on it, they
499 may not be changed, but the XML should still be rebuilt.
501 * gtkdoc-mkdb.in (ScanSourceFile): allow whitespace after "SECTION:".
503 2006-04-13 Damon Chaplin <damon@gnome.org>
505 * gtkdoc-mkdb.in (ReadArgsFile): When outputting a warning about a
506 property, use a single colon ':', since that is what is used to
507 document properties in the source code. (2 colons are used for signals)
509 * gtk-doc.make (sgml-build.stamp): added $(HFILE_GLOB) here, to
510 catch any new documentation in the headers.
512 2006-04-12 Damon Chaplin <damon@gnome.org>
514 * gtkdoc-mkdb.in (tagify2): strip special "-struct" suffix from
515 text of links to widget structs.
517 2006-04-09 Stefan Kost <ensonic@users.sf.net>
520 fix link after live.gnome.org wiki changes
522 2006-04-09 Damon Chaplin <damon@gnome.org>
526 2006-03-29 Stefan Kost <ensonic@users.sf.net>
528 * gtkdoc-scangobj.in:
529 missing '*' for arg in signal prototype in docs (#335486)
531 2006-03-26 Damon Chaplin <damon@gnome.org>
533 * gtkdoc-mkdb.in (MergeSourceDocumentation): don't output warnings
534 for overridden titles, since that happens a lot. (#320010)
536 * configure.in: check for pkg-config >= 0.19.
538 * Makefile.am (pkgconfigdir): put the .pc file in $(datadir) rather
539 than $(libdir), since gtk-doc is architecture-independant. (#120950)
541 * configure.in: removed the hard dependancy on openjade or jade, since
542 XML is used mostly now rather than SGML. We just output a warning
543 rather than an error if neither openjade or jade are found.
545 2006-03-21 Stefan Kost <ensonic@users.sf.net>
548 add sect1 to pages with top-page offset adjustment (#166363)
550 2006-03-19 Damon Chaplin <damon@gnome.org>
552 * gtkdoc-scan.in (ScanHeader): try to handle the start of function
553 declarations spread over 3 lines. (#321708, Jorn Baayen)
555 2006-03-19 Damon Chaplin <damon@gnome.org>
557 (OutputOldParams): don't bother outputting unused parameters if they
558 don't have any documentation as that is pointless.
560 2006-03-19 Damon Chaplin <damon@gnome.org>
562 * gtkdoc-mktmpl.in (ReadTemplateFile): Add a workaround for an old
563 bug handling macros with arguments spread over several lines. (#318666)
565 2006-03-19 Damon Chaplin <damon@gnome.org>
567 * gtkdoc-mkdb.in (MakeIndexterms): Make sure we still output an index
568 term if there isn't 'deprecated' or 'since' info.
569 (#334851, Tommi Komulainen).
571 2006-03-19 Damon Chaplin <damon@gnome.org>
573 * gtkdoc-scan.in (ScanHeader): added "--ignore-decorators" option to
574 ignore a list of declarators in function declarations.
575 (#316512, Bertram Felgenhauer).
577 2006-03-19 Damon Chaplin <damon@gnome.org>
579 * gtkdoc-mkdb.in (GetSignals, GetArgs): call MakeIndexTerms() to make
580 sure that signals appear in the deprecated/new symbol indices.
581 (#332007, Tommi Komulainen).
583 2006-03-19 Damon Chaplin <damon@gnome.org>
585 * gtkdoc-mkdb.in (OutputEnum, ExpandAbbreviations, symbolify):
586 allow use of '#Object::signal' and '#Object:property' to link to
587 signals and properties, and add links to enum constant values.
588 (#332483, Stefan Kost)
590 2006-03-15 Matthias Clasen <mclasen@redhat.com>
592 * gtkdoc-mkdb.in (MakeIndexterms): Create separate indexterms
593 for different roles, since the docbook stylesheets don't handle
594 multiple roles in one attribute. (#331586, Tommi Komulainen)
596 2006-03-07 Damon Chaplin <damon@gnome.org>
600 2006-03-06 Tommi Komulainen <tommi.komulainen@nokia.com>
602 * gtkdoc-scan.in (ScanHeader): Print object name after <TITLE> in
603 order to get get object hierarchy, signals and properties
604 documentation appear automatically (#333380)
606 2006-01-24 Stefan Kost <ensonic@users.sf.net>
608 * gtkdoc-mkdb.in: patch from Damon Chaplin to fix signal flag parsing
610 2006-01-08 Damon Chaplin <damon@gnome.org>
612 * gtkdoc-mkdb.in: patch from Jonathan Blandford to add support for a
613 "--source-suffixes" option so you can scan files with any suffixes
614 you want (e.g. C++ files).
616 2005-12-19 Matthias Clasen <mclasen@redhat.com>
618 * gtkdoc-mktmpl.in: Use \w+: instead of \S+: when
619 matching parameter names, so that @Deprecated:2.10:
620 works in template files like in source code comments.
622 * gtkdoc-mkdb.in: Add a missing "and" to the versioned
625 2005-12-09 Stefan Kost <ensonic@users.sf.net>
628 try more to downgrade devhelp for old file format
630 2005-12-09 Stefan Kost <ensonic@users.sf.net>
635 create a autoregen.sh
639 generate two separate versions
641 fix parsing const after type (#322556)
643 fix parseing multiline macro heads (#320588)
644 * gtkdoc-scangobj.in:
645 allow additional root types (#323581)
647 2005-12-05 Matthias Clasen <mclasen@redhat.com>
649 * gtkdoc-mktmpl.in (OutputDeclaration):
650 * gtkdoc-mkdb.in (OutputFunction): Allow parameters to be declared
651 volatile (this happens in GLib nowadays)
653 2005-10-11 Stefan Kost <ensonic@users.sf.net>
656 remove left-over debug-print
658 2005-10-10 Stefan Kost <ensonic@users.sf.net>
662 enhance gtkdoc devhelp output (#318129)
664 2005-10-05 Stefan Kost <ensonic@users.sf.net>
666 * gtkdoc-common.pl.in:
667 revert exchanging with  
669 2005-10-04 Damon Chaplin <damon@gnome.org>
671 * gtkdoc-scanobj.in: patch from Andrae Steiner to add missing ';'
674 2005-09-29 Stefan Kost <ensonic@users.sf.net>
677 additionally point people to the gnome-wiki
680 don't warn on macros with return docs (#314267)
682 2005-09-28 Matthias Clasen <mclasen@redhat.com>
684 Show signal flags: (#316789)
686 * gtkdoc-scangobj.in: Emit flags for signals
687 as <FLAGS> element in $MODULE.signals
689 * gtkdoc-mkdb.in: Emit signal flags similar
692 * gtkdoc-mktmpl.in: Handle <FLAGS> here, too.
694 2005-09-20 Stefan Kost <ensonic@users.sf.net>
699 * doc/sections-file.txt:
700 * doc/setting-up.txt:
701 * doc/style-guide.txt:
702 * gtkdoc-common.pl.in:
703 adding a note about where the new docs are
705 2005-09-15 Damon Chaplin <damon@gnome.org>
707 * gtkdoc-scan.in (ScanHeader):
708 * gtkdoc-mktmpl.in (OutputDeclaration):
709 * gtkdoc-mkdb.in (OutputFunction): patch from dodji seketeli to handle
710 functions returning explicit enums. (#303337)
712 Patch from Stepan Kasal:
714 * gtkdoc-mkhtml.in, gtkdoc-mkman.in, gtkdocize.in: Add datarootdir
715 variable, for compatibility with future Autoconf releases.
717 * configure.in (PACKAGE_DATA_DIR): Simplify the computation;
718 use a local macro AC_DEFINE_DIR, based on a macro from Autoconf
719 macro archive. (#313876)
721 2005-09-15 Damon Chaplin <damon@gnome.org>
723 * gtkdoc-scangobj.in: Patch from Stepan Kasal to avoid some gcc
727 * gtkdoc-scangobj.in: Use brackets around open() arguments to avoid
728 precedence problems. (#314838)
731 * gtkdoc-scangobj.in: Output more messages about compilation, linking
732 and running of scanner, to try to help track down any problems.
733 Also use "sh -c" to run the scanner (#167688)
736 * gtkdoc-scangobj.in: patch from Stefan Kost to improve error messages,
737 though I changed it slightly so it doesn't output errno.
739 2005-09-09 Damon Chaplin <damon@gnome.org>
743 * gtk-doc.xsl: Use a fixed navigation bar at the top of the page.
744 Patch from Stefan Kost with minor changes by me. (#313569)
746 2005-08-18 Damon Chaplin <damon@gnome.org>
748 * gtkdoc-scangobj.in: added "const" in a few places to avoid lots
749 of warnings if all gcc warnings are on. (#312985)
751 2005-08-15 Stefan Kost <ensonic@users.sf.net>
758 adding the infrastructure for installation of gtkdoc manual
760 2005-08-12 Stefan Kost <ensonic@users.sf.net>
763 fix warning about uninitialized var EXPAND_CONTENT_FILES
765 Tue Aug 9 12:01:27 2005 tjlocal <timj@imendio.com>
767 * autogen.sh: bail out with exit $? for failing programs.
769 2005-07-26 Damon Chaplin <damon@gnome.org>
771 * gtk-doc.make: Pass DOC_MAIN_SGML_FILE as the main filename to
772 gtkdoc-mkdb. Avoids creating spurious foo.sgml files in an XML build.
773 Patch from Malcolm Tredinnick. (#311344)
775 Prefix build messages with "gtk-doc: " rather than surrounding them
776 with "***" which looks like an error. (#170008)
778 2005-07-26 Damon Chaplin <damon@gnome.org>
780 * README: removed comment about not being able to add section
781 documentation to source code files, which is not true any more.
783 2005-07-03 Damon Chaplin <damon@gnome.org>
787 2005-06-20 Matthias Clasen <mclasen@redhat.com>
789 * gtkdoc-mkdb.in: Fix typos in warnings.
791 2005-06-17 Mikael Hallendal <micke@imendio.com>
793 * README: Updated Devhelp web address.
795 2005-05-16 Matthias Clasen <mclasen@redhat.com>
797 * gtkdoc-mkdb.in: Add "expand-content-files:s" to the GetOptions() call.
799 2005-05-10 Owen Taylor <otaylor@redhat.com>
801 * gtkdoc-mkdb.in: Add an --expand-content-files option
802 to specify extra files to expand abbreviations in and
803 copy into the output directory.
805 * gtk-doc.make examples/Makefile.am: Add expand_content_files
808 * gtkdoc-mktmpl.in (OutputTemplateFile): Add an
809 --only-section-tmpl flag so that projects that keep everything
810 but section descriptions inline can avoid cvs conflicts.
812 * gtk-doc.make examples/Makefile.am: Add support for
815 * configure.in: Up version to 1.4.
817 2005-05-02 Matthias Clasen <mclasen@redhat.com>
819 * gtkdoc-mkdb.in: Accept C comments between struct name
820 and struct definition. GObject has an instance of this.
822 2005-03-21 Matthias Clasen <mclasen@redhat.com>
824 * gtk-doc.dcl: Allow ':' in names. (#169087)
826 2005-03-21 James Henstridge <james@jamesh.id.au>
828 * gtk-doc.xsl (encoding): output US-ASCII instead of ISO-8859-1.
829 This ensures that the output will be display correctly when served
830 as either ISO-8859-1 or UTF-8.
832 2005-02-26 Sven Neumann <sven@gimp.org>
834 * gtkdoc-mkdb.in (MakeIndexterms): allow space in Since: keywords,
835 only strip leading and trailing whitespace (bug #168384).
837 2005-02-16 Damon Chaplin <damon@gnome.org>
839 * gtkdoc-mkdb.in (ScanSourceFile): add support for "@stability:"
840 in the inline section docs (Brian Cameron).
842 2005-02-07 Damon Chaplin <damon@gnome.org>
844 * gtkdoc-mkdb.in (MergeSourceDocumentation): allow use of "@...:" in
845 the source code as well as "@Varargs:". Patch from Benjamin Otte.
848 2005-02-04 Damon Chaplin <damon@gnome.org>
850 * gtkdoc-mkdb.in (ParseStabilityLevel): don't reset $stability if it
851 isn't Stable/Unstable/Private (Brian Cameron).
852 (ScanSourceFile): skip whitespace after "SECTION:".
854 2005-02-01 Damon Chaplin <damon@gnome.org>
856 * gtkdoc-mkdb.in (ScanSourceFile, MergeSourceDocumentation): patch
857 from Stefan Kost to support section documentation within the source
858 code (long description, short description, see also and title).
861 * gtkdoc-mktmpl.in: patch from Brian Cameron to support stability
864 * gtkdoc-mkdb.in (OutputFunction):
865 * gtkdoc-mktmpl.in (OutputDeclaration):
866 * gtkdoc-common.pl.in (ParseStructDeclaration): patch from Roger Leigh
867 to add support for the "restrict" keyword.
869 * gtkdoc-scan.in (ScanHeader): patch from Roger Leigh to add support
870 for "unsigned" to one of the regexps.
872 2005-01-31 Damon Chaplin <damon@gnome.org>
874 * gtk-doc.make (scan-build.stamp): added "2>&1" to grep command to
877 * gtkdoc-mkdb.in: patch from Stefan Kost to not add '<' '>' around
878 include files that already have '"' '"' around them, and to try to
879 gather more information about undocumented symbols. #164462.
881 2005-01-28 Damon Chaplin <damon@gnome.org>
883 * gtk-doc.make: use dist-hook rather than EXTRA_DIST to copy the
884 $(DOC_MODULE).types file over, so we can skip this if it doesn't exist.
887 2005-01-12 Damon Chaplin <damon@gnome.org>
889 * README: patch from Stefan Kost to mention GObject classes
890 and describe the transformation process to XML/SGML and HTML,
891 and to mention Devhelp.
893 2005-01-09 Damon Chaplin <damon@gnome.org>
897 2005-01-09 Damon Chaplin <damon@gnome.org>
899 * gtkdoc-mkdb.in (MergeSourceDocumentation): output better warnings
900 using the type information. Patch from Stefan Kost. #161979
902 * gtkdoc-scan.in (ScanHeader): support "typedef struct a *b;". Fixes
903 last part of #156318.
905 * gtkdoc-common.pl.in (ParseStructDeclaration): return an empty array
906 for forward struct declarations. Part of #156318.
909 * gtkdoc-mkdb.in: updated a few of the warnings to make them a bit
910 easier to understand.
912 2004-11-22 James Henstridge <james@jamesh.id.au>
914 * acconfig.h: remove file, since we don't have a config.h
916 * configure.in: make sure $ACLOCAL_FLAGS is passed to aclocal on a
919 * autogen.sh: use Automake-1.9 if available, and call aclocal,
920 autoconf, automake, etc in the same order as autoreconf does.
922 * gtkdocize.in: if the AC_CONFIG_MACRO_DIR option is used in the
923 configure script, copy gtk-doc.m4 to that directory in the source
926 2004-11-16 Damon Chaplin <damon@gnome.org>
928 * gtkdoc-mkdb.in (OutputFunction): output "const" rather than
929 "G_CONST_RETURN". #157674.
931 * gtkdoc-mktmpl.in (OutputDeclaration): skip "void" return types but
932 not if it has modifiers e.g. "void *". #156963.
934 * gtkdoc-scan.in (ScanHeader): handle __attribute__. Patch from
935 Simon Josefsson. #156962.
937 2004-10-31 Damon Chaplin <damon@gnome.org>
939 * gtkdoc-mkdb.in (OutputStruct): handle opaque/forward struct
940 declarations. #156318 again. Tiny fix to avoid warnings.
942 2004-10-28 Damon Chaplin <damon@gnome.org>
944 * gtkdoc-mktmpl.in (ReadDeclarationsFile):
945 * gtkdoc-mkdb.in (ReadDeclarationsFile):
946 * gtkdoc-scan.in (ScanHeader): handle opaque/forward struct
947 declarations. #156318.
949 2004-10-25 Damon Chaplin <damon@gnome.org>
951 * gtkdoc-mkdb.in (OutputParamDescriptions): use a after Returns:
952 so it doesn't break before the colon.
954 2004-10-24 Damon Chaplin <damon@gnome.org>
956 * gtkdoc-common.pl (ParseEnumDeclaration): handle "typedef enum XXX {"
957 #156297. Patch from Simon Josefsson.
959 2004-10-20 Damon Chaplin <damon@gnome.org>
961 * gtkdoc-mkdb.in (ReadDeclarationsFile): set a flag to indicate a
962 struct has a typedef declaration.
963 (OutputStruct): better output for structs with typedefs. #83269.
965 * gtkdoc-scan.in (ScanHeader): leave the struct declaration as it is.
966 Don't strip out 'typedef'. Also allow simple "struct foo {".
968 2004-10-19 Damon Chaplin <damon@gnome.org>
970 * gtkdoc-fixxref.in: use pkg-config to find where GLib is installed
971 and scan that directory for index files. Also scan $GNOME2_PATH.
972 These are only used as a last resort. If they are used we have to
973 output links as absolute URLs, rather than the default relative ones.
975 2004-10-18 Damon Chaplin <damon@gnome.org>
977 * gtkdoc-common.pl.in (ParseStructDeclaration): support function
978 pointers that return "foo const *" #141870.
980 * gtkdoc-scan.in (ScanHeader):
981 * gtkdoc-mkdb.in (OutputFunction):
982 * gtkdoc-mktmpl.in (OutputDeclaration): handle functions with const
983 or struct return types. #141870 and #148507.
985 2004-10-15 Damon Chaplin <damon@gnome.org>
987 * gtkdoc-common.pl.in (ParseStructDeclaration)
988 (ParseEnumDeclaration): moved these here, rather than have 2 copies
989 in gtkdoc-mkdb.in and gtkdoc-mktmpl.in.
991 * gtkdoc-common.pl.in (ParseStructDeclaration): handle struct fields
992 better. We can now handle things like *foo, ***bar, *baz[12][23],
993 foo : 25 all on one line. Fixes part of #151219.
994 Also support the 'short' modifier to fix #90565.
995 And use $nbsp; rather than spaces to try to avoid splitting
996 declarations in the output.
997 Also take an extra arg specifying whether to include parameters in
998 the function pointer fields.
1000 * gtkdoc-scan.in (ScanHeader): Deal with array types in typedefs.
1001 (Eg, "typedef unsigned char MD5Digest[16];") From Dan Winship.
1002 Last bit of #151219.
1004 2004-10-14 Damon Chaplin <damon@gnome.org>
1006 * gtkdoc-mkdb.in (CreateValidSGMLID): use ":CAPS" rather than
1007 "-CAPS" to distinguish all-caps identifiers, to avoid clashing with
1008 identifiers ending in _caps! Bug #113120.
1010 * gtkdoc-mkdb.in (MergeSourceDocumentation): if it looks like a
1011 parameter has been described, but not in the right place, output
1012 a better error message. Bug #141871.
1014 * gtkdoc-mkdb.in (OutputMacro, OutputFunction, GetSignals): allow
1015 the author to use <!--PARAMETERS--> to specify the position of the
1016 parameter table if they want. Hopefully good enough for bug #99567.
1017 (MergeSourceDocumentation): end the paragraph before <!--PARAMETERS-->
1018 and start a new one after it.
1020 * doc/authors.txt: document <!--PARAMETERS-->.
1022 * style.css: don't underline links normally, as we output lots of
1023 them and it makes it very cluttered. Only underline links when the
1024 mouse hovers over them, and change the color. Fixes #108037.
1026 * gtk-doc.make (scan-build.stamp): depend on $(CFILE_GLOB) as well,
1027 since changes in properties need to be picked up by gtkdoc-scangobj.
1030 * gtkdoc-mkdb.in: (ParseStructDeclaration): for fields that are
1031 function pointers, only return the function name, as otherwise the
1032 output gets really messy. Fixes #66618.
1037 * gtkdoc-scanobj.in:
1038 * gtkdoc-scangobj.in: use '@PACKAGE_DATA_DIR@' instead of
1039 "@PACKAGE_DATA_DIR@" so that it isn't interpolated. It failed when
1040 $prefix was /software/@sys/usr. Fixes #113456.
1042 2004-10-13 Damon Chaplin <damon@gnome.org>
1044 * gtkdoc-scanobj.in:
1045 * gtkdoc-scangobj.in: patch from Olexiy Avramchenko to add 3 new
1048 * gtkdoc-scanobj.in:
1049 * gtkdoc-scangobj.in: patch from Benjamin Otte to get rid of
1050 -Wsign-compare warnings. Bug #137013.
1052 Fri Sep 17 01:13:24 2004 Matthias Clasen <maclas@gmx.de>
1054 * gtk-doc.xsl: Add the images from the gallery on top
1055 of the refentry they point to.
1057 * style.css: Move the css bits of the gallery implementation
1060 Fri Sep 17 00:30:16 2004 Matthias Clasen <maclas@gmx.de>
1062 * gtk-doc.xsl: Don't generate <link rel="refentry">
1063 links, since e.g. the GTK+ docs contain MANY refentries.
1065 2004-09-10 Damon Chaplin <damon@gnome.org>
1067 * autogen.sh: support automake 1.8. (part of #151219).
1069 * examples/Makefile.am: require automake 1.6.
1071 * gtkdoc-scan.in: create an empty MODULE-overrides.txt file if it
1072 doesn't exist. gtkdoc.make expects one to exist.
1074 * doc/setting-up.txt: updated to document new procedure using
1077 * examples/Makefile.am: updated to use gtkdoc.make.
1079 * examples/configure.in: removed this. gtkdoc.make is used instead
1082 * examples/README: updated.
1084 * Makefile.am (EXTRA_DIST): removed examples/configure.in.
1086 Wed Sep 8 01:12:25 2004 Matthias Clasen <maclas@gmx.de>
1088 * gtkdoc-scan.in (ScanHeader):
1089 * gtkdoc-mktmpl.in (OutputDeclaration):
1090 * gtkdoc-mkdb.in (OutputFunction): Accept mixtures of *
1091 and const in return types.
1093 Wed Sep 01 05:58:08 2004 Matthias Clasen <maclas@gmx.de>
1095 * gtkdoc-mkdb.in: Remove a debug printf
1097 Tue Aug 24 02:30:08 2004 Matthias Clasen <maclas@gmx.de>
1099 * gtk-doc.xsl: Add support for a gallery of widget images.
1101 Wed Jul 28 13:00:54 2004 Jonathan Blandford <jrb@gnome.org>
1103 * gtk-doc.xsl: remove the examples from the toc.
1105 2004-07-28 Damon Chaplin <damon@gnome.org>
1107 * doc/sections-file.txt: mention use of '#' for comments.
1109 * gtkdoc-mkdb.in: removed HEADER_FILE stuff, since it isn't used now.
1111 2004-07-23 Damon Chaplin <damon@gnome.org>
1113 * examples/Makefile.am (all-local): add empty all-local target for
1114 when ENABLE_GTK_DOC is false. (#148209, Martin Quinson)
1116 Fri Jul 23 13:21:34 2004 Matthias Clasen <maclas@gmx.de>
1118 * gtkdoc-mkdb.in (ScanSourceFile): Fix regexps for matching
1119 ignored files. (#148211, Martin Quinson)
1121 2004-07-03 Matthias Clasen <mclasen@redhat.com>
1123 * style.css: Add a missing '}' and align arguments to the
1124 top of their descriptions. (#145363, #145364, Mariano
1127 2004-05-18 Matthias Clasen <mclasen@redhat.com>
1129 * gtk-doc.xsl: Let the docbook stylesheets generate
1130 extra <link rel=...> elements. (#140221, Geert Stappers)
1132 2004-05-10 Geert Stappers <stappers@stappers.nl>
1134 * TODO: new file, basicly a reference to bugzilla.
1136 * examples/README: tell about gtk-doc.make.
1138 2004-05-06 Geert Stappers <stappers@stappers.nl>
1140 * MAINTAINERS: Add myself.
1142 2004-05-05 Matthias Clasen <mclasen@redhat.com>
1144 * gtk-doc.xsl: Correct the docbook stylesheet version
1145 in which filtered index support will appear to 1.66.
1147 2004-04-27 Geert Stappers <stappers@stappers.nl>
1149 * README: Updated the information on Debian packages.
1150 Removed old author and time stamp line.
1152 2004-04-21 Matthias Clasen <mclasen@redhat.com>
1154 * doc/sections-file.txt: Add hint about private types.
1158 * MAINTAINERS: Add myself.
1160 * gtkdoc-mkdb.in (ReadKnownSymbols): New function which
1161 extracts information about public and private symbols from
1162 the $MODULE-sections.txt file.
1163 (ReadObjectHierarchy): Prune the tree, based on the information
1164 collected by ReadKnownSymbols.
1165 (ReadInterfaces): Also filter out private interfaces here
1166 (ReadPrerequisites): ...and here.
1168 2004-04-19 Matthias Clasen <mclasen@redhat.com>
1170 * Makefile.am: Add version-greater-or-equal.xsl.
1172 * version-greater-or-equal.xsl: New file, implementing
1173 the version-greater-or-equal template for comparing version
1176 * gtk-doc.xsl: Import version-greater-or-equal.xsl and
1177 use the version-greater-or-equal template to a) check that
1178 the xsl stylesheets are not too old and b) to avoid creating
1179 multiple indices if the xsl stylesheets don't support filtered
1182 * gtkdoc-mkdb.in (MakeIndexterms): Emit role attributes
1183 on indexterms which can be used to create filtered indices
1184 with sufficiently new xsl stylesheets. The required functionality
1185 will appear in version 1.62 of the xsl stylesheets. (#115530)
1187 2004-04-16 Matthias Clasen <mclasen@redhat.com>
1189 * style.css: Style information in a separate stylesheet.
1191 * gtkdoc-mkhtml.in: Copy css files.
1193 * Makefile.am (gtkdocdata_DATA): Add style.css
1195 * gtk-doc.xsl: Use a stylesheet instead of hardwiring
1196 styles. (#134683, Vincent Torri)
1198 * gtkdoc-mkdb.in (GetSignals): Organize the properties
1199 descriptions to fit better with the other sections, and
1200 also display information about allowed and default values.
1202 2004-04-15 Matthias Clasen <mclasen@redhat.com>
1204 * gtkdoc-scangobj.in: Use introspection more fully to emit
1205 allowed ranges for integral types and default values.
1207 * gtkdoc-mkdb.in (GetSignals): Handle missing signal parameter
1210 2004-03-04 Damon Chaplin <damon@gnome.org>
1212 * autogen.sh: fixed URLs to download autoconf/automake/libtool.
1213 Patch from Frederic L. W. Meunier.
1215 2004-02-16 Damon Chaplin <damon@gnome.org>
1217 * .cvsignore: added gtk-doc.cat and gtkdocize.
1219 2004-02-16 Damon Chaplin <damon@gnome.org>
1223 2004-02-16 Damon Chaplin <damon@gnome.org>
1225 * gtk-doc.cat.in: removed public ID for gtk-doc.dtd, since we don't
1228 Sat Feb 14 02:14:27 2004 Matthias Clasen <maclas@gmx.de>
1230 * gtk-doc.m4: Avoid unnecessary checks if gtk-doc is
1231 disabled. (#134221, Julio M. Merino Vidal)
1233 Sat Feb 14 02:03:01 2004 Matthias Clasen <maclas@gmx.de>
1235 * gtk-doc.make: Don't create unneeded empty
1236 directories. (#134319, Julio M. Merino Vidal)
1238 Sat Feb 14 01:37:38 2004 Matthias Clasen <maclas@gmx.de>
1240 * gtk-doc.make: Add an empty all-local target to make it work
1241 with non-GNU make. (#134343, Julio M. Merino Vidal)
1243 Wed Jan 28 00:52:00 2004 Matthias Clasen <maclas@gmx.de>
1245 * gtkdoc-mkdb.in (OutputObjectList): Avoid emitting invalid
1246 docbook markup if there are no objects. Partial fix for #132661.
1248 Sun Jan 25 22:01:15 2004 Matthias Clasen <maclas@gmx.de>
1250 * gtkdoc-mkdb.in: Accept both the old and the new XInclude
1251 namespace. (#131675, Edd Dumbill)
1253 2004-01-23 Thomas Vander Stichele <thomas at apestaart dot org>
1255 * gtkdoc-mkhtml.in: exit when tools return non-zero so errors can
1258 Thu Jan 15 23:06:10 2004 Matthias Clasen <maclas@gmx.de>
1260 * gtk-doc.xsl: Set the chunk.fast parameter, to gain some
1263 Thu Jan 15 23:05:23 2004 Matthias Clasen <maclas@gmx.de>
1265 * gtkdoc-fixxref.in: Make it work again without explicit
1268 Sat Dec 27 01:36:08 2003 Matthias Clasen <maclas@gmx.de>
1270 * gtkdoc-scangobj.in:
1273 * gtkdoc-fixxref.in: Add --help. (#126915)
1275 Sat Dec 27 00:43:42 2003 Matthias Clasen <maclas@gmx.de>
1277 * gtkdoc-mkdb.in (ParseEnumDeclaration):
1278 * gtkdoc-mktmpl.in (ParseEnumDeclaration): Support a trailing ,
1279 in enum declarations. These are a GNU C extension, but also
1280 blessed by C99. (#129949, Thomas Vander Stichele)
1282 Sun Nov 16 00:29:03 2003 Matthias Clasen <maclas@gmx.de>
1284 * gtkdoc-scangobj.in: Don't use g_strdown(). (#127028,
1287 Sun Nov 16 00:26:05 2003 Matthias Clasen <maclas@gmx.de>
1289 * gtkdoc-scangobj.in: If compiled against GLib >= 2.3.0, look
1290 for properties on interfaces. (#127068, James M. Cape)
1292 2003-11-03 Dan Winship <danw@ximian.com>
1294 * gtkdoc-scangobj.in: Clean up $MODULE-scan.o even when using
1297 * gtkdoc-scanobj.in: Likewise
1299 * gtk-doc.make (CLEANFILES): Remove $(MODULE)-scan.o from here
1300 (clean-local): rm -rf .libs
1302 Wed Oct 8 01:21:54 2003 Matthias Clasen <maclas@gmx.de>
1304 * gtkdoc-scan.in (ScanHeader): Make gtkdoc-scan grok
1305 typedef struct { } foo; in addition to the more baroque
1306 typedef struct _foo foo; struct _foo { };
1307 (#116807, Malcolm Tredinnick)
1309 Wed Oct 8 01:21:35 2003 Matthias Clasen <maclas@gmx.de>
1311 * gtkdoc-mkdb.in (OutputParamDescriptions): Remove a pointless
1314 2003-10-01 Matthias Clasen <maclas@gmx.de>
1316 Make signals and properties end up in the right template
1317 file (#116569, Owen Taylor):
1319 * gtkdoc-mktmpl.in (OutputSignalTemplates):
1320 (OutputArgTemplates): Return a string rather than directly
1322 (OutputTemplateFile): Don't interpret $title as the name of
1323 the object to print signal and property templates for.
1324 (UpdateTemplates): Collect signal and property templates for all
1325 objects contained in the section.
1327 2003-08-10 James Henstridge <james@daa.com.au>
1329 * acinclude.m4 (JH_PATH_XML_CATALOG): allow caller to specify
1330 actions if found or not found.
1331 (JH_CHECK_XML_CATALOG): when requiring JH_PATH_XML_CATALOG, don't
1332 error out if it is not found.
1334 2003-08-03 Matthias Clasen <maclas@gmx.de>
1336 * doc/gnome.txt: Add some hints regarding markup of examples.
1338 2003-07-22 Matthias Clasen <maclas@gmx.de>
1341 * gtk-doc.cat: Fix a problem with the previous commit.
1343 2003-07-21 Matthias Clasen <maclas@gmx.de>
1345 Applied patches from Sebastian Rittau to add maintainer mode and an SGML catalog. (#117955, #117956)
1347 * gtk-doc.cat.in: New catalog file.
1348 * configure.in: Added gtk-doc.catalog to output files.
1349 * Makefile.am: Install gtk-doc.catalog.
1351 * configure.in: Added AM_MAINTAINER_MODE.
1352 * autogen.sh: Added --enable-maintainer-mode to configure options.
1354 2003-07-09 Matthias Clasen <maclas@gmx.de>
1356 * gtkdoc-mktmpl.in (ParseStructDeclaration):
1357 * gtkdoc-mkdb.in (ParseStructDeclaration): Accept volatile struct members, which have just
1358 made their appearance in glib.
1360 2003-06-29 Matthias Clasen <maclas@gmx.de>
1362 * gtkdoc-mkdb.in (ExpandAbbreviations): When expanding @param, catch the common @param->field
1363 and @param.field, to reduce the need for littering the C sources with <literal>foo->bar</literal>.
1365 2003-06-25 Matthias Clasen <maclas@gmx.de>
1367 Changes for #115528:
1369 * gtkdoc-mkdb.in (OutputSGML): Collect hierarchy, interfaces, implementations, prerequisites
1370 and derived interfaces separately.
1371 (OutputSGMLFile): Take two more arguments: implementations and derived interfaces.
1372 (GetHierarchy): Also put immediate children in the local tree.
1373 (GetInterfaces): Split into GetInterfaces and GetImplementations.
1374 (GetImplementations): New function to get the implementations of an interface.
1375 (GetDerived): New function to get the known derived interfaces of an interface.
1377 * gtkdoc-mkdb.in (MakeXRef): Accept a second, optional parameter for the
1379 (ExpandAbbreviations): Add semantic markup inside the links, so that
1380 non-crossreferenced symbols come out properly formatted after link
1383 2003-06-15 Matthias Clasen <maclas@gmx.de>
1385 Support for a flat index of all symbols. (#92861)
1386 To use, put an empty <index/> element in your driver document.
1388 * gtkdoc-mkdb.in (MakeIndexterms): New function, emits an indexterm.
1389 (OutputMacro, OutputTypedef, OutputStruct, OutputEnum,
1390 OutputUnion, OutputVariable, OutputFunction): Use MakeIndexterms.
1391 to emit indexterms for symbols.
1393 * gtkdoc-mkdb.in (GetSignals):
1394 (GetArgs): Emit Since: information for signals and properties.
1396 Thu Jun 12 15:55:57 2003 Owen Taylor <otaylor@redhat.com>
1398 * gtkdoc-mkhtml.in (declaration): Replace head -1 with -n 1.
1399 (Merge change by Elliot Lee from Red Hat package)
1401 2003-06-11 Matthias Clasen <maclas@gmx.de>
1403 * doc/gnome.txt: Updates to the documentation of inline comments.
1405 2003-06-03 Matthias Clasen <maclas@gmx.de>
1407 * gtk-doc.spec.in: Add a missing Provides: and include the .pc file.
1408 (#106568, Joe Pranevich)
1410 2003-05-27 Matthias Clasen <maclas@gmx.de>
1412 * gtkdoc-mkdb.in (GetSignals):
1413 (GetArgs): Add signals and properties to the statistics.
1414 (OutputMissingDocumentation): Emit undocumented signals and
1415 properties. (#113645)
1417 2003-04-21 Matthias Clasen <maclas@gmx.de>
1419 * tools/docpercentages.pl: Fix autolinkification for undocumented
1422 * doc/style-guide.txt: Typo fix.
1424 2003-04-18 James Henstridge <james@daa.com.au>
1428 2003-04-18 James Henstridge <james@daa.com.au>
1430 * NEWS: add news items.
1432 * configure.in: increment version number.
1434 2003-03-14 Matthias Clasen <maclas@gmx.de>
1436 * gtkdoc-mkdb.in (OutputBook): Fix the public identifier for
1437 DocBook V3.0: Davenport, not DavenPort.
1438 (#108343, Mariano Suarez-Alvarez)
1440 2003-03-10 James Henstridge <james@daa.com.au>
1442 * configure.in: associate the chmod commands with the files they
1443 are chmod'ing. This way config.status will always run the correct
1446 2003-03-04 James Henstridge <james@daa.com.au>
1448 * configure.in: look up the docbook DTD by public id rather than
1451 2003-02-26 Matthias Clasen <maclas@gmx.de>
1453 * gtkdoc-mkdb.in (GetArgs): Prefer template or comment docs over
1454 blurbs only if they're nonempty, otherwise the empty docs from the
1455 templates override all the blurbs.
1457 2003-02-26 James Henstridge <james@daa.com.au>
1459 * autogen.sh (THEDIR): set up so that it will choose automake 1.7
1460 or 1.6 in preference to 1.4. Passes distcheck okay.
1462 * configure.in: update configure.in script to match
1463 recommendations of newer autoconf's, and add an AC_PREREQ()
1464 statement, since the xml catalog checks are using new autoconf
1467 * gtk-doc.make (xml-build.stamp): since other bits of the makefile
1468 were assuming xml, may as well hard code --output-format=xml.
1470 2003-02-19 James Henstridge <james@daa.com.au>
1472 * Makefile.am: get rid of the dist-hook, and just include the
1473 given files in EXTRA_DIST instead.
1475 * configure.in: provide meaningful names for the commands.
1477 * acinclude.m4 (JH_CHECK_XML_CATALOG): add some extra arguments: a
1478 friendly name for the catalog entry, and actions to run if the
1479 entry was found or not. Also include a bit more information in
1480 the config.log file if an error occurs.
1482 2003-02-18 Matthias Clasen <maclas@gmx.de>
1484 * gtkdoc-mkhtml.in (declaration): Avoid the unportable grep
1485 option -q. (#105311)
1487 2003-02-19 James Henstridge <james@daa.com.au>
1489 * devhelp.xsl: put chapters that aren't at the top level into the
1490 toc tree (to make gtk's .devhelp tree look better).
1492 * gtk-doc.spec.in (Requires): make the requires lines match
1493 current requirements ...
1495 * gtkdoc-mkhtml.in (XSLTPROC): pass --nonet to xsltproc, so we
1496 don't try to download DTDs and XSLT over the net. The configure
1497 checks should catch people who don't have the correct files in
1500 2003-02-17 James Henstridge <james@daa.com.au>
1502 * gtkdocize.in (--version): add --version argument.
1504 2003-02-14 James Henstridge <james@daa.com.au>
1506 * gtkdoc-mkdb.in (GetOptions): actually accept --tmpl-dir as a
1507 command line option. Based on a patch from Simon Josefsson
1510 * gtk-doc.xsl: remove the xmlns declaration. Not really needed
1511 for html output anyway ...
1513 2003-02-13 James Henstridge <james@daa.com.au>
1515 * devhelp.xsl: remove refsect1's and refsect2's from book tree, as
1516 suggested by Hallski.
1518 * gtk-doc.make (install-data-local): the change to install images
1519 was superfluous, so I have removed it.
1520 (CLEANFILES): move some more stuff to CLEANFILES from the
1521 distclean-local rule.
1523 2003-02-12 James Henstridge <james@daa.com.au>
1525 * gtk-doc.make: add some chmod calls to work arround distcheck on
1527 (install-data-local): copy the images as well as the html files
1529 (uninstall-local): add an uninstall rule to remove the docs.
1530 (CLEANFILES): add $(DOC_MODULE)-scan.o to the list of files to be
1533 2003-02-09 James Henstridge <james@daa.com.au>
1535 * gtkdocize.in: script used to copy gtk-doc.make into another
1538 * gtk-doc.make: automake makefile fragment to handle gtk-doc
1539 support in other modules.
1541 * configure.in: check to make sure DocBook XML DTD and XSLT
1542 stylesheets are present in the XML catalog.
1544 * acinclude.m4 (JH_CHECK_XML_CATALOG): new macro to check for
1545 entries in the XML catalog.
1547 2003-02-04 James Henstridge <james@daa.com.au>
1549 * gtk-doc.m4: a macro to check for gtk-doc.
1551 * Makefile.am (gtkdocdata_DATA): don't bother installing xml.dcl.
1552 It isn't used anymore (since switching xml mode to xsltproc).
1554 * gtkdoc-mkhtml.in (gtkdocdir): and here.
1556 * Makefile.am (gtkdocdatadir): change dir.
1558 * configure.in: put data files in $(datadir)/gtk-doc/data, so that
1559 they don't all get mixed up with the html docs installed by other
1562 2003-01-20 Damon Chaplin <damon@gnome.org>
1566 2003-01-20 Damon Chaplin <damon@gnome.org>
1568 * configure.in: bumped version to 1.0, and added SGML_OUTPUT_TYPE
1569 variable, which we set to 'sgml-raw' if we have openjade, or 'sgml'
1570 if we have jade. Added gtk-doc.pc to AC_OUTPUT.
1572 * gtkdoc-mkhtml.in: used SGML_OUTPUT_TYPE variable to set the output
1573 type of jade/openjade.
1575 * gtk-doc.pc.in: new pkg-config file, which apps can use to reliably
1576 check the gtk-doc version in future.
1578 * Makefile.am (pkgconfigdir): install .pc file, and add it to
1581 * examples/configure.in: updated example to use pkg-config for the
1584 2003-01-18 James Henstridge <james@daa.com.au>
1586 * gtkdoc-mkhtml.in (declaration): switch the output type from
1587 "sgml" to "sgml-raw" when using Jade to process docs. This gets
1588 rid of the line breaks inside the tags, which were confusing Lynx.
1590 2003-01-15 Matthias Clasen <maclas@gmx.de>
1592 * gtkdoc-scan.in (ScanHeader): Remove special cases for Pango and
1594 * gtkdoc-mkdb.in (OutputDeclaration):
1595 * gtkdoc-mktmpl.in (OutputDeclaration): Remove special cases for
1596 structs named BlablaClass. (#95398)
1598 * gtkdoc-mkdb.in (GetInterfaces): Fix an off-by-one error.
1599 (#103466, Josh Parsons)
1601 2002-12-28 Chema Celorio <chema@celorio.com>
1603 * gtkdoc-scan[g]obj.in: add "void" to functions with no parameters,
1604 avoids warning with -Wmissing-prototypes when compiling
1607 2002-12-16 James Henstridge <james@daa.com.au>
1609 * gtk-doc.spec.in: require perl >= 5.6.0
1611 * configure.in: require Perl >= 5.6.0
1613 * gtkdoc-fixxref.in: add "use bytes;" to fix malformed UTF-8
1614 character errors when run with a UTF-8 locale.
1616 2002-12-16 Matthias Clasen <maclas@gmx.de>
1618 * gtkdoc-mkdb.in (OutputSGMLFile): Don't emit the additional
1619 anchors in the title which breaks the generated html (the title
1620 text is copied around). Instead, put the anchors before the
1621 synopsis. This isn't perfect, but the best we can achieve without
1624 2002-12-13 Matthias Clasen <maclas@gmx.de>
1626 * gtkdoc-mkdb.in: Add an --ignore-files option which can be used
1627 to omit files or directories from scanning.
1628 (OutputSGMLFile): Emit anchors for all objects contained in the
1629 file to avoid dangling links.
1630 (OutputMissingDocumentation): Emit deprecated symbols after
1633 2002-12-12 Matthias Clasen <maclas@gmx.de>
1635 * gtkdoc-scan.in (ScanHeader): Also recognize "positive" guards
1636 like #ifdef GTK_ENABLE_BROKEN.
1638 2002-12-11 Matthias Clasen <maclas@gmx.de>
1640 * gtk-doc.xsl: Change XPath path to "//anchor|//refentry" for the
1641 generation of index.sgml. The previous path "//anchor|refentry"
1642 was not matching any refentrys.
1644 2002-12-09 Matthias Clasen <maclas@gmx.de>
1646 * gtkdoc-mktmpl.in (UpdateTemplates): Emit unused class structs
1647 to $MODULE-unused.txt.
1649 2002-12-08 Matthias Clasen <maclas@gmx.de>
1651 * gtkdoc-mkdb.in (OutputStruct): Don't emit private parts
1652 of class structs to parameter lists in docs. Remove leftover
1655 * gtkdoc-mktmpl.in (OutputDeclaration): Don't emit private parts
1656 of class structs to parameter lists in templates.
1658 2002-12-06 Matthias Clasen <maclas@gmx.de>
1660 Improved /*< private >*/ handling: (#95398)
1662 * gtkdoc-mkdb.in (OutputStruct): Handle /*< public >*/ and
1663 /*< private >*/ for all structs. Default to private for object and
1664 class structs, to public for all other structs.
1666 * gtkdoc-scan.in (ScanHeader): Emit declarations for class structs
1667 to $MODULE-decl.txt.
1669 2002-12-05 Matthias Clasen <maclas@gmx.de>
1671 * gtkdoc-mktmpl.in (OutputDeclaration):
1672 * gtkdoc-mkdb.in (ReadTemplateFile): Support @Since: and
1673 @Deprecated: as a way to specify since and deprecated information
1674 in template files. This works for all kinds of symbols, even those
1675 which normally don't have parameter lists.
1677 2002-12-02 Matthias Clasen <maclas@gmx.de>
1679 * gtkdoc-mkdb.in (MakeDeprecationNote): Support multi-paragraph
1682 2002-11-29 James Henstridge <james@daa.com.au>
1684 * gtkdoc-mkhtml.in: copy the navigation images for both XML and
1687 * gtk-doc.dsl.in: update DSSSL stylesheets to match layout of XSL
1690 2002-11-29 Matthias Clasen <maclas@gmx.de>
1692 * gtkdoc-scan.in (ScanHeader): Make deprecation guards work with
1694 #ifndef DEPRECATION_GUARD
1695 #if !defined(DEPRECATION_GUARD) || defined(FOO_COMPILATION)
1696 The second form is used in GDK and GTK+ to include selected
1697 deprecated symbols when compiling the library itself.
1699 2002-11-27 Matthias Clasen <maclas@gmx.de>
1701 * gtkdoc-mkdb.in: Parse to new tags in inline doc comments,
1702 Since: and Deprecated:, which can be placed after the Returns:
1703 tag. Emit the Since: information (which is expected to be just a
1704 version number) after the parameters and the Deprecated:
1705 information (which is expected to be one or more full sentences)
1706 inside the deprecation warning.
1707 Warn if a Deprecated: tag is found on a symbol which is not
1708 guarded by a deprecation guard in the header.
1710 2002-11-26 James Henstridge <james@daa.com.au>
1712 * gtkdoc-mkhtml.in: set gtkdoc-bookname and gtkdoc-version
1713 parameters in sgml mode, and don't bother with the sed run after
1714 processing with jade.
1715 In XML mode, pass the version number in as a parameter too.
1717 * gtk-doc.dsl.in ($user-html-header$): add <meta> tag if
1718 gtkdoc-version is set.
1719 (generate-index-mode): if gtkdoc-bookname is set, add it to the
1720 hrefs in the index file, like the XSLT sheets do.
1722 * gtk-doc.xsl: add gtkdoc.version parameter, and use it to add a
1723 <meta> tag with the gtk-doc version number.
1725 2002-11-16 Damon Chaplin <damon@gnome.org>
1729 2002-11-16 Damon Chaplin <damon@gnome.org>
1731 * configure.in: bumped version to 0.10.
1733 * Makefile.am (EXTRA_DIST): added MAINTAINERS.
1735 * README: updated requirements info, mainly to add XML stuff.
1737 * NEWS: added news for 0.10
1740 * AUTHORS: updated my email address.
1742 2002-11-16 James Henstridge <james@daa.com.au>
1744 * gtk-doc.xsl: output HTML in ISO-8859-1 (latin1), as using UTF-8
1745 can trigger misinterpretation of web pages when the web server
1746 asserts that the document is encoded in latin1 in the mime type.
1748 2002-11-15 James Henstridge <james@daa.com.au>
1750 * gtk-doc.xsl: small changes to make the output closer to valid
1753 * gtkdoc-fixxref.in (MakeXRef): when substituting in cross
1754 references, use lower case element and attribute names, and quote
1755 the attribute value.
1757 2002-11-12 James Henstridge <james@daa.com.au>
1759 * gtkdoc-mkdb.in: put content of parameter descriptions in
1760 <simpara> elements instead of <para>'s. This makes the generated
1761 HTML more compact, as it will omit the <p> tag inside the list
1764 * gtk-doc.xsl: adjust stylesheet a little.
1766 2002-11-10 James Henstridge <james@daa.com.au>
1768 * gtk-doc.xsl: change style for documentation.
1770 * gtkdoc-mkhtml.in (declaration): copy PNG files to the html
1773 2002-11-10 Matthias Clasen <maclas@gmx.de>
1775 * gtkdoc-mkdb.in (GetArgs): Expand abbreviations in source doc
1778 2002-11-09 Matthias Clasen <maclas@gmx.de>
1780 * gtkdoc-mktmpl.in (OutputSignalTemplates): Don't replace template
1781 param names with meaningless argn names generated by gtkdoc-scangobj.
1783 * gtkdoc-mkdb.in (GetSignals): Use argument names from source doc
1784 comments, if available.
1785 (GetArgs): Use source doc comments instead of blurb, if available.
1786 (ScanSourceFile): Also accept object::signal and object:property
1788 (MergeSourceDocumentation): For signals only, prefer source doc
1789 param names over template param names.
1791 Fri Nov 8 15:10:57 2002 Owen Taylor <otaylor@redhat.com>
1793 * gtkdoc-mkdb.in (GetPrerequisites): Add missing <para>
1796 Mon Nov 4 17:17:40 2002 Owen Taylor <otaylor@redhat.com>
1798 * gtkdoc-mkdb.in (MergeSourceDocumentation): Warn
1799 when overriding docs in template file by inline comments.
1801 * gtkdoc-mkdb.in (GetInterfaces): Add missing <para> in
1802 "Implemented interfaces" output.
1804 2002-10-29 Damon Chaplin <damon@ximian.com>
1806 * gtkdoc-scangobj.in: in get_type_name() set is_pointer to TRUE for
1807 subtypes of G_TYPE_BOXED and G_TYPE_POINTER. This means we get things
1808 like "GtkTreeIter *iter" rather than "GtkTreeIter iter" which was
1809 incorrect. Also return 'GParamSpec*' for G_TYPE_PARAM.
1810 in lookup_signal_arg_names() changed GtkNotebook::switch-page
1811 page argument to guint. And fixed a few other entries.
1812 Also fixed argument numbering, so we don't get 2 "widget" arguments.
1814 * gtkdoc-scanobj.in: add ';' after unlink command to avoid warning.
1816 2002-10-20 Matthias Clasen <maclas@gmx.de>
1818 * examples/Makefile.am (SCANOBJ_FILES): Add $(DOC_MODULE).prerequisites.
1820 * gtkdoc-mkdb.in: Read $MODULE.prerequisites and put list of
1821 prerequisites below the object hierarchy for interfaces.
1823 * gtkdoc-scangobj.in: Write information about interface
1824 prerequisites to $MODULE.prerequisites.
1826 2002-10-15 Matthias Clasen <maclas@gmx.de>
1828 * gtkdoc-scangobj.in: Sort paramspec arrays for
1829 greater stability and less random tmpl file diffs.
1831 2002-10-14 Matthias Clasen <maclas@gmx.de>
1833 * examples/Makefile.am (SCANOBJ_FILES): Add $(DOC_MODULE).interfaces.
1835 * gtkdoc-mkdb.in: Read $MODULE.interfaces and put lists of
1836 implemented interfaces/known implementations below the object
1837 hierarchy for classes/interfaces.
1839 * gtkdoc-scangobj.in: Write interface information to
1842 2002-10-12 Matthias Clasen <maclas@gmx.de>
1844 * gtkdoc-scangobj.in: Make interface appear in the object hierarchy.
1846 2002-10-11 Matthias Clasen <maclas@gmx.de>
1848 * gtk-doc.xsl: use 'UTF-8', not UTF-8 for default.encoding, to
1849 make the encoding actually appear in the resulting HTML.
1851 2002-10-09 James Henstridge <james@daa.com.au>
1853 * gtkdoc-mkdb.in: set $doctype_header to "" for the SGML case, as
1854 we don't add a doctype to the beginning of SGML fragments.
1856 Tue Sep 17 01:07:51 2002 Jonathan Blandford <jrb@gnome.org>
1858 * gtk-doc.xsl: output the chunks in UTF-8 so other tools can use
1861 2002-09-03 James Henstridge <james@daa.com.au>
1863 * gtk-doc.xsl: turn on rendering of variablelists as tables, and
1864 set CSS rules to style .variablelist instead of .informaltable.
1866 * gtk-doc.dsl.in (variablelist): override the variablelist handler
1867 instead of the tgroups.
1869 * gtkdoc-mkdb.in (OutputStruct): use a <variablelist> for listing
1870 the field descriptions.
1871 (OutputEnum): same here.
1872 (OutputParamDescriptions): and here.
1874 2002-08-12 James Henstridge <james@daa.com.au>
1876 * gtk-doc.xsl: include devhelp.xsl, and call generate.devhelp when
1877 processing the docbook/xml input.
1879 * devhelp.xsl: new file, implements .devhelp file output.
1881 2002-08-18 Havoc Pennington <hp@pobox.com>
1883 * autogen.sh: hardcode aclocal-1.4/automake-1.4 so that users with
1884 both automake 1.6 and 1.4 installed get the right automake. Means
1885 compilation from CVS will now require the latest automake 1.4
1886 release, or manually creating symlinks called "automake-1.4" and
1889 2002-08-08 Matthias Clasen <maclas@gmx.de>
1891 * gtkdoc-scangobj.in: Make sure blurbs end with a '.'
1893 2002-08-08 James Henstridge <james@daa.com.au>
1895 * gtk-doc.xsl: add a gtkdoc.bookname param, and include it in the
1896 index.sgml output (if not empty).
1898 * gtkdoc-mkhtml.in: only perform the sed operation if we are using
1899 Jade, and pass the module name as a parameter when using xsltproc.
1901 2002-08-04 Matthias Clasen <maclas@gmx.de>
1903 * gtkdoc-scangobj.in: Don't try to list signals on types which
1904 don't support signals, e.g. boxed types.
1906 2002-06-14 jacob berkman <jacob@ximian.com>
1908 * gtkdoc-mkdb.in: do the version check before help, so --version
1909 doesn't output --help (should fix recent build bustage)
1911 2002-06-12 Matthias Clasen <maclas@gmx.de>
1913 * gtkdoc-mkdb.in: Make header-grabbing work without an explicit
1914 --main-sgml-file argument.
1916 * gtkdoc-mkdb.in: Emit the object hierarchy as a <screen> rather
1917 than a <literallayout>, since the Docbook XSL stylesheets don't
1918 handle <link>s inside <literallayout>.
1920 * gtkdoc-mkdb.in: Decide wether to generate standalone documents
1921 for XIncluding or entities based on the presence of the XInclude
1922 namespace declaration on the document element.
1924 2002-06-09 James Henstridge <james@daa.com.au>
1926 * gtkdoc-mkdb.in: try to grab the header off the top of the main
1929 2002-05-31 James Henstridge <james@daa.com.au>
1931 * gtkdoc-mkdb.in (OutputSGML): put XIncludes in the $book_bottom
1933 (OutputBook): add the XInclude namespace declaration to the book
1936 * gtkdoc-mkhtml.in (declaration): if the document looks like XML,
1937 process it with xsltproc.
1939 * configure.in: check for xsltproc.
1941 * gtk-doc.xsl: start of XSLT template for converting docbook/xml
1944 2002-06-03 Matthias Clasen <maclas@gmx.de>
1946 * gtkdoc-mkdb.in (ConvertSGMLChars): Don't use Posix character
1947 classes. Perl < 5.6 doesn't have them; and the API doc autobuilder
1948 on widget.gnome.org has an old Perl.
1950 2002-05-29 Matthias Clasen <maclas@gmx.de>
1954 * gtkdoc-mkdb.in (OutputSGML): Call GetSignals, GetArgs and
1955 GetHierarchy for each symbol here and accumulate.
1956 (OutputSGMLFile): Get signal, argument and hierarchy information
1958 (GetSignals, GetArgs, GetHierarchy): Don't wrap the return value
1959 in a refsect1, so that the results of multiple calls can be accumulated.
1961 2002-05-28 Matthias Clasen <maclas@gmx.de>
1963 * gtkdoc-mkdb.in (ConvertSGMLChars): Make this work correctly
1964 for empty elements and XML comments in doc comments.
1966 2002-05-27 Matthias Clasen <maclas@gmx.de>
1968 * gtkdoc-mkdb.in (ReadTemplateFile, OutputSGMLFile):
1969 Use only the basename of the template file in the key for the
1970 symbol table, in order to decouple the file extensions of the
1971 template files and the generated entities (we want to generate
1972 .xml entities from .sgml template files when emitting XML).
1974 2002-05-25 Matthias Clasen <maclas@gmx.de>
1976 * gtkdoc-mkdb.in (ConvertSGMLChars): New function which tries to
1977 be a bit more clever when escaping SGML syntax characters.
1978 (ScanSourceFile): Use ConvertSGMLChars instead of CreateValidSGML.
1979 This reduces the work needed to make gtk-doc emit XML (where <, &
1980 and friends must always be escaped).
1982 2002-05-18 Matthias Clasen <maclas@gmx.de>
1984 * gtkdoc-mkhtml.in: Detect whether we're processing SGML or XML.
1986 * gtkdoc-mkdb.in: New option --output-format to switch between
1987 SGML and XML output.
1989 * Makefile.am (EXTRA_DIST): Add xml.dcl
1991 * xml.dcl: The XML declaration.
1993 2002-05-06 jacob berkman <jacob@ximian.com>
1995 * gtkdoc-scangobj.in: add an include for the GTK_CHECK_VERSION
1998 2002-05-05 Matthias Clasen <maclas@gmx.de>
2000 * gtkdoc-scangobj.in: Output style properties. (#80659)
2002 * gtkdoc-mkdb.in (GetArgs): Return separate sections for
2003 properties, child properties and style properties. (#80659)
2005 2002-05-03 Matthias Clasen <maclas@gmx.de>
2007 * gtkdoc-scangobj.in: Fix for segfault in scangobj-generated C
2008 program on Solaris. (#80606, Jacob Berkman)
2010 2002-05-01 Matthias Clasen <maclas@gmx.de>
2012 * tools/docpercentages.pl: Add the script which Owen uses for the
2013 d.g.o online API docs. Its easier to keep in sync here.
2015 * gtkdoc-mkdb.in (OutputMissingDocumentation): Fix
2016 $MODULE-undocumented.txt for d.g.o online API docs.
2018 * gtkdoc-mkdb.in (GetArgs): Use blurbs for property documentation.
2020 * gtkdoc-scangobj.in: Output child properties. Output nicks and
2021 blurbs for properties.
2023 2002-04-28 Matthias Clasen <maclas@gmx.de>
2025 * gtkdoc-mkdb.in (ScanSourceFile): Don't scan for return value
2026 descriptions unnecessarily. (#65997)
2028 2002-03-11 Matthias Clasen <maclas@gmx.de>
2030 * gtkdoc-scangobj.in, gtkdoc-mkdb.in: Create docs for signals on interfaces.
2032 2002-02-01 Damon Chaplin <damon@ximian.com>
2034 * configure.in: check for openjade or jade. Patch from Stefan Kost
2035 <kost@imn.htwk-leipzig.de>.
2037 * gtkdoc-mkhtml.in: use @JADE@ so the correct version of jade is used.
2039 * autogen.sh: commented out autoheader since we don't have a config.h.
2041 2002-01-18 Damon Chaplin <damon@ximian.com>
2045 2002-02-01 Damon Chaplin <damon@ximian.com>
2047 * examples/Makefile.am: added SCANOBJ_OPTIONS in case the module needs
2048 to pass options to gtkdoc-scanobj or gtkdoc-scangobj.
2050 2002-01-24 Damon Chaplin <damon@ximian.com>
2052 * tools/gtk-doc.el: added Zucchi's emacs lisp for automatically adding
2053 skeleton comment blocks above functions. Very handy!
2055 2002-01-23 Damon Chaplin <damon@ximian.com>
2057 * configure.in: bumped the version to 0.9, so GTK+ can depend on this
2060 * gtkdoc-scangobj.in: we now default to calling g_type_init() to
2061 initialize the type system, rather than gtk_init(). This means you
2062 don't need an X connection to build the docs any more. Hurrah!
2063 Also added a '--type-init-func' argument so you can change the
2064 function to be called. GTK+ uses --type-init-func="gtk_type_init(0)".
2066 * gtkdoc-scan.in (ScanHeader): removed 'Found object' debug message.
2068 2002-01-18 Damon Chaplin <damon@ximian.com>
2072 2002-01-18 Damon Chaplin <damon@ximian.com>
2074 * Makefile.am (EXTRA_DIST): added gtk-doc.dcl to EXTRA_DIST.
2076 2002-01-18 Damon Chaplin <damon@ximian.com>
2078 * gtkdoc-scangobj.in: Reverted jacob's patch for this release, since
2079 it breaks GTK+ and possibly other packages. I'll re-apply it after
2080 the release, so we can fix everything in CVS.
2082 2002-01-18 jacob berkman <jacob@ximian.com>
2084 * gtkdoc-scangobj.in: default to calling g_type_init(), remove
2085 --nogtkinit argument and replace with a more flexible
2088 2002-01-18 Damon Chaplin <damon@ximian.com>
2090 * gtkdoc-mkdb.in (ScanSourceFile): patch from Matthias Clasen
2091 <matthiasc@poet.de> to only strip first space after '*' in source
2092 code comment blocks, so example code can be indented as desired.
2095 Wed Nov 21 16:50:35 2001 Owen Taylor <otaylor@redhat.com>
2097 * gtkdoc-mkdb,tmpl.in: Add some extra quoting to
2098 error messages to make it clearer what is going on
2099 with trailing commas on enumeration declarations.
2101 Wed Nov 21 16:00:45 2001 Owen Taylor <otaylor@redhat.com>
2103 * Applied patch from Matthias Clasen to use a modified
2104 .dcl file with the 44 character name length limit removed.
2107 2001-10-17 Damon Chaplin <damon@ximian.com>
2109 * gtkdoc-mkdb.in: applied patch from Matthias Clasen
2110 <matthiasc@poet.de> to take a --sgml-mode argument which means
2111 all comment blocks in the source code are assumed to be DocBook
2112 (i.e. we don't convert '<', '>' and '&' to '<' etc.
2114 2001-10-09 Damon Chaplin <damon@ximian.com>
2116 * gtkdoc-mkdb.in (OutputMissingDocumentation): changed %.2f to %.0f
2117 so hopefully the automated reports on developer.gnome.org will work
2120 2001-10-02 Damon Chaplin <damon@ximian.com>
2122 * gtkdoc-mktmpl.in (OutputDeclaration):
2123 * gtkdoc-mkdb.in (OutputFunction): applied patch from
2124 matthiasc@poet.de (Matthias Clasen) to handle G_CONST_RETURN in a
2125 parameter list. Bug #61341.
2127 2001-10-02 Damon Chaplin <damon@ximian.com>
2129 * gtkdoc-mkdb.in (OutputMissingDocumentation): applied patch from
2130 matthiasc@poet.de (Matthias Clasen) to output percentages better.
2132 Also set percent to 100 if total is 0, avoiding divide-by-zero.
2134 2001-10-02 Damon Chaplin <damon@ximian.com>
2136 * examples/Makefile.am (DOC_OVERRIDES): define as an empty string,
2139 2001-09-13 Damon Chaplin <damon@ximian.com>
2141 * gtkdoc-mkdb.in (OutputMissingDocumentation): initialize buffer to "".
2142 Fix for SGI from David Kaelbling <drk@sgi.com>.
2144 Sat Sep 8 14:08:51 2001 Jonathan Blandford <jrb@webwynk.net>
2146 * gtkdoc-scan.in (ScanHeader): recognize GET_IFACE macros
2148 2001-09-08 Havoc Pennington <hp@pobox.com>
2150 * gtkdoc-mkdb.in (GetArgs): Title the section on object properties
2151 "Properties" instead of "Args"
2153 2001-08-14 Laszlo Peter <laca@ireland.sun.com>
2155 * gtkdoc-scanobj.in:
2156 * gtkdoc-scangobj.in: change \n's to \\n's in perl scripts
2159 2001-08-12 Jens Finke <jens@gnome.org>
2161 * Updated gtk-doc.spec.in file to match gpp standard.
2163 2001-08-04 Damon Chaplin <damon@ximian.com>
2167 2001-08-04 Damon Chaplin <damon@ximian.com>
2169 * gtkdoc-mkdb.in (OutputFunction):
2170 * gtkdoc-mktmpl.in (OutputDeclaration): patch from Lowell Johnson
2171 <ldjohn@usgs.gov> to accept things like "long long", "short int",
2172 "char test[][CLEN]" as function parameters.
2174 2001-07-20 Anders Carlsson <andersca@gnome.org>
2176 * gtkdoc-scangobj.in: Remove argument to g_type_init ();
2178 2001-07-09 Damon Chaplin <damon@ximian.com>
2180 * gtkdoc-mkdb.in (ParseStructDeclaration): accept G_CONST_RETURN
2181 modifier for function return values. gtkdoc-mktmpl.in already had this.
2183 Thu Jun 21 11:57:16 2001 Owen Taylor <otaylor@redhat.com>
2185 * gtkdoc-scangobj.in: Conform to changes in GObject API
2186 for property retrieval.
2188 2001-05-25 Peter Williams <peterw@ximian.com>
2190 * gtkdoc-mkdb.in (ScanSourceFile): Skip single-line comments --
2191 prevents barfing on ORBit-generated files.
2193 2001-05-20 Damon Chaplin <damon@ximian.com>
2195 * examples/Makefile.am (sgml-build.stamp): replaced use of wildcard
2196 (which isn't portable) with original *.sgml. I think this just means
2197 that the first time you try to build the docs it will fail, but if
2198 you run make again it will work.
2200 * doc/setting-up.txt: explained that make may fail the first time.
2202 2001-05-19 Damon Chaplin <damon@ximian.com>
2206 * doc/setting-up.txt:
2207 * doc/sections-file.txt:
2208 * doc/authors.txt: updated docs to cover simpler setup procedure.
2210 * doc/gtk_button.txt:
2213 * doc/notes.txt: removed out-of date stuff.
2215 * Makefile.am (dist-hook): updated so it doesn't try to remove old
2216 examples subdirectory stuff.
2218 2001-05-19 Damon Chaplin <damon@ximian.com>
2221 * examples/gnomeui/*: removed out-of-date example files.
2223 * examples/configure.in:
2224 * examples/Makefile.am: new example setup mostly copied from GTK+.
2226 * examples/README: describe the example configure.in/Makefile.am.
2228 2001-05-19 Damon Chaplin <damon@ximian.com>
2230 * gtkdoc-mkdb.in: added --help option and changed output slightly to
2231 make more compatable with XML. Patch from Toshio Kuratomi
2232 <badger@prtr-13.ucsc.edu>
2234 2001-05-19 Damon Chaplin <damon@ximian.com>
2236 * gtkdoc-mktmpl.in (OutputDeclaration):
2237 * gtkdoc-mkdb.in (OutputFunction): changed a '?' to a '*' so we accept
2238 multi-dimensional array function parameters. Patch from Paolo Casarini
2239 <casarini@CS.UniBO.IT>
2241 2001-05-12 Damon Chaplin <damon@ximian.com>
2243 * gtkdoc-scangobj.in:
2244 * gtkdoc-scanobj.in: used "*pos = 0" to avoid problems with backslashes
2247 * configure.in: removed dsssl dirs stuff, since we use public entities
2250 * gtkdoc-mkdb.in (OutputBook): if there is no main SGML file we create
2251 it here. Also added a --main-sgml-file option so we know where to put
2254 * gtkdoc-scan.in: if there is no MODULE-sections.txt file, we copy
2255 the MODULE-decl-list.txt file to it. The user can tweak it later.
2257 2001-05-11 Damon Chaplin <damon@ximian.com>
2259 * gtk-doc.spec.in: applied patch from Toshio Kuratomi
2260 <badger@prtr-13.ucsc.edu>.
2262 2001-05-07 Joakim Ziegler <joakim@ximian.com>
2264 * gtkdoc-mkdb.in: Added option --outputallsymbols to create a symbol list
2265 in the module doc dir.
2267 * gtkdoc-mkdb.in: Added functionality to output a list of undocumented
2268 symbols in a module, most of is is in OutputMissingDocumentation.
2270 * gtkdoc-scan.in: Small scanning fixes to facilitate the doc coverage
2271 output mentioned above.
2273 2001-04-25 Federico Mena Quintero <federico@ximian.com>
2275 * gtkdoc-scanobj.in: Added missing output-dir in the call to
2278 2001-04-24 Damon Chaplin <damon@ximian.com>
2280 * gtkdoc-scanobj.in: copied --outputdir option from gtkdoc-scangobj.in.
2282 Fri Apr 13 15:25:44 2001 Owen Taylor <otaylor@redhat.com>
2284 * gtkdoc-mkdb.in: Restore call to OutputBook that was accidentally
2287 Thu Apr 12 17:57:12 2001 Owen Taylor <otaylor@redhat.com>
2289 * gtkdoc-scangobj.in: Add a --outputdir option (sort of hacky.
2290 Need this because $CC, $LD can include relative paths if they
2291 are based on $LIBTOOL)
2293 2001-03-26 Damon Chaplin <damon@ximian.com>
2295 * gtkdoc-mkdb.in (ReadSourceDocumentation): scan .h files as well,
2296 so macros can be documented there if desired. Patch from
2297 Yoann Vandoorselaere <yoann@mandrakesoft.com>
2299 * gtkdoc-mkhtml.in (gtkdocdir): use 'test -f' rather than 'test -e'
2300 which is GNU-specific.
2302 Thu Mar 8 17:26:29 2001 Tim Janik <timj@gtk.org>
2304 * gtkdoc-scangobj.in: fix signal param type handling.
2306 Tue Mar 6 23:21:46 2001 Jonathan Blandford <jrb@redhat.com>
2308 * gtkdoc-scanobj.in: Add gobject support. Now works on files that
2309 don't link against GTK.
2311 Sat Mar 3 17:43:42 2001 Owen Taylor <otaylor@redhat.com>
2313 * gtkdoc-{scan,mktmpl,mkdb}.in: Add support for G_CONST_RETURN.
2314 (Right now, it will appear as G_CONST_RETURN in the output -
2315 I'm not sure that's right - perhaps it should be converted
2318 2001-02-20 Michael Meeks <michael@ximian.com>
2320 * gtkdoc-mktmpl.in: s/TRUE/1/
2322 2001-02-19 Damon Chaplin <damon@ximian.com>
2324 * gtkdoc-mktmpl.in (UpdateTemplates): fixed bug handling the $changed
2327 2001-02-17 Damon Chaplin <damon@ximian.com>
2329 * gtkdoc-scan.in (ScanHeaders):
2330 (ScanHeader): patch from Johannes Stezenbach <js@convergence.de>
2331 so we don't use '\b' in the regexp to match files/dirs to ignore.
2332 '\b' can match '_' so we matched things we shouldn't have.
2334 Mon Feb 12 12:50:57 2001 Owen Taylor <otaylor@redhat.com>
2336 * configure.in: Up version.
2338 Sun Feb 11 18:35:07 2001 Owen Taylor <otaylor@redhat.com>
2340 * gtkdoc-mktmpl.in: Add a timestamp file for the
2341 templates like sgml.stamp
2343 * gtkdoc-mktmpl.in (OutputUnusedTemplates): Write the
2344 symbols out in sorted order instead of hash table
2345 order to reduce conflicts.
2347 Mon Feb 5 16:48:51 2001 Owen Taylor <otaylor@redhat.com>
2349 * configure.in gtk-doc.dsl.in: Remove checks for DSSSL - use a
2350 public entity instead.
2352 * gtkdoc-scangobj.in: Fix to work with libtool better.
2354 2001-01-30 Havoc Pennington <hp@pobox.com>
2356 * gtkdoc-fixxref.in, gtkdoc-mkdb.in, gtkdoc-mktmpl.in,
2357 gtkdoc-scan.in, gtkdoc-scangobj.in, gtkdoc-scanobj.in:
2358 Added -*- cperl -*- magic, and --deprecated-guards
2361 2001-01-23 Damon Chaplin <damon@helixcode.com>
2363 * gtkdoc-scangobj.in:
2364 * gtkdoc-scanobj.in:
2367 * gtkdoc-mktmpl.in: changed so that they only update files when
2368 necessary (they write new versions of the files out, then use 'cmp'
2369 to compare with the existing versions to see if they have changed.)
2370 This should make it easier to do proper dependency rules in Makefiles,
2371 and it may cut down on CVS traffic.
2373 * gtkdoc-mkhtml.in: update a timestamp file (html.stamp) after running.
2374 * gtkdoc-mkdb.in: update a timestamp file (sgml.stamp) if any of the
2375 DocBook SGML files have been changed. So hopefully you can now use
2376 rules like this to avoid unnecessary regeneration of the HTML:
2384 html.stamp: sgml.stamp $(EXTRA_SGML_FILES)
2387 (I've tried this with the old GTK+ reference API docs and it seems to
2390 * gtkdoc-scangobj.in:
2391 * gtkdoc-scanobj.in:
2397 * gtkdoc-fixxref.in:
2398 Added '--version' command-line arg to all shell & perl scripts, so
2399 you can check for version 0.5 if you want to use the above rules.
2400 (If 0.4 is used make will probably complain about not knowing how to
2401 to build sgml.stamp.)
2403 * gtkdoc-common.pl.in: new file to contain shared routines.
2404 For now it just contains the UpdateFileIfChanged routine for the above.
2405 We can move the duplicated routines here in future, though the use of
2406 global variables makes this a bit awkward.
2408 * configure.in (PACKAGE_DATA_DIR): calculates the data dir and
2409 substitutes it so that the scripts know where gtkdoc-common.pl
2410 is installed. Also added gtkdoc-common.pl to AC_OUTPUT.
2412 * Makefile.am: added gtkdoc-common.pl to gtkdocdata_DATA.
2414 * gtkdoc-mkhtml.in: deleted the old index.sgml file, since it causes
2415 problems if it is owned by root (e.g. after you run 'make install' as
2416 root. jade prompts you about overwriting it, which is annoying.
2418 2001-01-10 Havoc Pennington <hp@redhat.com>
2420 * gtkdoc-mktmpl.in: Only move old file to backup if the old file
2421 exists, and have better error messages when doing the backups
2423 Mon Jan 8 14:57:29 2001 Owen Taylor <otaylor@redhat.com>
2425 * gtkdoc-mktmpl.in: Canonicalize signal and argument
2428 * gtkdoc-scangobj.in: Fix up for GParamSpec.
2430 2001-01-04 Fr�d�ric Gobry <frederic.gobry@smartdata.ch>
2432 * gtkdoc-scan.in: fixed matching of < private_header > directive
2434 2000-12-19 Damon Chaplin <damon@helixcode.com>
2436 * gtkdoc-scanobj.in:
2437 * gtkdoc-scangobj.in: added default cases to get_type_name().
2439 2000-12-10 Arturo Tena <arturo@directmail.org>
2441 * gtkdoc-scanobj.in (get_type_name):
2442 * gtkdoc-scangobj.in (get_type_name): fixed syntax error: forgotten
2443 to close a switch statement.
2445 2000-12-10 Damon Chaplin <damon@helixcode.com>
2447 * gtk-doc.spec.in: added spec.in file from John Gotts
2448 <jgotts@linuxsavvy.com>.
2450 * configure.in (AC_OUTPUT): added spec file.
2452 * Makefile.am: uncommented spec file stuff, now that we have one.
2454 * gtkdoc-scanobj.in (get_type_name):
2455 * gtkdoc-scangobj.in (get_type_name): updated to use the type numbers
2456 rather than the type names, which were changed in GTK+ 1.2. This
2457 should fix a problem where GTK_TYPE_STRING arguments were output as
2458 'GtkString *arg' instead of 'gchar *arg'.
2460 I'm still not sure what to output for the structured types such as
2461 GTK_TYPE_SIGNAL/ARGS/FOREIGN/CALLBACK/C_CALLBACK. Should these be
2462 expanded to several arguments to the signal handler?
2464 2000-11-25 Dan Mueth <d-mueth@uchicago.edu>
2466 * help/manual/C/: created this path
2467 * gtk-doc-manual.sgml: Put part of the outline into SGML.
2468 Chris plans to put rest of outline in here and start
2470 * fdl-appendix.sgml: The FDL in SGML. We will probably post
2471 these on the web as a single document (book) so we will
2472 need the FDL to be included as an appendix.
2474 Fri Nov 3 07:21:34 2000 Tim Janik <timj@gtk.org>
2477 (ParseStructDeclaration):
2480 (ParseStructDeclaration):
2481 support /*<protected>*/ equivalently to /*<private>*/
2483 Fri Nov 3 07:15:58 2000 Tim Janik <timj@gtk.org>
2487 (ReadTemplateFile): only eat up the first space (if at all
2488 present) after "@param:" to preserve indentation for multiline
2489 parameter descriptions.
2491 2000-10-30 Raja R Harinath <harinath@cs.umn.edu>
2493 * gtkdoc-mkdb.in (ParseStructDeclaration):
2494 Stop scanning at '}' only when it starts a line.
2495 * gtkdoc-mktmpl.in (ParseStructDeclaration): Likewise.
2497 Mon Oct 30 02:59:54 2000 Tim Janik <timj@gtk.org>
2499 * gtkdoc-scangobj.in: use g_signal_list_ids().
2501 Sun Oct 29 02:54:51 2000 Owen Taylor <otaylor@redhat.com>
2503 * gtkdoc-scangobj.in: Sort signal types arrays for
2504 greater stability and less random tmpl file diffs.
2506 Sun Oct 29 01:02:35 2000 Owen Taylor <otaylor@redhat.com>
2508 * gtkdoc-scangobj.in: Work properly with GSignal
2510 2000-10-21 Damon Chaplin <damon@helixcode.com>
2514 2000-10-14 Damon Chaplin <damon@helixcode.com>
2517 * MAINTAINERS: changed my email address.
2519 * Makefile.am (dist-hook): remove the CVS dirs from the dist.
2521 * doc/setting-up.txt: typo.
2523 Fri Oct 6 17:51:50 2000 <otaylor@redhat.com>
2525 * gtkdoc-scan.in gtkdoc-mkdb.in: Allow multiple
2526 --source-dir options.
2528 Thu Sep 7 11:41:12 2000 Owen Taylor <otaylor@redhat.com>
2530 * gtkdoc-mkdb.in: Ignore all . files when scanning directories.
2532 * gtkdoc-scan.in: Add support for GLIB_VAR, GDKVAR,
2533 etc when looking for variable declarations.
2535 * gtkdoc-scan.in: Recognize GET_CLASS macros.
2537 * gtkdoc-scangobj.in: Support .lo intermediate files
2540 Wed Sep 6 17:57:33 2000 Owen Taylor <otaylor@redhat.com>
2542 * gtkdoc-scangobj.in: Add gtkdoc-scangobj scanner for
2543 GObject type system.
2545 * gtkdoc-scanobj.in: Allow setting $LD to allow separating
2546 compilation and linking and thus to allow using libtool.
2548 * gtkdoc-fixxref.in (ScanIndices): Allow HTMLDIR
2549 not to be present yet.
2551 Tue Sep 5 23:37:53 2000 Owen Taylor <otaylor@redhat.com>
2553 * gtkdoc-fixxref.in: Add a --extra-dir option to
2554 allow scanning of additional uninstalled HTML
2557 * gtkdoc-scan.in (ScanHeaders): Honor subdirectories
2558 appearing in --ignore-headers.
2560 * gtkdoc-mkdb.in: Append -CAPS to all all-caps identifiers
2561 to prevent an infinite expansion of special cases.
2563 * gtkdoc-fixxref.in: Add a --module-dir option to
2564 allow fixing references in an uninstalled tree.
2566 * gtkdoc-mkdb.in gtkdoc-mkhtml.in: Simple handling
2567 for macros with embedded commas in enumeration
2570 Mon Aug 28 18:18:53 2000 Owen Taylor <otaylor@redhat.com>
2572 * configure.in (DSSSL_DIR): Remove check for AM_PATH_GTK
2573 since the dependency is only run-time not install-time,
2574 and to avoid dependency loops.
2576 2000-06-21 Damon Chaplin <damon@helixcode.com>
2578 * gtkdoc-mkdb.in: fixed <INCLUDES> bug, I think.
2580 Wed Feb 9 11:29:25 2000 Owen Taylor <otaylor@redhat.com>
2582 * gtkdoc-scan.in: Hack to avoid misidentifying structures
2583 as GtkObjects within Pango.
2585 1999-12-15 Raja R Harinath <harinath@cs.umn.edu>
2587 * gtk-doc.dsl.in ($generate-chapter-toc$): Add missing close
2590 1999-11-23 Raja R Harinath <harinath@cs.umn.edu>
2592 * gtk-doc.dsl.in: Use the (define (foo) ...) syntax rather than
2593 the uglier (define foo (lambda () ...)) syntax.
2594 ($generate-chapter-toc$): Simplify.
2595 ($shade-verbatim-attr$): Simplify. Use ($table-width$) instead of
2596 "100%" for width (See docs. of NWalsh Docbook DSSSL Stylesheets
2597 for an explanation).
2599 1999-09-20 Damon Chaplin <damon@karuna.freeserve.co.uk>
2601 * gtk-doc.dsl.in: If a Chapter has role="no-toc" we don't generate a
2602 table of contents. This is useful if a better contents page has been
2603 added manually, e.g. for the GTK+ Widgets & Objects page. (But it is
2606 * gtkdoc-scanobj.in: added --nogtkinit flag which will make it call
2607 gtk_type_init() rather than gtk_init(). This is useful when it is
2608 run automatically to update the docs by a cron job or similar and a
2609 connection to an X server is not desirable. However, if any widgets
2610 need a connection to X in their class init function then this can't
2611 be used (e.g. GtkFontSelection at present).
2613 Mon Sep 20 09:09:12 1999 Owen Taylor <otaylor@redhat.com>
2615 * gtkdoc-mkdb.in gtkdoc-mktmpl.in: (ParseStructDeclaration):
2616 Fixed up the code to do /*< private >*/ ... stripping.
2618 1999-09-10 Martin Baulig <martin@home-of-linux.org>
2620 * gtkdoc.dsl.in ($generate-chapter-toc$): Return #t, not #f.
2622 1999-09-09 Martin Baulig <martin@home-of-linux.org>
2624 * gtkdoc-scan.in (ScanHeader): Don't force typedefs and other
2625 things to start in column 0; allow some spaces in front of them.
2626 Output `typedef struct { ... } name' structs as typedef, not as
2629 1999-09-08 Martin Baulig <martin@home-of-linux.org>
2631 * gtkdoc-mkdb.in (CreateValidSGMLID): `s/::/-/g;' for CORBA objects.
2633 1999-08-22 Erik Walthinsen <omega@cse.ogi.edu>
2635 * gtkdoc-scan.in: modified so it will find any Class, not just Gtk
2636 and Gnome classes. Introduces the possibility of extraneous Class
2637 definitions (verified), which should be pruned somehow (haven't
2638 analyzed the false positive yet).
2640 1999-08-22 Damon Chaplin <damon@karuna.freeserve.co.uk>
2643 * gtkdoc-mkdb.in: a few fixes to ParseStructDeclaration. It still
2644 has problems with nested structs/unions like those which occur in
2645 gtkclist.h and gtktypeutils.h.
2647 * configure.in: removed gtk-doc.spec from AC_OUTPUT, as whoever wrote
2648 this forgot to add gtk-doc.spec.in to CVS.
2649 * Makefile.am: commented out gtk-doc.spec.
2651 Wed Aug 18 03:55:30 1999 Owen Taylor <otaylor@redhat.com>
2653 * gtkdoc-mktmpl.in: Propagate fix from gtkdoc-mkdb.in.
2654 :-(; need to libraryize, need to libraryize.
2656 Wed Aug 18 03:55:30 1999 Owen Taylor <otaylor@redhat.com>
2658 * gtkdoc-mkdb.in: Fix bug that was preventing
2659 structure field definitions from being output.
2661 Wed Aug 18 23:25:23 1999 Owen Taylor <otaylor@redhat.com>
2663 * configure.in: Add /usr/lib/sgml/stylesheet to list
2664 of stylesheet directories. (Found in recent Debian
2667 1999-08-15 Damon Chaplin <damon@karuna.freeserve.co.uk>
2669 * gtkdoc-mkdb.in: Output $decl_out as the struct rather than the
2670 original $declaration.
2672 1999-08-12 Damon Chaplin <damon@karuna.freeserve.co.uk>
2675 * gtkdoc-mktmpl.in: Added special case in ParseEnumDeclaration to
2676 handle GIOCondition which uses strange macros like this:
2679 G_IO_IN GLIB_SYSDEF_POLLIN,
2681 The GLIB_SYSDEF_POLLIN macro expands to something like '=1'
2683 1999-08-05 Damon Chaplin <damon@karuna.freeserve.co.uk>
2685 * gtk-doc.dsl.in: output <br clear=all> after sections and at end of
2686 page so that right-aligned images aren't messed up quite as much.
2688 Wed Aug 4 04:04:55 1999 Owen Taylor <otaylor@redhat.com>
2690 * gtkdoc-mk{db,tmpl}.in (ParseStructDeclaration): Allow
2693 * gtkdoc-mktmpl.in (ReadObjectHierarchy): Remove
2694 call to MakeXref that slipped in accidentally.
2696 Wed Aug 4 03:30:19 1999 Owen Taylor <otaylor@redhat.com>
2698 * doc/style-guide.txt: Removed references to creating
2699 tables explicitely in favor of demonstrating new
2700 syntax. Added a short section on /<* public >*/
2701 and /*< private *>/.
2703 Wed Aug 4 03:15:19 1999 Owen Taylor <otaylor@redhat.com>
2705 * gtkdoc-mktmpl.in gtkdoc-mkhtml.in: Handle Struct and
2706 Enumerations in approximately the same way as we
2707 handle parameters. That is, instead of (as before)
2708 coding in the tables by hand, one uses lines like:
2710 @width: the width of the rectangle in pixels.
2712 To support migration from the older hand-coded
2713 tables, if none of the members of a structure or
2714 enumeration have a description in a @... line, then
2715 we don't generate the table at all.
2717 Also, gtkdoc-mktmpl now loads up the object heirarchy,
2718 because we need to be able to check if structures
2719 are widget structures.
2721 In general, the coding here is pretty clean, though
2722 the style is a little different. (I'm interating
2723 through strings with m/.../msg; instead of
2724 s/^...//; for one thing.) However, there are a some
2725 of FIXME's where I've whimped out on try to handle
2726 real C syntax, and the need to split out and librarize
2727 a bunch of duplicated code is greater than ever.
2729 1999-06-06 Damon Chaplin <damon@karuna.freeserve.co.uk>
2731 * configure.in: updated version to 0.3.
2733 * doc/style-guide.txt: A couple of minor changes.
2735 * gtkdoc-mkdb.in: Get rid of a couple of messages.
2736 Output an empty <para> if an Arg isn't documented, to keep Jade happy.
2738 1999-05-22 Damon Chaplin <damon@karuna.freeserve.co.uk>
2740 * gtk-doc.dsl.in: Renamed %shade-verbatim-attr-2% to
2741 $shade-verbatim-attr$ and removed our redefinition of
2742 $verbatim-display$ since the stylesheets version now calls
2743 $shade-verbatim-attr$ as a function which is just what we wanted.
2745 * README: Updated info on stylesheet versions supported - 1.40 is
2746 known to be OK (with this version of gtk-doc), 1.19+ may work.
2748 1999-03-31 Damon Chaplin <damon@karuna.freeserve.co.uk>
2750 * configure.in: update version to 0.2 for next release.
2753 * gtkdoc-mkdb.in: added support for 'See Also' section.
2755 * gtk-doc.dsl.in: changed green background color slightly, and
2756 set background color for enum tables.
2758 1999-03-21 Damon Chaplin <damon@karuna.freeserve.co.uk>
2760 * gtkdoc-mkhtml.in (gtkdocdir): use '-w no-idref' to suppress all the
2761 warnings about references to non-existent IDs.
2763 1999-03-18 Damon Chaplin <damon@karuna.freeserve.co.uk>
2765 * gtkdoc-mkdb.in (OutputParamDescriptions): use role="params" for the
2766 table so we can adjust the stylesheet code.
2767 (OutputSGMLFile): Don't output 'one line description goes here'.
2768 (ExpandAbbreviations): allow '-' in #symbol abbreviations, so we can
2769 use #GtkWidget-struct.
2770 (MakeXRef): get rid of special '-struct' suffix, for #GtkWidget-struct.
2772 * gtk-doc.dsl.in: use the "role" attribute on tables to set the
2775 * gtkdoc-scan.in (ScanHeader): fix for scanning functions declared
2776 over multiple lines - was catching things which weren't functions.
2778 1999-03-11 Damon Chaplin <damon@karuna.freeserve.co.uk>
2780 * examples/gnomeui/Makefile.am (clean-local):
2781 * examples/gnome/Makefile.am (clean-local): added *.args
2783 * gtkdoc-mkdb.in: added support for Args and variables. Also a few
2784 minor changes in the output, e.g. don't show macros > 2 lines long.
2787 * gtkdoc-scanobj.in: added support for Args.
2789 * gtkdoc-scan.in: added support for extern'ed variables. Also
2790 accept 'extern' before function declarations.
2792 * gtk-doc.dsl.in: made output prettier. Changed the navigation bars
2793 and the colours used for the various backgrounds.
2795 * doc/style-guide.txt: new file containinf a style guide for writing
2796 the GTK+ documentation.
2798 * doc/README: added description of style-guide.txt
2800 * doc/setting-up.txt: fixed a typo
2802 * README: added a bit about Args.
2804 1999-02-07 Damon Chaplin <damon@karuna.freeserve.co.uk>
2806 * Makefile.am: Removed all the scripts from EXTRA_DIST, as they are
2807 now generated from the .in files which automatically go in the dist.
2809 1999-02-02 Damon Chaplin <damon@karuna.freeserve.co.uk>
2811 * doc/setting-up.txt (scan): removed text which incorrectly said that
2812 changing section titles means you have to recreate the main SGML file.
2814 1999-02-03 Sebastian Wilhelmi <wilhelmi@ira.uka.de>
2816 * configure.in: find perl in $PATH, generate the perl programs
2817 from their *.in counterparts.
2819 * gtkdoc-fixxref, gtkdoc-mkdb, gtkdoc-mktmpl, gtkdoc-scan,
2820 gtkdoc-scanobj: Renamed to *.in and changed /usr/bin/perl to
2821 @PERL@, as determined by configure.
2823 * .cvsignore: Added diverse config* stuff and the new generated
2826 1999-01-28 Damon Chaplin <damon@karuna.freeserve.co.uk>
2828 * gtk-doc.dsl.in: I forgot to make the new refentry code process the
2829 child elements, so it was only outputting anchors for each page.
2831 * doc/setting-up.txt (scan): added step to create MODULE.types file
2832 for modules which contain widgets (or objects).
2834 * gtkdoc-mkdb (OutputStruct): allow spaces inside the public/private
2835 markers, e.g. "/* < public > */"
2837 1999-01-27 Damon Chaplin <damon@karuna.freeserve.co.uk>
2839 * Makefile.am: added scripts to EXTRA_DIST and copied examples, doc
2840 and db2man dirs in dist-hook.
2842 * doc/sections-file.txt: added a couple of examples.
2844 * doc/setting-up.txt: new document describing how to set up a module
2847 * doc/README: added description of setting-up.txt
2849 * README: added short 'Installation' section describing the
2850 --with-dsssl-dir option.
2852 * gtk-doc.dsl.in: also output links to each RefEntry page in the
2853 index.sgml file, so libgnomeui docs can link to widgets. (The widget
2854 hierarchy links were not working before.)
2856 1999-01-26 Damon Chaplin <damon@karuna.freeserve.co.uk>
2858 * gtkdoc-scan (ScanHeader): parse function declarations that have the
2859 return type and name on one line, and the '(' and args on the next.
2860 NOTE: functions with the start of the declaration split over 3 lines
2861 will not be parsed (e.g. return type on one line, function name on
2862 next, and '(' and first argument on the third.) I hope there aren't
2865 * gtkdoc-mkdb (OutputStruct): Use a different SGML ID for widget
2866 structs, since the original ID is used for the entire RefEntry.
2867 Also only show parts of widget structs which are marked with a
2868 comment '/*<public>*/'. Use '/*<private>*/' for private fields.
2870 * gtkdoc-mktmpl (UpdateTemplates): We include widget structs now,
2871 so we do want warnings if they aren't used.
2873 * examples/gnomeui/gnomeui-docs.sgml:
2874 * examples/gnomeui/gnomeui-sections.txt:
2875 * examples/gnomeui/gnomeui.types:
2876 * examples/gnome/gnome-docs.sgml:
2877 * examples/gnome/gnome-sections.txt: sync with latest source.
2879 * examples/configure.in: Add --with-gnome-libs-dir option, so it can
2880 be configured easily.
2881 * examples/gnomeui/Makefile.am (DOC_SOURCE_DIR):
2882 * examples/gnome/Makefile.am (DOC_SOURCE_DIR): use the new
2885 * gtkdoc-mkdb (MergeSourceDocumentation): accept parameters names in
2886 the source which use the wrong case, since there are quite a few of
2889 1999-01-25 Damon Chaplin <damon@karuna.freeserve.co.uk>
2891 * gtkdoc-mktmpl: parse G_GNUC_EXTENSION before typedef'ed types.
2893 * gtkdoc-mkdb: added support for specifying include files in the
2894 MODULE-sections.txt file, to be output at the top of the synopsis.
2896 * doc/sections-file.txt: added description of <INCLUDE> tag.
2898 * examples/gnomeui/gnomeui-sections.txt:
2899 * examples/gnome/gnome-sections.txt: added use of <INCLUDE>
2901 * examples/configure.in: changed 'gtk-reference' to
2902 'gnome-libs-reference'.
2904 1999-01-18 Damon Chaplin <damon@karuna.freeserve.co.uk>
2906 * README: updated my email address & noted that version 1.15+ of the
2907 DocBook modular stylesheets is needed (for $table-width$).
2909 * AUTHORS: updated my email address.
2911 1998-12-20 Jeff Garzik <jgarzik@pobox.com>
2913 * examples/gnomeui/gnomeui-docs.sgml,
2914 examples/gnomeui/gnomeui-sections.txt,
2915 examples/gnomeui/gnomeui.types:
2916 s/gtkspell/gnome-spell/g
2918 1998-12-16 Damon Chaplin <DAChaplin@msn.com>
2920 * gtkdoc-mkdb (ExpandAbbreviations): Allow -ve contants, e.g. %-1.
2921 (ScanSourceFile): Try to handle function descriptions that start
2922 with 'Returns'. It was assuming that they were describing the return
2924 Gets rid of 'Description:' which is sometimes included
2925 at the start of the function description in the source comment blocks.
2926 Makes sure newlines are preserved in the description, as consecutive
2927 newlines are converted to paragraph separators later.
2929 1998-12-15 Damon Chaplin <DAChaplin@msn.com>
2930 * Major changes to the scripts to merge in comments within source code
2931 * gtk-doc-fixxref added
2932 * examples directory added with an example for setting up modules to
2934 * documentation updated
2937 1998-11-28 Damon Chaplin <DAChaplin@msn.com>
2942 * gtkdoc-mkdb: Major changes to make it easy to update the docs
2943 when the API changes. It's pretty much all automatic now.
2944 Also added licenses and function comments, and added 'use strict'.
2945 The Gnome widgets should now be visible in the hierarchy.
2946 Removed a few 'mkdir's which I don't think are necessary now.
2948 Tue Nov 24 16:32:23 1998 Owen Taylor <otaylor@redhat.com>
2950 * README doc/authors.txt: Updated to describe the
2951 new generic scripts instead of the old ones hard-coded
2954 Tue Nov 24 01:06:17 1998 Owen Taylor <otaylor@redhat.com>
2956 * .cvsignore: Added .cvsignore
2958 Tue Nov 24 01:03:47 1998 Owen Taylor <otaylor@redhat.com>
2960 * autogen.sh configure.in: Minor touchups so the newly
2961 imported stuff autogen's correctly.