More docs and planning.
[gtk-doc.git] / ChangeLog
blob4ec3e48e811b420951a008af5637b2d2ce36c4e1
1 2008-10-20  Stefan Kost  <ensonic@users.sf.net>
3         * TODO:
4         * devhelp2.xsd:
5           More docs and planning.
7 2008-10-20  Stefan Kost  <ensonic@users.sf.net>
9         * tests/annotations/docs/tester-docs.xml:
10         * tests/annotations/src/tester.c:
11         * tests/gobject/docs/tester-docs.xml:
12           Update annotations. Glossary enhancements.
14 2008-10-19  Stefan Kost  <ensonic@users.sf.net>
16         * devhelp2.xsd:
17           Update and document format.
19 2008-10-17  Stefan Kost  <ensonic@users.sf.net>
21         * devhelp2.xsd:
22         * devhelp2.xsl:
23           Add new language attribute and use "c" here.
25 2008-10-16  Stefan Kost  <ensonic@users.sf.net>
27         * TODO:
28         * gtkdoc-mktmpl.in:
29           Small comment cleanup and loud thinking in TODO :)
31 2008-10-15  Stefan Kost  <ensonic@users.sf.net>
33         patch by: Jeffrey Stedfast <fejj@novell.com>
35         * examples/Makefile.am:
36         * gtk-doc.make:
37         * gtk-doc.notmpl.make:
38            Allow versioned TARGET_DIR. Fixes #554718.
40 2008-10-13  Stefan Kost  <ensonic@users.sf.net>
42         * TODO:
43           planning.
45         * doc/gtkdoc.dot:
46           Document workflow
47         * devhelp2.xsl:
48           Add support for enums/flags in devhelp index.
50         * gtkdoc-mkdb.in:
51           Support annotations. Fix missing roles.
53         * tests/annotations/docs/tester-docs.xml:
54         * tests/annotations/src/tester.c:
55         * tests/annotations/src/tester.h:
56         * tests/bugs/docs/tester-sections.txt:
57         * tests/gobject/docs/tester-docs.xml:
58           Update new syntax.
60 2008-10-11  Stefan Kost  <ensonic@users.sf.net>
62         * configure.in:
63         * tests/Makefile.am:
64         * tests/annotations.sh:
65         * tests/annotations/Makefile.am:
66         * tests/annotations/docs/Makefile.am:
67         * tests/annotations/docs/tester-docs.xml:
68         * tests/annotations/docs/tester-sections.txt:
69         * tests/annotations/src/Makefile.am:
70         * tests/annotations/src/tester.c:
71         * tests/annotations/src/tester.h:
72           Add testcases for gir annotation.
74 2008-10-03  Stefan Kost  <ensonic@users.sf.net>
76         patch by: Matthew Barnes <mbarnes@redhat.com>
78         * gtkdoc-scan.in:
79         * tests/bugs/docs/tester-sections.txt:
80         * tests/bugs/src/tester.h:
81           Be more careful with "struct _<struct_name>". Fixes #554833.
83 2008-10-03  Stefan Kost  <ensonic@users.sf.net>
85         patch by: Behdad Esfahbod <behdad@gnome.org>
87         * gtk-doc.make:
88         * gtk-doc.notmpl.make:
89         * tests/gtk-doc.make:
90         * tests/gtk-doc.notmpl.make:
91           Add rules to create $(REPORT_FILES). Fixes #552822.
93 2008-10-03  Stefan Kost  <ensonic@users.sf.net>
95         patch by: Simon Josefsson <simon@josefsson.org>
97         * examples/Makefile.am:
98         * tests/bugs/docs/Makefile.am:
99         * tests/gobject/docs-tmpl/Makefile.am:
100         * tests/gobject/docs/Makefile.am:
101           Use GTKDOC_CFLAGS instead of INCLUDES in Makefile.am. Fixes #553407.
103 2008-09-24  Stefan Kost  <ensonic@users.sf.net>
105         * gtkdoc-mkdb.in:
106           Use full symbol, if it does not belong to the namespace.
108 2008-09-22  Stefan Kost  <ensonic@users.sf.net>
110         * tests/gobject/src/gobject.h:
111           Document some odd behaviour.
113 2008-09-22  Stefan Kost  <ensonic@users.sf.net>
115         * TODO:
116           More todos.
118         * tests/bugs/docs/tester-sections.txt:
119         * tests/bugs/src/tester.c:
120         * tests/bugs/src/tester.h:
121           Add testcase for bug 552602.
123         * tests/gtk-doc.make:
124         * tests/gtk-doc.notmpl.make:
125           Also use new RUN envvar here.
127 2008-09-10  Stefan Kost  <ensonic@users.sf.net>
129         * gtkdoc-mkdb.in:
130           Generate unique ids for properties, style and child properties.
131   
132         * gtk-doc.make:
133         * gtk-doc.notmpl.make:
134         * gtkdoc-scan.in:
135         * gtkdoc-scangobj.in:
136           If we use libtool, run scanner under libtool to use uninstalled
137           libraries.
139 2008-09-04  Stefan Kost  <ensonic@users.sf.net>
141         * gtkdoc-mkhtml.in:
142           Fix comparision.
144         * TODO:
145           ideas.
147         * configure.in:
148         * gtk-doc-fo.xsl:
149         * gtk-doc.xsl:
150         * gtkdoc-common.pl.in:
151         * gtkdoc-mkdb.in:
152         * help/manual/C/gtk-doc-manual.xml:
153         * tests/bugs/docs/Makefile.am:
154         * tests/bugs/docs/tester-docs.xml:
155         * tests/gobject/docs-tmpl/Makefile.am:
156         * tests/gobject/docs-tmpl/tester-docs.xml:
157         * tests/gobject/docs/Makefile.am:
158         * tests/gobject/docs/tester-docs.xml:
159         * tests/gobject/src/gobject.h:
160           Switch to docbook 4.3 dtd. Fixes #487727.
161           Add --name-space option to gtkdoc-mkdb for nicer indexes. Start with a
162           fo wrapper for pdf output.
164 2008-09-04  Stefan Kost  <ensonic@users.sf.net>
166         * gtk-doc.make:
167         * gtk-doc.notmpl.make:
168           Don't install index.sgml twice. Also remove the " || :;" construct
169           that ssems to be there only to eat the return code. 
171 2008-07-23  Stefan Kost  <ensonic@users.sf.net>
173         * gtkdoc-mkdb.in:
174         * gtkdoc-scan.in:
175         * tests/bugs/docs/tester-sections.txt:
176         * tests/bugs/src/tester.h:
177           Accept "char const *" as well. Fixes #544172.
179 2008-07-21  Stefan Kost  <ensonic@users.sf.net>
181         * gtk-doc.make:
182         * gtk-doc.notmpl.make:
183           Only specify options if gtkdoc-mkhtml can take them. Fixes #543855.
185         * gtkdoc-mkhtml.in:
186           Don't use bash specific features. Be more flexible so that we can add
187           more options.
189 2008-07-09  Stefan Kost  <ensonic@users.sf.net>
191         * gtkdoc-scan.in:
192           Fix struct/enum level parsing which could go one to high and then the
193           main struct would never be closed. 
194           Fixes #542137
196 2008-06-28  Stefan Kost  <ensonic@users.sf.net>
198         * autogen.sh:
199           Mention why this change is bad.
201 2008-06-28  Stefan Kost  <ensonic@users.sf.net>
203         patch by: David Nečas <yeti@physics.muni.cz>
205         * examples/Makefile.am:
206         * gtk-doc.make:
207         * gtk-doc.notmpl.make:
208         * gtkdoc-mkhtml.in:
209         * tests/gtk-doc.make:
210         * tests/gtk-doc.notmpl.make:
211           Add searchpath to gtkdoc.mkhtml. Fixes #460753
213 2008-06-22  Stefan Kost  <ensonic@users.sf.net>
215         * autogen.sh:
216           To support timj aclocal setup we are shipping gnome-doc-utils.m4
217           and making sure automake picks it up ;)
219 2008-06-22  Stefan Kost  <ensonic@users.sf.net>
221         * tools/migratetmpl.pl:
222           We were still removing too many <para>s.
223           Also add andrews trick to escape the c comments.
224           Add a newline to empty param docs.
226 2008-06-22  Stefan Kost  <ensonic@users.sf.net>
228         * m4/gnome-doc-utils.m4:
229           Add this to svn, so that bootstrap work where no gnome-doc-utils is
230           available yet.
232 2008-06-21  Stefan Kost  <ensonic@users.sf.net>
234         * tools/migratetmpl.pl:
235           Factor out multiline formatting and use for deprecated field too.
237 2008-06-21  Stefan Kost  <ensonic@users.sf.net>
239         * gtkdoc-mkdb.in:
240           Commenting.
242         * tools/migratetmpl.pl:
243           Convert character entities back.
245 2008-06-21  Stefan Kost  <ensonic@users.sf.net>
247         * TODO:
248           Start collection info about slowly deprecating crack.
250         * tools/migratetmpl.pl:
251           Add title.
253 2008-06-21  Stefan Kost  <ensonic@users.sf.net>
255         * tools/migratetmpl.pl:
256           Use $file in section comment not title. Convert only standalone para
257           tags.
259 2008-06-21  Stefan Kost  <ensonic@users.sf.net>
261         * tools/migratetmpl.pl:
262           Convert @Varargs: to @...:
264 2008-06-21  Stefan Kost  <ensonic@users.sf.net>
266         * tools/migratetmpl.pl:
267           Convert single line c comments to c++ ones. Indent multiline parameter docs.
269 2008-06-16  Stefan Kost  <ensonic@users.sf.net>
271         * gtkdoc-mktmpl.in:
272           Don't reuse file var, fixes warning context.
273   
274         * gtkdoc-scan.in:
275           Also accept *.hh as headers suffix.
277 2008-06-10  Stefan Kost  <ensonic@users.sf.net>
279         * gtk-doc.make:
280         * gtk-doc.notmpl.make:
281         * tests/gtk-doc.make:
282         * tests/gtk-doc.notmpl.make:
283           Include original CFLAGS / LDFLAGS when building the scanner. Allows to
284           have own FLAGS defined in addition.
286 2008-06-08  Stefan Kost  <ensonic@users.sf.net>
288         * TODO:
289           More planning.
291 2008-06-08  Stefan Kost  <ensonic@users.sf.net>
293         * TODO:
294           Add more ideas.
295   
296         * gtkdoc-scangobj.in:
297         * gtkdoc-scanobj.in:
298           Merge two fwrite calls.
299   
300         * tests/gobject/examples/gobject.c:
301         * tests/gobject/src/gobject.c:
302           Demostrate how to include source fragments from external files.
304         * tests/gobject/src/giface.h:
305         * tests/gobject/src/gobject.h:
306           Documents two entries.
308 2008-06-07  Sebastian Dröge  <slomo@circular-chaos.org>
310         * gtkdoc-scangobj.in:
311         * gtkdoc-scanobj.in:
312         Add "%s" format strings to printf-like functions when printing
313         a string. Fixes #536980.
315 2008-06-05  Stefan Kost  <ensonic@users.sf.net>
317         * gtkdoc-fixxref.in:
318         * gtkdoc-mkdb.in:
319         * gtkdoc-mktmpl.in:
320           Fix quoting.
322         * tools/migratetmpl.pl:
323           Add first version of a tool to support migration from tmpl docs to
324           source code comments.
326 2008-06-04  Stefan Kost  <ensonic@users.sf.net>
328         * autogen.sh:
329           Correct invocation for gnome-doc-prepare.
331 2008-06-04  Stefan Kost  <ensonic@users.sf.net>
333         * gtkdoc-common.pl.in:
334           Handle file or line being undefined.
336         * gtkdoc-mkdb.in:
337           Warn about repeated symbols in sections. Also give line of previous
338           occurrance. Also give that info for double file entries. Fixes #473342
339           Give correct error locate for one warning. Fixes #532395 partialy
341 2008-06-04  Stefan Kost  <ensonic@users.sf.net>
343         * gtkdoc-mkdb.in:
344           Don't warn about overriden docs comment if its the same text.
346 2008-06-03  Stefan Kost  <ensonic@users.sf.net>
348         * TODO:
349           Spelling.
351         * gtkdoc-mkdb.in:
352           Warn and skip double file entries in section files.
353           
354         * gtkdoc-mktmpl.in:
355           Use the new warning format in this script too.
357         * gtkdoc-rebase.in:
358           Also use optional parameters here.
360 2008-06-02  Stefan Kost  <ensonic@users.sf.net>
362         * tests/gobject/docs-tmpl/tester-docs.xml:
363         * tests/gobject/docs-tmpl/tester-sections.txt:
364         * tests/gobject/docs/tester-docs.xml:
365         * tests/gobject/docs/tester-sections.txt:
366         * tests/gobject/src/giface.c:
367         * tests/gobject/src/gobject.c:
368         * tests/gobject/src/gobject.h:
369           Add some since: tags for the tests too.
371 2008-06-02  Stefan Kost  <ensonic@users.sf.net>
373         * TODO:
374           tody up and add some comments regarding HTML_DIR.
376         * gtkdoc-fixxref.in:
377           HTML_DIR is not neccesarily set.
379         * gtkdoc-mkhtml.in:
380           Fix uninstalled.
382         * tests/gobject/docs-tmpl/tester-docs.xml:
383         * tests/gobject/docs/tester-docs.xml:
384           Add more chapter id's and experiment with an index chapter.     
386 2008-06-02  Stefan Kost  <ensonic@users.sf.net>
388         * style.css:
389           Improve spacing on indicies and glossaries.
391 2008-06-02  Stefan Kost  <ensonic@users.sf.net>
393         * TODO:
394         * tests/bugs/docs/tester-docs.xml:
395         * tests/gobject/docs/tester-docs.xml:
396         * tests/gobject/docs/tester-sections.txt:
397         * tests/gobject/docs-tmpl/tester-docs.xml:
398         * tests/gobject/docs-tmpl/tester-sections.txt:
399         * tests/gobject/src/gobject.c:
400         * tests/gobject/src/gobject.h:
401         * tests/gtk-doc.make:
402         * tests/gtk-doc.notmpl.make:
403           Add some index lists to the tests. Add a deprecated function.
405 2008-06-02  Stefan Kost  <ensonic@users.sf.net>
407         patch by: Felix Riemann <friemann@svn.gnome.org>
409         * gtk-doc.xsl:
410         * style.css:
411           Produce valid html. Fixes #534627.
413 2008-05-23  Stefan Kost  <ensonic@users.sf.net>
415         * configure.in:
416         * tests/gobject/Makefile.am:
417         * tests/gobject/docs-tmpl/Makefile.am:
418         * tests/gobject/docs-tmpl/tester-docs.xml:
419         * tests/gobject/docs-tmpl/tester-sections.txt:
420         * tests/gobject/docs-tmpl/tester.types:
421         * tests/gtk-doc.make:
422         * tests/gtk-doc.notmpl.make:
423           Build same docs once again with old tmpl approach.
425 2008-05-23  Stefan Kost  <ensonic@users.sf.net>
427         * tests/bugs/docs/Makefile.am:
428         * tests/gobject/docs/Makefile.am:
429         * tests/gtk-doc.make:
430         * tests/gtk-doc.notmpl.make:
431           Sync names.
433 2008-05-08  Stefan Kost  <ensonic@users.sf.net>
435         * gtkdoc-mkdb.in:
436         * gtkdoc-mktmpl.in:
437           Fix a long standing bug that killed spaces in tmpl files.
439 2008-05-05  Stefan Kost  <ensonic@users.sf.net>
441         * gtkdoc-mkdb.in:
442           Fix regexps changes from previous commit. When using /e the
443           replacement part has to be a perl snippet.
445 2008-05-05  Stefan Kost  <ensonic@users.sf.net>
447         * gtkdoc-mkdb.in:
448         * tests/bugs/docs/tester-sections.txt:
449         * tests/bugs/src/tester.h:
450           Don't expand '#' in ulink tags. Also allow to escape "#%@" with '\'.
451           Add to testsuite. Fixes #530758
453 2008-05-05  Stefan Kost  <ensonic@users.sf.net>
455         * gtkdoc-mktmpl.in:
456           It is GObject not GtkObject anymore
458 2008-05-05  Stefan Kost  <ensonic@users.sf.net>
460         * TODO:
461           Make note about expanding urls.
463         * help/manual/C/gtk-doc-manual.xml:
464           Document the use of |[ ]| as a shortcut for program listing.
466         * tests/gobject/src/giface.h:
467         * tests/gobject/src/gobject.c:
468           Fix one undocumented symbol and add an exampl of the programlisting
469           shortcut.
471 2008-04-23  Stefan Kost  <ensonic@users.sf.net>
473         reviewed by: <delete if not using a buddy>
474         patch by: <delete if not someone else's patch>
476         * gtkdoc-mkdb.in:
477         * gtkdoc-mkman.in:
478         * gtkdoc-mktmpl.in:
480 2008-04-22  Stefan Kost  <ensonic@users.sf.net>
482         * HACKING:
483           We need to update the webpage.
485         * TODO:
486         * configure.in:
487           Planning.
489         * gtkdoc-mkdb.in:
490           Hopefully now unbreak the docbuild, if one has template but not uses
491           them.
493 2008-04-17  Stefan Kost  <ensonic@users.sf.net>
495         * gtkdoc-mkdb.in:
496           Add one more warning. Also trac location of section docs. Merge
497           source symbols once and then on demand (if we read a template).
499 2008-04-11  Stefan Kost  <ensonic@users.sf.net>
501         * TODO:
502         * configure.in:
503           Idea about the tracing. Not that practical as it is.
505         * gtkdoc-mkdb.in:
506         * gtkdoc-mktmpl.in:
507           Unify file-error messages. Improve warning detail. Fix undocumented
508           status for template less runs.
510 2008-04-10  Stefan Kost  <ensonic@users.sf.net>
512         * TODO:
513           Ideas.
515         * gtkdoc-common.pl.in:
516           Add common method for prining (gcc-style) warnings.
518         * gtkdoc-mkdb.in:
519           Use new method. Harmonize the warnings a bit. Remember locations
520           symbols are taken from template files for use in warnings.
522 2008-04-09  Stefan Kost  <ensonic@users.sf.net>
524         * HACKING:
525           Some releasing info.
527         * gtkdoc-mkdb.in:
528           Print file/line number in warning.
530         * help/manual/C/gtk-doc-manual.xml:
531           Some docs for what the <module>-overrides.txt file is for.
533 2008-03-23  Stefan Kost  <ensonic@users.sf.net>
535         * autogen.sh:
536           Tell automake to not warn us about portabillity issues. Its too late
537           for that.
539         * ChangeLog:
540           Surgery for the bugnumber.
542 2008-03-21  Marc-Andre Lureau <marcandre.lureau@gmail.com>
544         * .svnignore, Makefile.am, autogen.sh, configure.in,
545         help/manual/.svnignore, help/manual/C/ChangeLog,
546         help/manual/C/Makefile.am, help/manual/C/gtk-doc-manual-C.omf.in,
547         help/manual/C/gtk-doc-manual.xml, help/manual/ChangeLog,
548         help/manual/Makefile.am, help/manual/gtk-doc-manual.omf.in,
549         m4/.svnignore, omf.make, xmldocs.make:
550         GNOME doc-utils migration.  Fixes #335239
552 2008-03-22  Stefan Kost  <ensonic@users.sf.net>
554         * HACKING:
555         * configure.in:
556         * help/manual/C/gtk-doc-manual.xml:
557           Back to development.
559 === Release 1.10 ===
561 2008-03-19  Stefan Kost  <ensonic@users.sf.net>
563         * NEWS:
564         * HACKING:
565           Prepare for release.
567         * style.css:
568           Add fix for footnote positions.
570 2008-02-27  Stefan Kost  <ensonic@users.sf.net>
572         patch by: Carlos Garnacho <carlos@imendio.com>
574         * tools/gtk-doc.el:
575           Update emacs mode to work with emacs22. Fixes #513318.
577 2008-02-01  Stefan Kost  <ensonic@users.sf.net>
579         * gtkdoc-common.pl.in:
580         * gtkdoc-mkdb.in:
581         * gtkdoc-mktmpl.in:
582         * tests/bugs/src/tester.h:
583           Improve tmpl parsing and add some more logging. Fixes #512154.
585 2008-01-30  Stefan Kost  <ensonic@users.sf.net>
587         * tests/bugs/docs/tester-sections.txt:
588         * tests/bugs/src/tester.h:
589           Add testcase for #512154.
591 2008-01-28  Stefan Kost  <ensonic@users.sf.net>
593         * gtkdoc-mkdb.in:
594           Condense all the multiple newlines in the generated xml.
596         * tests/gtk-doc.make:
597           Make sure the testsuite call the uninstalled scripts.
599 2008-01-24  Stefan Kost  <ensonic@users.sf.net>
601         * gtk-doc.xsl:
602           Unbreak fixxref. The index.sgml file should not have leading
603           whitespace. These were caused by indenting the xsl, which is dangerous
604           in case of <xsl:text>.
606         * gtkdoc-fixxref.in:
607           Debug logging.
609 2008-01-21  Stefan Kost  <ensonic@users.sf.net>
611         * gtkdoc-common.pl.in:
612           Don't warn when parsing enum struct members.
614 2008-01-21  Stefan Kost  <ensonic@users.sf.net>
616         * gtkdoc-mkdb.in:
617         * gtkdoc-mktmpl.in:
618           Give file and line number when complaining about duplicate
619           definitions. Seems to not have been applied with older commit.
621         * gtkdoc-scan.in:
622         * tests/gobject/src/gobject.h:
623           Handle typedef enums.
625 2008-01-17  Stefan Kost  <ensonic@users.sf.net>
627         * gtk-doc.make:
628         * gtk-doc.notmpl.make:
629           Don't fail in dist when no .types file is present. Fixes #509539.
631 2008-01-16  Stefan Kost  <ensonic@users.sf.net>
633         * gtkdoc-mkdb.in:
634         * gtkdoc-mktmpl.in:
635           Give file and line number when complaining about duplicate
636           definitions.
638 2008-01-14  Stefan Kost  <ensonic@users.sf.net>
640         patch by: Joe Marcus Clarke <marcus@freebsd.org>
642         * gtk-doc.make:
643         * gtk-doc.notmpl.make:
644           Do not abort the build, if gtk-doc is not installed. Fixes #508897
646 2007-12-20  Mathias Hasselmann  <mathias@openismus.com>
648         * configure.in:
649         Lower Python dependency to 2.3 (#503054). Just warn when Python
650         wasn't found. Print a configuration summary before leaving the
651         configure script.
652         * Makefile.am:
653         Do not install gtkdoc-depscan when Python wasn't found.
655 2007-12-20  Mathias Hasselmann  <mathias@openismus.com>
657         * gtkdoc-depscan.in:
658         Use old and/or pattern instead of the new ternary operator.
659         This drops the Python 2.5 dependency for that script.
660         Original patch by Frederic Peters. (#503054)
662 2007-12-17  Mathias Hasselmann  <mathias@openismus.com>
664         * configure.in:
665           Use AM_PATH_PYTHON instread of AC_PATH_PROG to find Python.
666           (#503710)
668 2007-12-17  Stefan Kost  <ensonic@users.sf.net>
670         * gtk-doc.xsl:
671           Render accronyms from docbook and glossary in html.
673 2007-12-17  Stefan Kost  <ensonic@users.sf.net>
675         * tests/bugs/docs/tester-docs.sgml:
676         * tests/bugs/docs/tester-docs.xml:
677         * tests/gobject/docs/tester-docs.sgml:
678         * tests/gobject/docs/tester-docs.xml:
679           Add the xml instead of the sgml docs.
681 2007-12-12  Stefan Kost  <ensonic@users.sf.net>
683         * gtk-doc.make:
684         * gtk-doc.notmpl.make:
685           Revert last change and reopen #503119. Needs a different fix.
687 2007-12-12  Stefan Kost  <ensonic@users.sf.net>
689         * gtk-doc.make:
690         * gtk-doc.notmpl.make:
691           Use content_files as a dependency the sgml-build.stamp.
693 2007-12-11  Mathias Hasselmann  <mathias@openismus.com>
695         * gtkdoc-depscan.in:
696           Use colon as name-version-separator in book names.
698 2007-12-11  Mathias Hasselmann  <mathias@openismus.com>
700         * gtkdoc-depscan.in:
701           Also scan devhelp folders.
703 2007-12-11  Mathias Hasselmann  <mathias@openismus.com>
705         * gtkdoc-depscan.in: 
706           Print reasonable error message when passing
707           non-existant files on command line.
709 2007-12-11  Stefan Kost  <ensonic@users.sf.net>
711         patch by: Kouhei Sutou <kou@cozmixng.org>
713         * gtk-doc.xsl:
714           Consitently use UTF-8 instead of US-ASCII for output encoding.
715           Fixes #497367
717 2007-12-10  Mathias Hasselmann  <mathias@openismus.com>
719         * configure.in:
720         * gtkdoc-depscan.in:
721         * Makefile.am:
722           Add gtkdoc-depscan, which resolves source code dependencies
723           by scanning devhelp2 books.
725 2007-12-10  Stefan Kost  <ensonic@users.sf.net>
727         * devhelp2.xsd:
728           Update schema.
729           
730         * gtk-doc.notmpl.make:
731           Remove left-over 'fi'.
733 2007-12-05  Stefan Kost  <ensonic@users.sf.net>
735         * gtk-doc.make:
736         * gtk-doc.notmpl.make:
737           Better fix for #501066.
739 2007-12-05  Stefan Kost  <ensonic@users.sf.net>
741         * devhelp2.xsd:
742           Add first version of the schema.
743           
744         * devhelp2.xsl:
745           Unbreak the devhelp2 file generation.
747         * tests/gtkdoctest.sh:
748           Add comment about doing schmea checks once they work.
750 2007-12-04  Stefan Kost  <ensonic@users.sf.net>
752         * gtk-doc.make:
753         * gtk-doc.notmpl.make:
754           Apply build flags cleanups from #498521. Spotted by
755           dmacks@netspace.org.
757 2007-12-04  Stefan Kost  <ensonic@users.sf.net>
759         * tests/gobject/src/giface.c:
760         * tests/gobject/src/gobject.c:
761           Uhm, unbreak the links in the test docs.
763 2007-12-04  Stefan Kost  <ensonic@users.sf.net>
765         * tests/gobject/src/giface.c:
766         * tests/gobject/src/gobject.c:
767           Little test cleanup. The bug was already fixed.
769 2007-12-04  Stefan Kost  <ensonic@users.sf.net>
771         * tests/gobject/docs/tester-sections.txt:
772         * tests/gobject/docs/tester.types:
773         * tests/gobject/src/Makefile.am:
774         * tests/gobject/src/giface.c:
775         * tests/gobject/src/giface.h:
776         * tests/gobject/src/gobject.c:
777         * tests/gobject/src/gobject.h:
778         * tests/gobject/src/tester.c:
779         * tests/gobject/src/tester.h:
780           Refactor tests for #489279.
782 2007-12-04  Stefan Kost  <ensonic@users.sf.net>
784         * gtkdoc-common.pl.in:
785         * tests/bugs/docs/tester-sections.txt:
786         * tests/bugs/src/tester.h:
787           Add testcase for #501038. Improve struct parsing to correctly finish
788           if the last line in struct declaration was a preprocessor statement.
789           Fixes  #501038.
791 2007-12-04  Stefan Kost  <ensonic@users.sf.net>
793         patch by: David Nečas <yeti@physics.muni.cz>
795         * gtkdoc-common.pl.in:
796         * tests/bugs/docs/tester-sections.txt:
797         * tests/bugs/src/tester.c:
798         * tests/bugs/src/tester.h:
799           Handle forward typedef'd enums. Fixes #446648.
801 2007-12-02  Loïc Minier  <lool@dooz.org>
803         * gtk-doc.make:
804         * gtk-doc.notmpl.make:
805           Add double-quotes around `which gtkdoc-rebase` to prevent "test"
806           from failing with "/bin/sh: line 11: test: !=: unary operator
807           expected ".  Fixes #501066.
809 2007-11-11  Stefan Kost  <ensonic@users.sf.net>
811         patch by: David Nečas <yeti@physics.muni.cz>
813         * gtk-doc.xsl:
814         * gtkdoc-mkdb.in:
815           Avoid generated node ids. Fixes #365913.
817 2007-11-11  Stefan Kost  <ensonic@users.sf.net>
819         * gtk-doc.xsl:
820         * gtkdoc-mkdb.in:
821         * style.css:
822           Alternative and cleaner footer implementation (unblock #365913).
824 2007-11-11  Stefan Kost  <ensonic@users.sf.net>
826         patch by: David Nečas <yeti@physics.muni.cz>
828         * gtkdoc-mkdb.in:
829         * gtkdoc-scangobj.in:
830           Display proper types for pointer properties. Fixes #468278.
832 2007-10-31  Stefan Kost  <ensonic@users.sf.net>
834         * gtkdoc-mkdb.in:
835           Only warn about missing deprecation guards for declared symbols.
836           Fixes #492005.
838 2007-10-31  Stefan Kost  <ensonic@users.sf.net>
840         * tests/gtk-doc.make:
841         * tests/gtkdoctest.sh:
842           Run our own check script. Clean the make output a bit.
844 2007-10-31  Stefan Kost  <ensonic@users.sf.net>
846         * help/manual/C/gtk-doc-manual.xml:
847           Small doc fix.
849 2007-10-31  Stefan Kost  <ensonic@users.sf.net>
851         * Makefile.am:
852           Formatting.
854         * configure.in:
855         * tests/gtk-doc.make:
856           Cleanup the 'make check' deps configure check.
858 2007-10-01  Stefan Kost  <ensonic@users.sf.net>
860         * configure.in:
861         * help/manual/C/gtk-doc-manual.xml:
862           Back to development.
864 === Release 1.9 ===
866 2007-09-30  Stefan Kost  <ensonic@users.sf.net>
868         * NEWS:
869           Releasing 1.9.
871 2007-09-27  Stefan Kost  <ensonic@users.sf.net>
873         * gtk-doc.make:
874         * gtk-doc.notmpl.make:
875         * gtkdoc-rebase.in:
876           New day, new fix. Remove testing $(DESTDIR) from makefile and use
877           Getopt::Long qw(:config gnu_getopt); in rebase.
879 2007-09-26  Stefan Kost  <ensonic@users.sf.net>
881         * gtk-doc.make:
882           And actually saving before commiting might greatly help.
884 2007-09-26  Stefan Kost  <ensonic@users.sf.net>
886         * gtk-doc.make:
887         * gtk-doc.notmpl.make:
888           Another attempt to fix the rules.
890 2007-09-26  Stefan Kost  <ensonic@users.sf.net>
892         * gtk-doc.make:
893         * gtk-doc.notmpl.make:
894           If there is nothing to install, don't rebase.
896 2007-09-26  Stefan Kost  <ensonic@users.sf.net>
898         * gtk-doc.make:
899         * gtk-doc.notmpl.make:
900           Unbreak the last change.
902 2007-09-26  Stefan Kost  <ensonic@users.sf.net>
904         * gtk-doc.make:
905         * gtk-doc.notmpl.make:
906           Handle DESTDIR= case.
908 2007-09-26  Stefan Kost  <ensonic@users.sf.net>
910         * gtk-doc.make:
911         * gtk-doc.notmpl.make:
912         * gtkdoc-rebase.in:
913           Fix destdir option name.
915 2007-09-25  Stefan Kost  <ensonic@users.sf.net>
917         * tests/gtk-doc.make:
918           Get make distcheck fully working.
920 2007-09-25  Stefan Kost  <ensonic@users.sf.net>
922         * tests/Makefile.am:
923         * tests/bugs.sh:
924         * tests/gobject.sh:
925         * tests/gtkdoctest.sh:
926           Try to get make distcheck to run.
928         * tests/gtk-doc.make:
929           Don't dist docs generated during test runs and remove some cruft.
932 2007-09-24  Stefan Kost  <ensonic@users.sf.net>
934         patch by: David Nečas <yeti@physics.muni.cz>
936         * NEWS:
937         * tests/bugs/docs/Makefile.am:
938         * tests/gobject/docs/Makefile.am:
939         * tests/gtk-doc.make:
940           Adapt xml/ cleaning from gtk-doc.notmpl.make.  Clean log files.
942 2007-09-24  Stefan Kost  <ensonic@users.sf.net>
944         * NEWS:
945           Current release notes.
947 2007-09-24  Stefan Kost  <ensonic@users.sf.net>
949         * MAINTAINERS:
950           Make mango happy.
952         * examples/Makefile.am:
953         * gtk-doc.make:
954         * gtk-doc.notmpl.make:
955           Process files from DISTCLEANFILES in the dist-hooks.
957 2007-09-24  Stefan Kost  <ensonic@users.sf.net>
959         patch by: David Nečas <yeti@physics.muni.cz>
961         * Makefile.am:
962           Add gtk-doc.notmpl.make to EXTRA_DIST. Fixes #479913.
964 2007-09-20  Stefan Kost  <ensonic@users.sf.net>
966         * gtkdoc-fixxref.in:
967           Revert online option for fixxref now that we have a rebase command.
969 2007-09-18  Stefan Kost  <ensonic@users.sf.net>
971         * gtkdoc-scan.in:
972           Handle function pointers. Fixes #477532.
974 2007-09-18  Stefan Kost  <ensonic@users.sf.net>
976         patch by: David Nečas <yeti@physics.muni.cz>
978         * gtkdoc-scan.in:
979           Parse reoccuring const. Fixes #471014.
981         * tests/bugs/docs/Makefile.am:
982         * tests/bugs/docs/tester-sections.txt:
983         * tests/bugs/src/tester.c:
984         * tests/bugs/src/tester.h:
985         * tests/gobject/docs/Makefile.am:
986         * tests/gobject/src/tester.c:
987         * tests/gobject/src/tester.h:
988           Add more tests and cleanup the test-code a little.
990 2007-09-17  Stefan Kost  <ensonic@users.sf.net>
992         * gtk-doc.make:
993         * gtk-doc.notmpl.make:
994           Revert some Makefile improvements, as we can't control the quoting
995           reliably.
997 2007-09-11  Stefan Kost  <ensonic@users.sf.net>
999         * gtkdoc-mkdb.in:
1000           Default master doc should have proper extension. Fixes #467773.
1002 2007-09-11  Stefan Kost  <ensonic@users.sf.net>
1004         patch by: David Nečas <yeti@physics.muni.cz>
1006         * gtk-doc.make:
1007         * gtk-doc.notmpl.make:
1008           Makefile improvements.
1010 2007-09-03  Stefan Kost  <ensonic@users.sf.net>
1012         * MAINTAINERS:
1013           Update MAINTAINER to adhere to rules given on
1014           http://live.gnome.org/MaintainersCorner#maintainers
1016 2007-08-23  Benjamin Otte  <otte@gnome.org>
1018         * gtkdoc-mktmpl.in:
1019           sync with gtkdoc-mkdb completely. Really fixes #419997
1021 2007-08-21  Stefan Kost  <ensonic@users.sf.net>
1023         * gtkdoc-mkdb.in:
1024         * style.css:
1025           Add divider and empty space at the bottom. Mostly fixes #448879.
1027 2007-08-21  Stefan Kost  <ensonic@users.sf.net>
1029         * gtk-doc.make:
1030         * gtk-doc.notmpl.make:
1031           Make use of rebase if possible. Fixes #465920
1033         * gtkdoc-rebase.in:
1034           Rebase improvements and fixes.          
1036 2007-08-16  Stefan Kost  <ensonic@users.sf.net>
1038         * .cvsignore:
1039         * help/.cvsignore:
1040         * help/manual/.cvsignore:
1041         * help/manual/C/.cvsignore:
1042           Get rid of cvsignore files.
1044 2007-08-14  Stefan Kost  <ensonic@users.sf.net>
1046         * gtkdoc-common.pl.in:
1047         * tests/bugs/docs/tester-sections.txt:
1048         * tests/bugs/src/tester.h:
1049           Don't die when encountering #if/#endif in enums. Fixes #324535.
1051 2007-08-14  Stefan Kost  <ensonic@users.sf.net>
1053         patch by: Frederic Peters <fpeters@0d.be>
1055         * style.css:
1056           Styling hr tags.
1058 2007-08-14  Stefan Kost  <ensonic@users.sf.net>
1060         * help/manual/C/gtk-doc-manual.xml:
1061           Document new features and bump version.
1063 2007-08-13  Stefan Kost  <ensonic@users.sf.net>
1065         * gtkdoc-mkdb.in:
1066           Fix the funny side-effect of last 'broken-returns' fix.
1068 2007-08-13  Stefan Kost  <ensonic@users.sf.net>
1070         * gtkdoc-scan.in:
1071         * tests/bugs/src/tester.h:
1072           Really fix #460127.
1074 2007-08-13  Stefan Kost  <ensonic@users.sf.net>
1076         * gtkdoc-mkdb.in:
1077           Now the 'broken' returns seems to work better. Fixes #380824 more.
1079 2007-08-13  Stefan Kost  <ensonic@users.sf.net>
1081         * tests/bugs/docs/tester-sections.txt:
1082         * tests/bugs/src/tester.c (bug_379466, bug_380824):
1083         * tests/bugs/src/tester.h (test):
1084           New test.
1085         * tests/gtkdoctest.sh:
1086           Fix bashism.
1088 2007-08-12  Stefan Kost  <ensonic@users.sf.net>
1090         * tests/bugs/docs/tester-sections.txt:
1091         * tests/bugs/src/tester.h:
1092           Add another test for a bug we fixed with the changes below.
1093           Fixes #460127.
1095 2007-08-12  Stefan Kost  <ensonic@users.sf.net>
1097         * gtkdoc-scan.in:
1098         * tests/bugs/docs/tester-sections.txt:
1099         * tests/bugs/src/tester.c:
1100         * tests/bugs/src/tester.h:
1101           Improved scan logic. Fixes #411739.
1103 2007-08-12  Stefan Kost  <ensonic@users.sf.net>
1105         * gtkdoc-mkdb.in:
1106         * tests/bugs/src/tester.h:
1107           Handle newline in declarations better. Fixes #379466.
1108           Ensure space in multiline declarations when removing the newline.
1109           Fix missing argument docs in template free build.
1111 2007-08-12  Stefan Kost  <ensonic@users.sf.net>
1113         * gtkdoc-mkdb.in:
1114         * gtkdoc-mktmpl.in:
1115           Handle "unsigned long|unsigned short|signed long|signed short".
1116           Fixes #445693.
1118 2007-08-12  Stefan Kost  <ensonic@users.sf.net>
1120         * Makefile.am:
1121         * configure.in:
1122         * gtkdoc-check:
1123         * gtkdoc-check.in:
1124           Replacing my shell based test script by Davids perl based one. Add
1125           licence, copyright and docs header. Integrate with build.
1127 2007-08-12  Stefan Kost  <ensonic@users.sf.net>
1129         patch by: David Nečas <yeti@physics.muni.cz>
1131         * gtkdoc-scangobj.in:
1132           Make introspection of interfaces work in more cases. Fixes #355352.
1134 2007-08-12  Stefan Kost  <ensonic@users.sf.net>
1136         patch by: David Nečas <yeti@physics.muni.cz>
1138         * configure.in:
1139           Cleanup glib detection for tests.
1141 2007-08-11  Stefan Kost  <ensonic@users.sf.net>
1143         * gtkdoc-check:
1144           Fix modulename check.
1146 2007-08-11  Stefan Kost  <ensonic@users.sf.net>
1148         * Makefile.am:
1149           Install new makefile.
1151         * configure.in:
1152           Bump version as we're working on 1.9.
1154         * gtkdocize.in:
1155           Add option to select makefile-flavour.
1157 2007-08-11  Stefan Kost  <ensonic@users.sf.net>
1159         * gtk-doc.make:
1160           Add dummy rule to make first build run through. Fixes #156643
1162 2007-08-11  Stefan Kost  <ensonic@users.sf.net>
1164         * style.css:
1165           Hide fixed navigationbar when printing. Fixes #449618
1167 2007-08-11  Stefan Kost  <ensonic@users.sf.net>
1169         * gtk-doc.notmpl.make:
1170           Add new makefile for tmpl-less build.
1172 2007-08-11  Stefan Kost  <ensonic@users.sf.net>
1174         patch by: David Nečas <yeti@physics.muni.cz>
1176         * autogen.sh:
1177           Accepts automake 1.10 too. Fixes #459225
1179 2007-08-11  Stefan Kost  <ensonic@users.sf.net>
1181         * gtkdoc-mkdb.in:
1182           Make the tmpl-less build work.
1184         * tests/gtk-doc.make:
1185           Switch again to the tmpl-less build.
1187 2007-08-10  Stefan Kost  <ensonic@users.sf.net>
1189         patch by: Rouslan Solomakhin <rouslan@solomakhin.net>
1191         * configure.in:
1192           Fix the build.
1194 2007-08-10  Stefan Kost  <ensonic@users.sf.net>
1196         * gtk-doc.make:
1197         * tests/gtk-doc.make:
1198           Revert fix for #433338 and reopen bug. Breaks if file is not there,
1199           e.g. if --rebuild-types is used.
1201 2007-08-10  Stefan Kost  <ensonic@users.sf.net>
1203         * gtk-doc.make:
1204           Some cleanups.
1206         * tests/gtk-doc.make:
1207           Try the tmpl free build here.
1209 2007-08-10  Stefan Kost  <ensonic@users.sf.net>
1211         * examples/Makefile.am:
1212           Add commented out TESTS.
1214         * gtk-doc.m4:
1215           Check for location of gtkdoc-check.
1217         * Makefile.am:
1218         * gtkdoc-check:
1219           Test doc status and print result in check like layout.
1221 2007-08-02  Stefan Kost  <ensonic@users.sf.net>
1223         patch by: Sven Herzberg <herzi@gnome-de.org>
1225         * gtk-doc.make:
1226         * tests/gtk-doc.make:
1227           Rebuild documentation of $(DOC_MODULE).types changed. Fixes #433338
1229 2007-08-02  Stefan Kost  <ensonic@users.sf.net>
1231         patch by: David Nečas <yeti@physics.muni.cz>
1233         * Makefile.am:
1234         * configure.in:
1235         * gtkdoc-rebase.in:
1236           Allow rebasing cross-references in generated docs. Fixes #434134.
1238 2007-08-02  Stefan Kost  <ensonic@users.sf.net>
1240         * gtkdoc-mkhtml.in:
1241           Add a hack to gtkdoc-mkhtml to run uninstalled too.
1243 2007-08-02  Stefan Kost  <ensonic@users.sf.net>
1245         Patch by: David Nečas <yeti@physics.muni.cz>
1247         * gtk-doc.xsl:
1248           Generate ONLINE tag in index.sgml.
1250         * gtkdoc-fixxref.in:
1251           Allow to base links against online versions of xreffed docs.
1252           Fixes #454916.
1253           
1254         * gtkdoc-mkdb.in:
1255           Add releaseinfo to doctemplates.
1257         * tests/bugs/docs/tester-docs.sgml:
1258         * tests/gobject/docs/tester-docs.sgml:
1259           Update templates.
1261 2007-08-02  Stefan Kost  <ensonic@users.sf.net>
1263         * tests/bugs/docs/Makefile.am:
1264         * tests/gobject/docs/Makefile.am:
1265         * tests/gtk-doc.make:
1266           Use PERL5LIB envvar to use uninstalled gtkdoc-common.pl for tests.
1267           Use tee to both show and redirect logs.
1268           Build test-docs in check-local instead of all-local.
1269           Fixes #459725.
1271 2007-07-25  Stefan Kost  <ensonic@users.sf.net>
1273         * gtkdoc-mkdb.in:
1274         * gtkdoc-scan.in:
1275           Some more debug prints and code cleaning.
1277 2007-07-23  Stefan Kost  <ensonic@users.sf.net>
1279         Patch by: Yeti <yeti@physics.muni.cz>
1281         * gtk-doc.make:
1282         * gtkdoc-mkdb.in:
1283           Report undeclared symbols into a file. Fixes #436565.
1285 2007-07-18  Stefan Kost  <ensonic@users.sf.net>
1287         * gtkdoc-mkdb.in:
1288           Readd two debug prints and remove one obsolete one.
1290         * tests/bugs/Makefile.am:
1291         * tests/gobject/Makefile.am:
1292           Enforce 'make clean' before 'make check'.
1294 2007-07-18  Stefan Kost  <ensonic@users.sf.net>
1296         Patch by: Yeti <yeti@physics.muni.cz>
1298         * gtkdoc-mkdb.in:
1299           Cleanup broek-return handling and add ignore_broken_returns for
1300           section docs. Fixes #457077
1302         * tests/bugs/docs/Makefile.in:
1303         * tests/gobject/docs/Makefile.in:
1304           Remove.
1306         * tests/gtk-doc.make:
1307           Use the local tools so that 'make check' works uninstalled.
1308           
1310 2007-07-18  Stefan Kost  <ensonic@users.sf.net>
1312         * tests/bugs/docs/tester-sections.txt:
1313         * tests/bugs/src/tester.c: (bug_419997):
1314         * tests/bugs/src/tester.h:
1315         * tests/gobject/src/tester.c: (gtkdoc_tester_class_init):
1316         * tests/gobject/src/tester.h:
1317           Add more test cases.
1319 2007-07-17  Stefan Kost  <ensonic@users.sf.net>
1321         * tests/bugs/docs/Makefile.in:
1322         * tests/bugs/docs/tester-sections.txt:
1323         * tests/bugs/src/tester.c: (bug_141869_a), (bug_141869_b),
1324         (bug_379466), (bug_445693):
1325         * tests/bugs/src/tester.h:
1326         * tests/gtk-doc.make:
1327         * tests/gtkdoctest.sh:
1328           Improve test suite.
1330 2007-07-17  Stefan Kost  <ensonic@users.sf.net>
1332         Patch by: Yeti <yeti@physics.muni.cz>
1334         * gtkdoc-common.pl.in:
1335         * gtkdoc-mkdb.in:
1336         * gtkdoc-mktmpl.in:
1337         * gtkdoc-scan.in:
1338           Improve paramenter parsing to allow parameter names that contain
1339           const or restricted. Fixes #419997
1340           Also fix the signed/unsigned more.
1342 2007-07-17  Stefan Kost  <ensonic@users.sf.net>
1344         * Makefile.am:
1345         * autogen.sh:
1346         * configure.in:
1347         * tests/Makefile.am:
1348         * tests/bugs.sh:
1349         * tests/bugs/Makefile.am:
1350         * tests/bugs/docs/Makefile.am:
1351         * tests/bugs/docs/Makefile.in:
1352         * tests/bugs/docs/tester-docs.sgml:
1353         * tests/bugs/docs/tester-sections.txt:
1354         * tests/bugs/docs/tester.types:
1355         * tests/bugs/src/Makefile.am:
1356         * tests/bugs/src/tester.c: (bug_445693), (bug_141869_a),
1357         (bug_141869_b):
1358         * tests/bugs/src/tester.h:
1359         * tests/gobject.sh:
1360         * tests/gobject/Makefile.am:
1361         * tests/gobject/docs/Makefile.am:
1362         * tests/gobject/docs/Makefile.in:
1363         * tests/gobject/docs/tester-docs.sgml:
1364         * tests/gobject/docs/tester-sections.txt:
1365         * tests/gobject/docs/tester.types:
1366         * tests/gobject/src/Makefile.am:
1367         * tests/gobject/src/tester.c: (gtkdoc_tester_new),
1368         (gtkdoc_tester_get_property), (gtkdoc_tester_set_property),
1369         (gtkdoc_tester_class_init), (gtkdoc_tester_get_type):
1370         * tests/gobject/src/tester.h:
1371         * tests/gtk-doc.make:
1372         * tests/gtkdoctest.sh:
1373         Add test-suite. Fixes #457173
1375 2007-07-16  Stefan Kost  <ensonic@users.sf.net>
1377         Patch by: Yeti <yeti@physics.muni.cz>
1379         * gtkdoc-mkdb.in:
1380         Avoid useless $return_start access.
1382 2007-07-16  Stefan Kost  <ensonic@users.sf.net>
1384         Patch by: Petteri Räty <betelgeuse@gentoo.org>
1386         * gtk-doc.m4:
1387         Make gtk-doc.m4 fail when needed gtk-doc is not installed and notify
1388         user. Fixes #323938 and #450338.
1390 2007-07-15  Stefan Kost  <ensonic@users.sf.net>
1392         * gtkdoc-mkdb.in:
1393         * gtkdoc-mktmpl.in:
1394         Handle signed/unsigned without int. Fixes #141869.
1396 2007-07-15  Stefan Kost  <ensonic@users.sf.net>
1398         Patch by: Yeti <yeti@physics.muni.cz>
1400         * gtkdoc-mkdb.in:
1401         Improve handling of legacy "return" statement doc parsing. Warn about
1402         those.
1404 2007-07-15  Stefan Kost  <ensonic@users.sf.net>
1406         * gtkdoc-mkdb.in:
1407         Fix perl warning about usage of undefined symbol.
1409 2007-07-15  Stefan Kost  <ensonic@users.sf.net>
1411         * gtkdoc-mkdb.in:
1412         * gtkdoc-mktmpl.in:
1413         Sync the function decl arg parsing. Fixes #419308.
1415 2007-07-15  Stefan Kost  <ensonic@users.sf.net>
1417         * gtkdoc-fixxref.in:
1418         Improve the ---help output a little.
1420 2007-07-15  Stefan Kost  <ensonic@users.sf.net>
1422         * gtkdoc-fixxref.in:
1423         Improve detection of absolute/relatives paths. Skip duplicate paths.
1424         Fixes #453717.
1426 2007-06-14  Lo�c Minier  <lool@dooz.org>
1428         * gtk-doc.make:
1429         Cleanup $(DOC_MODULE)-undocumented.txt files in
1430         maintainer-clean-local.  Fixes #415388.
1432 2007-06-14  Lo�c Minier  <lool@dooz.org>
1434         * gtk-doc.m4:
1435         Fix warnings in m4 macros when running "autoreconf -fi -Wall";
1436         Guillem Jover. Fixes #428596.
1438 2007-06-11  Damon Chaplin  <damon@gnome.org>
1440         * gtkdoc-mkdb.in (ExpandAbbreviations): just output "signal" and
1441         "property" as the text for cross-reference links to signals and
1442         properties, rather than something like "Object::signal" which can get
1443         a bit long. Also tidied up the code a little.
1444         (GetArgs): put the " inside the literal element.
1445         (GetSignals): use a literal element for the signal name in the title,
1446         to match the properties.
1448 2007-03-16  Stefan Kost  <ensonic@users.sf.net>
1450         * gtkdoc-common.pl.in: handle preprocessor statements in enum and
1451         struct declarations. Fixes #418027.
1453 2007-02-27  Stefan Kost  <ensonic@users.sf.net>
1455         * gtk-doc.xsl: create toc for part and reference
1457         * style.css: Fix  placement of div.reference
1459 === release 1.8 ===
1461 2007-02-16  Damon Chaplin  <damon@gnome.org>
1463         * Released 1.8.
1465 2007-02-16  Damon Chaplin  <damon@gnome.org>
1467         * gtkdoc-scan.in: only rebuild the .types file automatically on the
1468         very first run (i.e. when there are no sections or types files).
1470         * gtkdoc-scangobj.in: skip gnome_keyring_item_info_get_type if it is
1471         in the .types file as it isn't a real GObject type. This is a hack to
1472         avoid breaking the GNOME build. See bug #386508.
1474 2007-02-11  Stefan Kost  <ensonic@users.sf.net>
1476         * gtk-doc.xsl: fix prerequisite section in nav-header
1478 2007-02-07  Stefan Kost  <ensonic@users.sf.net>
1480         * style.css: fixing footnote subscripts, make tables look nicer.
1481         #405051
1483 2007-02-07  Damon Chaplin  <damon@gnome.org>
1485         * gtk-doc.make: make $(DOC_MODULE)-sections.txt and
1486         $(DOC_MODULE)-overrides.txt depend on scan-build.stamp, so that
1487         parallel make works. #404122, Ed Catmur.
1489 2007-02-07  Damon Chaplin  <damon@gnome.org>
1491         * gtkdoc-scangobj.in: don't return if !G_TYPE_IS_OBJECT (object_type)
1492         as that means interface properties don't get output. This was broken
1493         by the patch for #348058.
1495 2007-01-21  Damon Chaplin  <damon@gnome.org>
1497         * gtkdoc-mkdb.in: added "--default-includes" option to specify the
1498         default "#include"s to place at the top of the synopsis of each
1499         section. Normally this is specified in a <INCLUDE>...</INCLUDE> line
1500         in MODULE-sections.txt, but if you are using the "--rebuild-sections"
1501         option to automatically rebuild the MODULE-sections.txt file you can't
1502         use that. #395023.
1504 2007-01-21  Damon Chaplin  <damon@gnome.org>
1506         * gtkdoc-mktmpl.in (ReadTemplateFile):
1507         * gtkdoc-mkdb.in (ReadTemplateFile): improved param regexp to handle
1508         weird macro vararg names like "format...". #398971.
1510 2007-01-16  Damon Chaplin  <damon@gnome.org>
1512         * gtkdoc-mkdb.in: support "Include" setting in section docs in source
1513         code, same as <INCLUDE>...</INCLUDE> setting in sections.txt file.
1514         Part of #395023.
1516 2007-01-16  Damon Chaplin  <damon@gnome.org>
1518         * gtkdoc-mkdb.in (OutputMacro): try to line up multiple lines of
1519         arguments if possible. #384249
1521 2007-01-16  Damon Chaplin  <damon@gnome.org>
1523         * gtkdoc-scan.in (ScanHeader): for headers marked private, return
1524         immediately so we don't add anything to the sections file. #395005.
1526 2007-01-16  Damon Chaplin  <damon@gnome.org>
1528         * gtkdoc-mkdb.in: a number of changes to help when adding example code
1529         to the docs (#368382):
1531          a) Support CDATA in source code comments. (We don't touch anything in
1532             CDATA.)
1533          b) Support |[ ... ]| to include example code. (Just gets converted to
1534             <informalexample><programlisting>)
1535          c) Improve <programlisting> handling, by not inserting <para></para>
1536             and not expanding "()", "@" or "%". (It still expands '#' so people
1537             can use cross-references to any symbols if they want to.).
1538          d) Improve '#' links a bit by skipping symbols that look like C
1539             preprocessor directives (e.g. "#include").
1540          e) Improve '&' handling a bit by converting to '&amp;' if it doesn't
1541             already look like the start of an entity reference.
1542          f) Added special case for "#include <xxxx>" in <programlisting> so the
1543             "<" and ">" get replaced by entities.
1545         * gtkdoc-mktmpl.in (ReadTemplateFile):
1546         * gtkdoc-mkdb.in (ReadTemplateFile): fixed param regexp so it handles
1547         "@...:" for varargs again. It also cleans up messed up template files
1548         luckily.
1550 2007-01-04  Damon Chaplin  <damon@gnome.org>
1552         * gtk-doc.make (dist-hook): abort dist if html docs aren't generated.
1553         #166462, Gustavo Carneiro.
1555 2007-01-03  Damon Chaplin  <damon@gnome.org>
1557         * gtkdoc-mkdb.in: improved output a little - made field widths larger,
1558         removed signal prototypes from synopsis, and capitalized all signal
1559         flags (to be consistent with argument capitalization). #384247,
1560         Hans Petter Jansson.
1562 2007-01-03  Damon Chaplin  <damon@gnome.org>
1564         * gtkdoc-mktmpl.in (OutputDeclaration):
1565         * gtkdoc-mkdb.in (OutputFunction): fix parsing of "char * const"
1566         arguments, with an extra "\s*". #387681
1568 2007-01-03  Damon Chaplin  <damon@gnome.org>
1570         * omf.make:
1571         * xmldocs.make: updated to new versions from gnome-common. #363622
1572         Also reverted the changes made for #316508 since they may cause
1573         problems. We'll let the scrollkeeper/gnome-common/autoconf people
1574         sort out that issue.
1576 2006-12-07  Ross Burton  <ross@burtonini.com>
1578         * help/manual/C/gtk-doc-manual.xml:
1579         Add examples of how to document structs, properties and signals
1580         (#383401).
1582 2006-12-04  Damon Chaplin  <damon@gnome.org>
1584         * gtkdoc-scangobj.in: added a '--query-child-properties' argument to
1585         allow you to specify a function to return a list of child properties
1586         for a class (similar to GtkContainer child properties). #379203
1588 2006-10-16  Damon Chaplin  <damon@gnome.org>
1590         * gtkdoc-scangobj.in: remove a shadow declaration to avoid compiler
1591         warnings. #362475
1593 2006-10-15  Damon Chaplin  <damon@gnome.org>
1595         * gtkdoc-scan.in: added a '--rebuild-sections' option that will
1596         automatically recreate the MODULE-sections.txt file each time.
1597         (This only works for projects with very neat header files.) #310494.
1599 2006-10-15  Damon Chaplin  <damon@gnome.org>
1601         Bug #338517: Automatically creating/updating .types file:
1603         * gtkdoc-scan.in: added a '--rebuild-types' option which will
1604         automatically update the .types file using all _get_type() functions
1605         found in the headers. (It will also do this if no .types file is found,
1606         i.e. when gtk-doc is first run on a project.)
1608         * gtk-doc.make (scan-build.stamp): run gtkdoc-scan before
1609         gtkdoc-scangobj so we can use the generated .types file.
1611         * gtkdoc-scangobj.in: if the .types file doesn't have any #include
1612         directives, just output "extern GType *get_type();" declarations for
1613         each *_get_type() function.
1615 2006-10-14  Damon Chaplin  <damon@gnome.org>
1617         * gtkdoc-mkdb.in (ExpandAbbreviationsExceptCDATA): new function used
1618         to expand abbreviations in extra files, but leaving CDATA sections
1619         as they are. (#360579)
1621 2006-10-14  Damon Chaplin  <damon@gnome.org>
1623         * gtkdoc-mkdb.in (OutputSGML): Allow the section id to be set from
1624         within the source code "SECTION:" comment block. (#349855)
1626 2006-10-13  Damon Chaplin  <damon@gnome.org>
1628         * style.css: added missing comma from previous fix (#360967).
1630 2006-10-13  Damon Chaplin  <damon@gnome.org>
1632         * gtkdoc-mkdb.in (OutputSymbolTraits): new function to output the
1633         "Since" and "Stability Level:" paragraphs, with roles to allow
1634         XSLT styling. (#348046)
1636 2006-10-13  Damon Chaplin  <damon@gnome.org>
1638         * gtkdoc-scangobj.in: support interfaces on non-GObject types.
1639         (#348058, Josh Parsons).
1641 2006-10-13  Damon Chaplin  <damon@gnome.org>
1643         * gtkdoc-scangobj.in: make sure interfaces are initialized so the
1644         signals query works. (#355352)
1646 2006-10-13  Damon Chaplin  <damon@gnome.org>
1648         * style.css: Make sure appendix title isn't obscured by navigation bar
1649         (#360967, Philip Kovacs).
1651 2006-09-09  Matthias Clasen  <mclasen@redhat.com>
1653         * gtkdoc-scangobj.in (get_type_name): Don't set is_pointer
1654         to TRUE for enum and flags types.  (#354880, Yevgen Muntyan)
1656 === release 1.7 ===
1658 2006-07-29  Damon Chaplin  <damon@gnome.org>
1660         * Released 1.7.
1662 2006-06-30  Damon Chaplin  <damon@gnome.org>
1664         * gtkdoc-mkdb.in (ScanSourceFile): fix regexp to allow section names
1665         with '-' in them.
1667         * gtk-doc.make (all-local, docs): added separate 'docs' target that can
1668         be used even when the '--disable-gtk-doc' configure option is used.
1670 2006-06-15  Jody Goldberg <jody@gnome.org>
1672         * gtkdoc-mkdb.in (OutputFunction) : finish off #341872
1673           Support 'T const * const *foo' and other more complex types.
1674           Support ptr2ptr2func as a func argument.
1675             'void foo (void (**func) (void))'
1676         * gtkdoc-mktmpl.in : ditto.
1678           (committed by Damon with minor changes to spacing so GTK+ docs are
1679            unchanged).
1681 2006-06-09  Damon Chaplin  <damon@gnome.org>
1683         * gtkdoc-mkdb.in:
1684         * gtk-doc.xsl: use the 'role' attribute rather than the 'id' attribute
1685         to identify the different sections for the navigation bar, since 'id'
1686         must be unique throughout the entire document. Also fixed a few minor
1687         issues with the output. (#342861, Leonardo Boshell)
1689 2006-05-30  Damon Chaplin  <damon@gnome.org>
1691         * gtkdoc-fixxref.in (FixHTMLFile): Use the 's' modifier to the
1692         substitution so we handle links spanning more than one line.
1693         (#342845).
1695 2006-05-22  Damon Chaplin  <damon@gnome.org>
1697         * configure.in:
1698         * Makefile.am:
1699         * help/Makefile.am:
1700         * help/manual/Makefile.am: use a separate Makefile.am for each
1701         subdirectory rather than using "SUBDIRS=help/manual/C".
1703 2006-05-21  Jody Goldberg <jody@gnome.org>
1705         * gtkdoc-common.pl.in (ParseStructDeclaration) : Support
1706           'long double foo' and
1707           'T const * const *foo' (#341872)
1708         * gtkdoc-mktmpl.in (OutputDeclaration) : handle ptrs to ptrs to
1709           functions 'void func (void (**ptr2ptr2func)(int a))'
1711 2006-05-21  Damon Chaplin  <damon@gnome.org>
1713         * gtkdoc-mkdb.in (ScanSourceFile): don't check basename for '.[hc]'
1714         suffix since we allow other suffixes as well now. (#340199)
1716         * gtkdoc-mktmpl.in (OutputSignalTemplates): check if the parameter
1717         is actually in the source code comment block. If not, use the default
1718         name. Otherwise we were outputting an empty "@:" in the templates.
1719         (ReadTemplateFile): remove empty "@:" lines caused by above bug.
1721 2006-04-15  Damon Chaplin  <damon@gnome.org>
1723         * xmldocs.make: use gtkdochelpdir rather than docdir to avoid clash
1724         with autoconf. (#316508)
1726         * tools/gtk-doc.el: Output "Returns:" rather than "Return value:",
1727         and a "C-x4s" binding for inserting a blank section header.
1729         * gtk-doc.make (sgml-build.stamp): added $(DOC_MODULE)-sections.txt
1730         to the dependencies, since although the templates depend on it, they
1731         may not be changed, but the XML should still be rebuilt.
1733         * gtkdoc-mkdb.in (ScanSourceFile): allow whitespace after "SECTION:".
1735 2006-04-13  Damon Chaplin  <damon@gnome.org>
1737         * gtkdoc-mkdb.in (ReadArgsFile): When outputting a warning about a
1738         property, use a single colon ':', since that is what is used to
1739         document properties in the source code. (2 colons are used for signals)
1741         * gtk-doc.make (sgml-build.stamp): added $(HFILE_GLOB) here, to
1742         catch any new documentation in the headers.
1744 2006-04-12  Damon Chaplin  <damon@gnome.org>
1746         * gtkdoc-mkdb.in (tagify2): strip special "-struct" suffix from
1747         text of links to widget structs.
1749 2006-04-09  Stefan Kost  <ensonic@users.sf.net>
1751         * TODO:
1752         fix link after live.gnome.org wiki changes
1754 === release 1.6 ===
1756 2006-04-09  Damon Chaplin  <damon@gnome.org>
1758         * Released 1.6.
1760 2006-03-29  Stefan Kost  <ensonic@users.sf.net>
1762         * gtkdoc-scangobj.in:
1763         missing '*' for arg in signal prototype in docs (#335486)
1765 2006-03-26  Damon Chaplin  <damon@gnome.org>
1767         * gtkdoc-mkdb.in (MergeSourceDocumentation): don't output warnings
1768         for overridden titles, since that happens a lot. (#320010)
1770         * configure.in: check for pkg-config >= 0.19.
1772         * Makefile.am (pkgconfigdir): put the .pc file in $(datadir) rather
1773         than $(libdir), since gtk-doc is architecture-independant. (#120950)
1775         * configure.in: removed the hard dependancy on openjade or jade, since
1776         XML is used mostly now rather than SGML. We just output a warning
1777         rather than an error if neither openjade or jade are found.
1779 2006-03-21  Stefan Kost  <ensonic@users.sf.net>
1781         * style.css:
1782         add sect1 to pages with top-page offset adjustment (#166363)
1784 2006-03-19  Damon Chaplin  <damon@gnome.org>
1786         * gtkdoc-scan.in (ScanHeader): try to handle the start of function
1787         declarations spread over 3 lines. (#321708, Jorn Baayen)
1789 2006-03-19  Damon Chaplin  <damon@gnome.org>
1791         (OutputOldParams): don't bother outputting unused parameters if they
1792         don't have any documentation as that is pointless.
1794 2006-03-19  Damon Chaplin  <damon@gnome.org>
1796         * gtkdoc-mktmpl.in (ReadTemplateFile): Add a workaround for an old
1797         bug handling macros with arguments spread over several lines. (#318666)
1799 2006-03-19  Damon Chaplin  <damon@gnome.org>
1801         * gtkdoc-mkdb.in (MakeIndexterms): Make sure we still output an index
1802         term if there isn't 'deprecated' or 'since' info.
1803         (#334851, Tommi Komulainen).
1805 2006-03-19  Damon Chaplin  <damon@gnome.org>
1807         * gtkdoc-scan.in (ScanHeader): added "--ignore-decorators" option to
1808         ignore a list of declarators in function declarations.
1809         (#316512, Bertram Felgenhauer).
1811 2006-03-19  Damon Chaplin  <damon@gnome.org>
1813         * gtkdoc-mkdb.in (GetSignals, GetArgs): call MakeIndexTerms() to make
1814         sure that signals appear in the deprecated/new symbol indices.
1815         (#332007, Tommi Komulainen).
1817 2006-03-19  Damon Chaplin  <damon@gnome.org>
1819         * gtkdoc-mkdb.in (OutputEnum, ExpandAbbreviations, symbolify):
1820         allow use of '#Object::signal' and '#Object:property' to link to
1821         signals and properties, and add links to enum constant values.
1822         (#332483, Stefan Kost)
1824 2006-03-15  Matthias Clasen  <mclasen@redhat.com>
1826         * gtkdoc-mkdb.in (MakeIndexterms): Create separate indexterms
1827         for different roles, since the docbook stylesheets don't handle
1828         multiple roles in one attribute.  (#331586, Tommi Komulainen)
1830 === release 1.5 ===
1832 2006-03-07  Damon Chaplin  <damon@gnome.org>
1834         * Released 1.5.
1836 2006-03-06  Tommi Komulainen  <tommi.komulainen@nokia.com>
1838         * gtkdoc-scan.in (ScanHeader): Print object name after <TITLE> in
1839         order to get get object hierarchy, signals and properties
1840         documentation appear automatically (#333380)
1842 2006-01-24  Stefan Kost  <ensonic@users.sf.net>
1844         * gtkdoc-mkdb.in: patch from Damon Chaplin to fix signal flag parsing
1846 2006-01-08  Damon Chaplin  <damon@gnome.org>
1848         * gtkdoc-mkdb.in: patch from Jonathan Blandford to add support for a
1849         "--source-suffixes" option so you can scan files with any suffixes
1850         you want (e.g. C++ files).
1852 2005-12-19  Matthias Clasen  <mclasen@redhat.com>
1854         * gtkdoc-mktmpl.in: Use \w+: instead of \S+: when
1855         matching parameter names, so that @Deprecated:2.10:
1856         works in template files like in source code comments.
1858         * gtkdoc-mkdb.in: Add a missing "and" to the versioned
1859         deprecation note.
1861 2005-12-09  Stefan Kost  <ensonic@users.sf.net>
1863         * devhelp.xsl:
1864           try more to downgrade devhelp for old file format
1866 2005-12-09  Stefan Kost  <ensonic@users.sf.net>
1868         * Makefile.am:
1869           add devhelp2 files
1870         * autogen.sh:
1871           create a autoregen.sh
1872         * devhelp.xsl:
1873         * devhelp2.xsl:
1874         * gtk-doc.xsl:
1875           generate two separate versions
1876         * gtkdoc-mkdb.in:
1877           fix parsing const after type (#322556)
1878         * gtkdoc-mktmpl.in:
1879           fix parseing multiline macro heads (#320588)
1880         * gtkdoc-scangobj.in:
1881           allow additional root types (#323581)
1883 2005-12-05  Matthias Clasen  <mclasen@redhat.com>
1885         * gtkdoc-mktmpl.in (OutputDeclaration):
1886         * gtkdoc-mkdb.in (OutputFunction): Allow parameters to be declared
1887         volatile (this happens in GLib nowadays)
1889 2005-10-11  Stefan Kost  <ensonic@users.sf.net>
1891         * gtkdoc-mkdb.in:
1892           remove left-over debug-print
1894 2005-10-10  Stefan Kost  <ensonic@users.sf.net>
1896         * devhelp.xsl:
1897         * gtkdoc-mkdb.in:
1898           enhance gtkdoc devhelp output (#318129)
1900 2005-10-05  Stefan Kost  <ensonic@users.sf.net>
1902         * gtkdoc-common.pl.in:
1903           revert exchanging &nbsp; with &#160;
1905 2005-10-04  Damon Chaplin  <damon@gnome.org>
1907         * gtkdoc-scanobj.in: patch from Andrae Steiner to add missing ';'
1908         (#317938)
1910 2005-09-29  Stefan Kost  <ensonic@users.sf.net>
1912         * TODO:
1913           additionally point people to the gnome-wiki
1915         * gtkdoc-mkdb.in:
1916           don't warn on macros with return docs (#314267)
1918 2005-09-28 Matthias Clasen <mclasen@redhat.com>
1920         Show signal flags:  (#316789)
1922         * gtkdoc-scangobj.in: Emit flags for signals
1923         as <FLAGS> element in $MODULE.signals
1925         * gtkdoc-mkdb.in: Emit signal flags similar
1926         to property flags.
1928         * gtkdoc-mktmpl.in: Handle <FLAGS> here, too.
1930 2005-09-20  Stefan Kost  <ensonic@users.sf.net>
1932         * doc/README:
1933         * doc/authors.txt:
1934         * doc/gnome.txt:
1935         * doc/sections-file.txt:
1936         * doc/setting-up.txt:
1937         * doc/style-guide.txt:
1938         * gtkdoc-common.pl.in:
1939           adding a note about where the new docs are
1941 2005-09-15  Damon Chaplin  <damon@gnome.org>
1943         * gtkdoc-scan.in (ScanHeader):
1944         * gtkdoc-mktmpl.in (OutputDeclaration):
1945         * gtkdoc-mkdb.in (OutputFunction): patch from dodji seketeli to handle
1946         functions returning explicit enums. (#303337)
1948         Patch from Stepan Kasal:
1950         * gtkdoc-mkhtml.in, gtkdoc-mkman.in, gtkdocize.in: Add datarootdir
1951         variable, for compatibility with future Autoconf releases.
1953         * configure.in (PACKAGE_DATA_DIR): Simplify the computation;
1954         use a local macro AC_DEFINE_DIR, based on a macro from Autoconf
1955         macro archive. (#313876)
1957 2005-09-15  Damon Chaplin  <damon@gnome.org>
1959         * gtkdoc-scangobj.in: Patch from Stepan Kasal to avoid some gcc
1960         warnings. (#312985)
1962         * gtkdoc-scanobj.in:
1963         * gtkdoc-scangobj.in: Use brackets around open() arguments to avoid
1964         precedence problems. (#314838)
1966         * gtkdoc-scanobj.in:
1967         * gtkdoc-scangobj.in: Output more messages about compilation, linking
1968         and running of scanner, to try to help track down any problems.
1969         Also use "sh -c" to run the scanner (#167688)
1971         * gtkdoc-scanobj.in:
1972         * gtkdoc-scangobj.in: patch from Stefan Kost to improve error messages,
1973         though I changed it slightly so it doesn't output errno.
1975 2005-09-09  Damon Chaplin  <damon@gnome.org>
1977         * gtkdoc-mkdb.in:
1978         * style.css:
1979         * gtk-doc.xsl: Use a fixed navigation bar at the top of the page.
1980         Patch from Stefan Kost with minor changes by me. (#313569)
1982 2005-08-18  Damon Chaplin  <damon@gnome.org>
1984         * gtkdoc-scangobj.in: added "const" in a few places to avoid lots
1985         of warnings if all gcc warnings are on. (#312985)
1987 2005-08-15  Stefan Kost  <ensonic@users.sf.net>
1989         * COPYING-DOCS:
1990         * Makefile.am:
1991         * configure.in:
1992         * omf.make:
1993         * xmldocs.make:
1994           adding the infrastructure for installation of gtkdoc manual
1996 2005-08-12  Stefan Kost  <ensonic@users.sf.net>
1998         * gtkdoc-mkdb.in:
1999         fix warning about uninitialized var EXPAND_CONTENT_FILES
2001 Tue Aug  9 12:01:27 2005  tjlocal  <timj@imendio.com>
2003         * autogen.sh: bail out with exit $? for failing programs.
2005 2005-07-26  Damon Chaplin  <damon@gnome.org>
2007         * gtk-doc.make: Pass DOC_MAIN_SGML_FILE as the main filename to
2008         gtkdoc-mkdb. Avoids creating spurious foo.sgml files in an XML build.
2009         Patch from Malcolm Tredinnick. (#311344)
2011         Prefix build messages with "gtk-doc: " rather than surrounding them
2012         with "***" which looks like an error. (#170008)
2014 2005-07-26  Damon Chaplin  <damon@gnome.org>
2016         * README: removed comment about not being able to add section
2017         documentation to source code files, which is not true any more.
2019 === release 1.4 ===
2021 2005-07-03  Damon Chaplin  <damon@gnome.org>
2023         * Released 1.4.
2025 2005-06-20  Matthias Clasen  <mclasen@redhat.com>
2027         * gtkdoc-mkdb.in: Fix typos in warnings.
2029 2005-06-17  Mikael Hallendal  <micke@imendio.com>
2031         * README: Updated Devhelp web address.
2033 2005-05-16  Matthias Clasen  <mclasen@redhat.com>
2035         * gtkdoc-mkdb.in: Add "expand-content-files:s" to the GetOptions() call.
2037 2005-05-10  Owen Taylor  <otaylor@redhat.com>
2039         * gtkdoc-mkdb.in: Add an --expand-content-files option
2040         to specify extra files to expand abbreviations in and
2041         copy into the output directory.
2043         * gtk-doc.make examples/Makefile.am: Add expand_content_files
2044         variable.
2046         * gtkdoc-mktmpl.in (OutputTemplateFile): Add an
2047         --only-section-tmpl flag so that projects that keep everything
2048         but section descriptions inline can avoid cvs conflicts.
2050         * gtk-doc.make examples/Makefile.am: Add support for
2051         MKTMPL_OPTIONS
2053         * configure.in: Up version to 1.4.
2055 2005-05-02  Matthias Clasen <mclasen@redhat.com>
2057         * gtkdoc-mkdb.in: Accept C comments between struct name
2058         and struct definition. GObject has an instance of this.
2060 2005-03-21  Matthias Clasen <mclasen@redhat.com>
2062         * gtk-doc.dcl: Allow ':' in names. (#169087)
2064 2005-03-21  James Henstridge  <james@jamesh.id.au>
2066         * gtk-doc.xsl (encoding): output US-ASCII instead of ISO-8859-1.
2067         This ensures that the output will be display correctly when served
2068         as either ISO-8859-1 or UTF-8.
2070 2005-02-26  Sven Neumann  <sven@gimp.org>
2072         * gtkdoc-mkdb.in (MakeIndexterms): allow space in Since: keywords,
2073         only strip leading and trailing whitespace (bug #168384).
2075 2005-02-16  Damon Chaplin  <damon@gnome.org>
2077         * gtkdoc-mkdb.in (ScanSourceFile): add support for "@stability:"
2078         in the inline section docs (Brian Cameron).
2080 2005-02-07  Damon Chaplin  <damon@gnome.org>
2082         * gtkdoc-mkdb.in (MergeSourceDocumentation): allow use of "@...:" in
2083         the source code as well as "@Varargs:". Patch from Benjamin Otte.
2084         #166366.
2086 2005-02-04  Damon Chaplin  <damon@gnome.org>
2088         * gtkdoc-mkdb.in (ParseStabilityLevel): don't reset $stability if it
2089         isn't Stable/Unstable/Private (Brian Cameron).
2090         (ScanSourceFile): skip whitespace after "SECTION:".
2092 2005-02-01  Damon Chaplin  <damon@gnome.org>
2094         * gtkdoc-mkdb.in (ScanSourceFile, MergeSourceDocumentation): patch
2095         from Stefan Kost to support section documentation within the source
2096         code (long description, short description, see also and title).
2098         * gtkdoc-mkdb.in:
2099         * gtkdoc-mktmpl.in: patch from Brian Cameron to support stability
2100         levels.
2102         * gtkdoc-mkdb.in (OutputFunction):
2103         * gtkdoc-mktmpl.in (OutputDeclaration):
2104         * gtkdoc-common.pl.in (ParseStructDeclaration): patch from Roger Leigh
2105         to add support for the "restrict" keyword.
2107         * gtkdoc-scan.in (ScanHeader): patch from Roger Leigh to add support
2108         for "unsigned" to one of the regexps.
2110 2005-01-31  Damon Chaplin  <damon@gnome.org>
2112         * gtk-doc.make (scan-build.stamp): added "2>&1" to grep command to
2113         ignore any errors.
2115         * gtkdoc-mkdb.in: patch from Stefan Kost to not add '<' '>' around
2116         include files that already have '"' '"' around them, and to try to
2117         gather more information about undocumented symbols. #164462.
2119 2005-01-28  Damon Chaplin  <damon@gnome.org>
2121         * gtk-doc.make: use dist-hook rather than EXTRA_DIST to copy the
2122         $(DOC_MODULE).types file over, so we can skip this if it doesn't exist.
2123         #156300.
2125 2005-01-12  Damon Chaplin  <damon@gnome.org>
2127         * README: patch from Stefan Kost to mention GObject classes
2128         and describe the transformation process to XML/SGML and HTML,
2129         and to mention Devhelp.
2131 === release 1.3 ===
2133 2005-01-09  Damon Chaplin  <damon@gnome.org>
2135         * Released 1.3.
2137 2005-01-09  Damon Chaplin  <damon@gnome.org>
2139         * gtkdoc-mkdb.in (MergeSourceDocumentation): output better warnings
2140         using the type information. Patch from Stefan Kost. #161979
2142         * gtkdoc-scan.in (ScanHeader): support "typedef struct a *b;". Fixes
2143         last part of #156318.
2145         * gtkdoc-common.pl.in (ParseStructDeclaration): return an empty array
2146         for forward struct declarations. Part of #156318.
2148         * gtkdoc-mktmpl.in:
2149         * gtkdoc-mkdb.in: updated a few of the warnings to make them a bit
2150         easier to understand.
2152 2004-11-22  James Henstridge  <james@jamesh.id.au>
2154         * acconfig.h: remove file, since we don't have a config.h
2156         * configure.in: make sure $ACLOCAL_FLAGS is passed to aclocal on a
2157         rebuild.
2159         * autogen.sh: use Automake-1.9 if available, and call aclocal,
2160         autoconf, automake, etc in the same order as autoreconf does.
2162         * gtkdocize.in: if the AC_CONFIG_MACRO_DIR option is used in the
2163         configure script, copy gtk-doc.m4 to that directory in the source
2164         tree.
2166 2004-11-16  Damon Chaplin  <damon@gnome.org>
2168         * gtkdoc-mkdb.in (OutputFunction): output "const" rather than
2169         "G_CONST_RETURN". #157674.
2171         * gtkdoc-mktmpl.in (OutputDeclaration): skip "void" return types but
2172         not if it has modifiers e.g. "void *". #156963.
2174         * gtkdoc-scan.in (ScanHeader): handle __attribute__. Patch from
2175         Simon Josefsson. #156962.
2177 2004-10-31  Damon Chaplin  <damon@gnome.org>
2179         * gtkdoc-mkdb.in (OutputStruct): handle opaque/forward struct
2180         declarations. #156318 again. Tiny fix to avoid warnings.
2182 2004-10-28  Damon Chaplin  <damon@gnome.org>
2184         * gtkdoc-mktmpl.in (ReadDeclarationsFile):
2185         * gtkdoc-mkdb.in (ReadDeclarationsFile):
2186         * gtkdoc-scan.in (ScanHeader): handle opaque/forward struct
2187         declarations. #156318.
2189 2004-10-25  Damon Chaplin  <damon@gnome.org>
2191         * gtkdoc-mkdb.in (OutputParamDescriptions): use a &nbsp; after Returns:
2192         so it doesn't break before the colon.
2194 2004-10-24  Damon Chaplin  <damon@gnome.org>
2196         * gtkdoc-common.pl (ParseEnumDeclaration): handle "typedef enum XXX {"
2197         #156297. Patch from Simon Josefsson.
2199 2004-10-20  Damon Chaplin  <damon@gnome.org>
2201         * gtkdoc-mkdb.in (ReadDeclarationsFile): set a flag to indicate a
2202         struct has a typedef declaration.
2203         (OutputStruct): better output for structs with typedefs. #83269.
2205         * gtkdoc-scan.in (ScanHeader): leave the struct declaration as it is.
2206         Don't strip out 'typedef'. Also allow simple "struct foo {".
2208 2004-10-19  Damon Chaplin  <damon@gnome.org>
2210         * gtkdoc-fixxref.in: use pkg-config to find where GLib is installed
2211         and scan that directory for index files. Also scan $GNOME2_PATH.
2212         These are only used as a last resort. If they are used we have to
2213         output links as absolute URLs, rather than the default relative ones.
2215 2004-10-18  Damon Chaplin  <damon@gnome.org>
2217         * gtkdoc-common.pl.in (ParseStructDeclaration): support function
2218         pointers that return "foo const *" #141870.
2220         * gtkdoc-scan.in (ScanHeader):
2221         * gtkdoc-mkdb.in (OutputFunction):
2222         * gtkdoc-mktmpl.in (OutputDeclaration): handle functions with const
2223         or struct return types. #141870 and #148507.
2225 2004-10-15  Damon Chaplin  <damon@gnome.org>
2227         * gtkdoc-common.pl.in (ParseStructDeclaration)
2228         (ParseEnumDeclaration): moved these here, rather than have 2 copies
2229         in gtkdoc-mkdb.in and gtkdoc-mktmpl.in.
2231         * gtkdoc-common.pl.in (ParseStructDeclaration): handle struct fields
2232         better. We can now handle things like *foo, ***bar, *baz[12][23],
2233         foo : 25 all on one line. Fixes part of #151219.
2234         Also support the 'short' modifier to fix #90565.
2235         And use $nbsp; rather than spaces to try to avoid splitting
2236         declarations in the output.
2237         Also take an extra arg specifying whether to include parameters in
2238         the function pointer fields.
2240         * gtkdoc-scan.in (ScanHeader): Deal with array types in typedefs.
2241         (Eg, "typedef unsigned char MD5Digest[16];") From Dan Winship.
2242         Last bit of #151219.
2244 2004-10-14  Damon Chaplin  <damon@gnome.org>
2246         * gtkdoc-mkdb.in (CreateValidSGMLID): use ":CAPS" rather than
2247         "-CAPS" to distinguish all-caps identifiers, to avoid clashing with
2248         identifiers ending in _caps! Bug #113120.
2250         * gtkdoc-mkdb.in (MergeSourceDocumentation): if it looks like a
2251         parameter has been described, but not in the right place, output
2252         a better error message. Bug #141871.
2254         * gtkdoc-mkdb.in (OutputMacro, OutputFunction, GetSignals): allow
2255         the author to use <!--PARAMETERS--> to specify the position of the
2256         parameter table if they want. Hopefully good enough for bug #99567.
2257         (MergeSourceDocumentation): end the paragraph before <!--PARAMETERS-->
2258         and start a new one after it.
2260         * doc/authors.txt: document <!--PARAMETERS-->.
2262         * style.css: don't underline links normally, as we output lots of
2263         them and it makes it very cluttered. Only underline links when the
2264         mouse hovers over them, and change the color. Fixes #108037.
2266         * gtk-doc.make (scan-build.stamp): depend on $(CFILE_GLOB) as well,
2267         since changes in properties need to be picked up by gtkdoc-scangobj.
2268         Bug #52458.
2270         * gtkdoc-mkdb.in: (ParseStructDeclaration): for fields that are
2271         function pointers, only return the function name, as otherwise the
2272         output gets really messy. Fixes #66618.
2274         * gtkdoc-mktmpl.in:
2275         * gtkdoc-mkdb.in:
2276         * gtkdoc-scan.in:
2277         * gtkdoc-scanobj.in:
2278         * gtkdoc-scangobj.in: use '@PACKAGE_DATA_DIR@' instead of
2279         "@PACKAGE_DATA_DIR@" so that it isn't interpolated. It failed when
2280         $prefix was /software/@sys/usr. Fixes #113456.
2282 2004-10-13  Damon Chaplin  <damon@gnome.org>
2284         * gtkdoc-scanobj.in:
2285         * gtkdoc-scangobj.in: patch from Olexiy Avramchenko to add 3 new
2286         GdkEvent subtypes.
2288         * gtkdoc-scanobj.in:
2289         * gtkdoc-scangobj.in: patch from Benjamin Otte to get rid of
2290         -Wsign-compare warnings. Bug #137013.
2292 Fri Sep 17 01:13:24 2004  Matthias Clasen  <maclas@gmx.de>
2294         * gtk-doc.xsl: Add the images from the gallery on top
2295         of the refentry they point to.
2297         * style.css: Move the css bits of the gallery implementation
2298         here.
2300 Fri Sep 17 00:30:16 2004  Matthias Clasen  <maclas@gmx.de>
2302         * gtk-doc.xsl: Don't generate <link rel="refentry">
2303         links, since e.g. the GTK+ docs contain MANY refentries.
2305 2004-09-10  Damon Chaplin  <damon@gnome.org>
2307         * autogen.sh: support automake 1.8. (part of #151219).
2309         * examples/Makefile.am: require automake 1.6.
2311         * gtkdoc-scan.in: create an empty MODULE-overrides.txt file if it
2312         doesn't exist. gtkdoc.make expects one to exist.
2314         * doc/setting-up.txt: updated to document new procedure using
2315         gtkdoc.make.
2317         * examples/Makefile.am: updated to use gtkdoc.make.
2319         * examples/configure.in: removed this. gtkdoc.make is used instead
2320         now.
2322         * examples/README: updated.
2324         * Makefile.am (EXTRA_DIST): removed examples/configure.in.
2326 Wed Sep  8 01:12:25 2004  Matthias Clasen  <maclas@gmx.de>
2328         * gtkdoc-scan.in (ScanHeader):
2329         * gtkdoc-mktmpl.in (OutputDeclaration):
2330         * gtkdoc-mkdb.in (OutputFunction): Accept mixtures of *
2331         and const in return types.
2333 Wed Sep 01 05:58:08 2004  Matthias Clasen  <maclas@gmx.de>
2335         * gtkdoc-mkdb.in: Remove a debug printf
2337 Tue Aug 24 02:30:08 2004  Matthias Clasen  <maclas@gmx.de>
2339         * gtk-doc.xsl: Add support for a gallery of widget images.
2341 Wed Jul 28 13:00:54 2004  Jonathan Blandford  <jrb@gnome.org>
2343         * gtk-doc.xsl: remove the examples from the toc.
2345 2004-07-28  Damon Chaplin  <damon@gnome.org>
2347         * doc/sections-file.txt: mention use of '#' for comments.
2349         * gtkdoc-mkdb.in: removed HEADER_FILE stuff, since it isn't used now.
2351 2004-07-23  Damon Chaplin  <damon@gnome.org>
2353         * examples/Makefile.am (all-local): add empty all-local target for
2354         when ENABLE_GTK_DOC is false. (#148209, Martin Quinson)
2356 Fri Jul 23 13:21:34 2004  Matthias Clasen  <maclas@gmx.de>
2358         * gtkdoc-mkdb.in (ScanSourceFile): Fix regexps for matching
2359         ignored files.  (#148211, Martin Quinson)
2361 2004-07-03  Matthias Clasen  <mclasen@redhat.com>
2363         * style.css: Add a missing '}' and align arguments to the
2364         top of their descriptions.  (#145363, #145364, Mariano
2365         Su�rez-Alvarez)
2367 2004-05-18  Matthias Clasen  <mclasen@redhat.com>
2369         * gtk-doc.xsl: Let the docbook stylesheets generate
2370         extra <link rel=...> elements.  (#140221, Geert Stappers)
2372 2004-05-10  Geert Stappers  <stappers@stappers.nl>
2374         * TODO: new file, basicly a reference to bugzilla.
2376         * examples/README: tell about gtk-doc.make.
2378 2004-05-06  Geert Stappers  <stappers@stappers.nl>
2380         * MAINTAINERS: Add myself.
2382 2004-05-05  Matthias Clasen  <mclasen@redhat.com>
2384         * gtk-doc.xsl: Correct the docbook stylesheet version
2385         in which filtered index support will appear to 1.66.
2387 2004-04-27  Geert Stappers  <stappers@stappers.nl>
2389         * README: Updated the information on Debian packages.
2390         Removed old author and time stamp line.
2392 2004-04-21  Matthias Clasen  <mclasen@redhat.com>
2394         * doc/sections-file.txt: Add hint about private types.
2396         * README: Update.
2398         * MAINTAINERS: Add myself.
2400         * gtkdoc-mkdb.in (ReadKnownSymbols): New function which
2401         extracts information about public and private symbols from
2402         the $MODULE-sections.txt file.
2403         (ReadObjectHierarchy): Prune the tree, based on the information
2404         collected by ReadKnownSymbols.
2405         (ReadInterfaces): Also filter out private interfaces here
2406         (ReadPrerequisites): ...and here.
2408 2004-04-19  Matthias Clasen  <mclasen@redhat.com>
2410         * Makefile.am: Add version-greater-or-equal.xsl.
2412         * version-greater-or-equal.xsl: New file, implementing
2413         the version-greater-or-equal template for comparing version
2414         numbers.
2416         * gtk-doc.xsl: Import version-greater-or-equal.xsl and
2417         use the version-greater-or-equal template to a) check that
2418         the xsl stylesheets are not too old and b) to avoid creating
2419         multiple indices if the xsl stylesheets don't support filtered
2420         indices.  (#107774)
2422         * gtkdoc-mkdb.in (MakeIndexterms): Emit role attributes
2423         on indexterms which can be used to create filtered indices
2424         with sufficiently new xsl stylesheets. The required functionality
2425         will appear in version 1.62 of the xsl stylesheets.  (#115530)
2427 2004-04-16  Matthias Clasen  <mclasen@redhat.com>
2429         * style.css: Style information in a separate stylesheet.
2431         * gtkdoc-mkhtml.in: Copy css files.
2433         * Makefile.am (gtkdocdata_DATA): Add style.css
2435         * gtk-doc.xsl: Use a stylesheet instead of hardwiring
2436         styles.  (#134683, Vincent Torri)
2438         * gtkdoc-mkdb.in (GetSignals): Organize the properties
2439         descriptions to fit better with the other sections, and
2440         also display information about allowed and default values.
2442 2004-04-15  Matthias Clasen  <mclasen@redhat.com>
2444         * gtkdoc-scangobj.in: Use introspection more fully to emit
2445         allowed ranges for integral types and default values.
2447         * gtkdoc-mkdb.in (GetSignals): Handle missing signal parameter
2448         names better.
2450 2004-03-04  Damon Chaplin  <damon@gnome.org>
2452         * autogen.sh: fixed URLs to download autoconf/automake/libtool.
2453         Patch from Frederic L. W. Meunier.
2455 2004-02-16  Damon Chaplin  <damon@gnome.org>
2457         * .cvsignore: added gtk-doc.cat and gtkdocize.
2459 === release 1.2 ===
2461 2004-02-16  Damon Chaplin  <damon@gnome.org>
2463         * Released 1.2.
2465 2004-02-16  Damon Chaplin  <damon@gnome.org>
2467         * gtk-doc.cat.in: removed public ID for gtk-doc.dtd, since we don't
2468         use it any more.
2470 Sat Feb 14 02:14:27 2004  Matthias Clasen  <maclas@gmx.de>
2472         * gtk-doc.m4: Avoid unnecessary checks if gtk-doc is
2473         disabled.  (#134221, Julio M. Merino Vidal)
2475 Sat Feb 14 02:03:01 2004  Matthias Clasen  <maclas@gmx.de>
2477         * gtk-doc.make: Don't create unneeded empty
2478         directories.  (#134319, Julio M. Merino Vidal)
2480 Sat Feb 14 01:37:38 2004  Matthias Clasen  <maclas@gmx.de>
2482         * gtk-doc.make: Add an empty all-local target to make it work
2483         with non-GNU make.  (#134343, Julio M. Merino Vidal)
2485 Wed Jan 28 00:52:00 2004  Matthias Clasen  <maclas@gmx.de>
2487         * gtkdoc-mkdb.in (OutputObjectList): Avoid emitting invalid
2488         docbook markup if there are no objects. Partial fix for #132661.
2490 Sun Jan 25 22:01:15 2004  Matthias Clasen  <maclas@gmx.de>
2492         * gtkdoc-mkdb.in: Accept both the old and the new XInclude
2493         namespace.  (#131675, Edd Dumbill)
2495 2004-01-23  Thomas Vander Stichele  <thomas at apestaart dot org>
2497         * gtkdoc-mkhtml.in: exit when tools return non-zero so errors can
2498           be caught.
2500 Thu Jan 15 23:06:10 2004  Matthias Clasen  <maclas@gmx.de>
2502         * gtk-doc.xsl: Set the chunk.fast parameter, to gain some
2503         speed.
2505 Thu Jan 15 23:05:23 2004  Matthias Clasen  <maclas@gmx.de>
2507         * gtkdoc-fixxref.in: Make it work again without explicit
2508         --module.
2510 Sat Dec 27 01:36:08 2003  Matthias Clasen  <maclas@gmx.de>
2512         * gtkdoc-scangobj.in:
2513         * gtkdoc-mktmpl.in:
2514         * gtkdoc-scan.in:
2515         * gtkdoc-fixxref.in: Add --help.  (#126915)
2517 Sat Dec 27 00:43:42 2003  Matthias Clasen  <maclas@gmx.de>
2519         * gtkdoc-mkdb.in (ParseEnumDeclaration):
2520         * gtkdoc-mktmpl.in (ParseEnumDeclaration): Support a trailing ,
2521         in enum declarations. These are a GNU C extension, but also
2522         blessed by C99.  (#129949, Thomas Vander Stichele)
2524 Sun Nov 16 00:29:03 2003  Matthias Clasen  <maclas@gmx.de>
2526         * gtkdoc-scangobj.in: Don't use g_strdown(). (#127028,
2527         David Schleef)
2529 Sun Nov 16 00:26:05 2003  Matthias Clasen  <maclas@gmx.de>
2531         * gtkdoc-scangobj.in: If compiled against GLib >= 2.3.0, look
2532         for properties on interfaces.  (#127068, James M. Cape)
2534 2003-11-03  Dan Winship  <danw@ximian.com>
2536         * gtkdoc-scangobj.in: Clean up $MODULE-scan.o even when using
2537         libtool
2539         * gtkdoc-scanobj.in: Likewise
2541         * gtk-doc.make (CLEANFILES): Remove $(MODULE)-scan.o from here
2542         (clean-local): rm -rf .libs
2544 Wed Oct  8 01:21:54 2003  Matthias Clasen  <maclas@gmx.de>
2546         * gtkdoc-scan.in (ScanHeader): Make gtkdoc-scan grok
2547         typedef struct { } foo; in addition to the more baroque
2548         typedef struct _foo foo; struct _foo { };
2549         (#116807, Malcolm Tredinnick)
2551 Wed Oct  8 01:21:35 2003  Matthias Clasen  <maclas@gmx.de>
2553         * gtkdoc-mkdb.in (OutputParamDescriptions): Remove a pointless
2554         warning.
2556 2003-10-01  Matthias Clasen  <maclas@gmx.de>
2558         Make signals and properties end up in the right template
2559         file (#116569, Owen Taylor):
2561         * gtkdoc-mktmpl.in (OutputSignalTemplates):
2562         (OutputArgTemplates): Return a string rather than directly
2563         writing to OUTPUT.
2564         (OutputTemplateFile): Don't interpret $title as the name of
2565         the object to print signal and property templates for.
2566         (UpdateTemplates): Collect signal and property templates for all
2567         objects contained in the section.
2569 2003-08-10  James Henstridge  <james@daa.com.au>
2571         * acinclude.m4 (JH_PATH_XML_CATALOG): allow caller to specify
2572         actions if found or not found.
2573         (JH_CHECK_XML_CATALOG): when requiring JH_PATH_XML_CATALOG, don't
2574         error out if it is not found.
2576 2003-08-03  Matthias Clasen  <maclas@gmx.de>
2578         * doc/gnome.txt: Add some hints regarding markup of examples.
2580 2003-07-22  Matthias Clasen  <maclas@gmx.de>
2582         * configure.in:
2583         * gtk-doc.cat: Fix a problem with the previous commit.
2585 2003-07-21  Matthias Clasen  <maclas@gmx.de>
2587         Applied patches from Sebastian Rittau to add maintainer mode and an SGML catalog.  (#117955, #117956)
2589         * gtk-doc.cat.in: New catalog file.
2590         * configure.in: Added gtk-doc.catalog to output files.
2591         * Makefile.am: Install gtk-doc.catalog.
2593         * configure.in: Added AM_MAINTAINER_MODE.
2594         * autogen.sh: Added --enable-maintainer-mode to configure options.
2596 2003-07-09  Matthias Clasen  <maclas@gmx.de>
2598         * gtkdoc-mktmpl.in (ParseStructDeclaration):
2599         * gtkdoc-mkdb.in (ParseStructDeclaration): Accept volatile struct members, which have just
2600         made their appearance in glib.
2602 2003-06-29  Matthias Clasen  <maclas@gmx.de>
2604         * gtkdoc-mkdb.in (ExpandAbbreviations): When expanding @param, catch the common @param->field
2605         and @param.field, to reduce the need for littering the C sources with <literal>foo->bar</literal>.
2607 2003-06-25  Matthias Clasen  <maclas@gmx.de>
2609         Changes for #115528:
2611         * gtkdoc-mkdb.in (OutputSGML): Collect hierarchy, interfaces, implementations, prerequisites
2612         and derived interfaces separately.
2613         (OutputSGMLFile): Take two more arguments: implementations and derived interfaces.
2614         (GetHierarchy): Also put immediate children in the local tree.
2615         (GetInterfaces): Split into GetInterfaces and GetImplementations.
2616         (GetImplementations): New function to get the implementations of an interface.
2617         (GetDerived): New function to get the known derived interfaces of an interface.
2619         * gtkdoc-mkdb.in (MakeXRef): Accept a second, optional parameter for the
2620         text of the link.
2621         (ExpandAbbreviations): Add semantic markup inside the links, so that
2622         non-crossreferenced symbols come out properly formatted after link
2623         removal.  (#61345)
2625 2003-06-15  Matthias Clasen  <maclas@gmx.de>
2627         Support for a flat index of all symbols.  (#92861)
2628         To use, put an empty <index/> element in your driver document.
2630         * gtkdoc-mkdb.in (MakeIndexterms): New function, emits an indexterm.
2631         (OutputMacro, OutputTypedef, OutputStruct, OutputEnum,
2632         OutputUnion, OutputVariable, OutputFunction): Use MakeIndexterms.
2633         to emit indexterms for symbols.
2635         * gtkdoc-mkdb.in (GetSignals):
2636         (GetArgs): Emit Since: information for signals and properties.
2638 Thu Jun 12 15:55:57 2003  Owen Taylor  <otaylor@redhat.com>
2640         * gtkdoc-mkhtml.in (declaration): Replace head -1 with -n 1.
2641         (Merge change by Elliot Lee from Red Hat package)
2643 2003-06-11  Matthias Clasen  <maclas@gmx.de>
2645         * doc/gnome.txt: Updates to the documentation of inline comments.
2647 2003-06-03  Matthias Clasen  <maclas@gmx.de>
2649         * gtk-doc.spec.in: Add a missing Provides: and include the .pc file.
2650         (#106568, Joe Pranevich)
2652 2003-05-27  Matthias Clasen  <maclas@gmx.de>
2654         * gtkdoc-mkdb.in (GetSignals):
2655         (GetArgs): Add signals and properties to the statistics.
2656         (OutputMissingDocumentation): Emit undocumented signals and
2657         properties.  (#113645)
2659 2003-04-21  Matthias Clasen  <maclas@gmx.de>
2661         * tools/docpercentages.pl: Fix autolinkification for undocumented
2662         symbols.
2664         * doc/style-guide.txt: Typo fix.
2666 === release 1.1 ===
2668 2003-04-18  James Henstridge  <james@daa.com.au>
2670         * Released 1.1.
2672 2003-04-18  James Henstridge  <james@daa.com.au>
2674         * NEWS: add news items.
2676         * configure.in: increment version number.
2678 2003-03-14  Matthias Clasen  <maclas@gmx.de>
2680         * gtkdoc-mkdb.in (OutputBook): Fix the public identifier for
2681         DocBook V3.0: Davenport, not DavenPort.
2682         (#108343, Mariano Suarez-Alvarez)
2684 2003-03-10  James Henstridge  <james@daa.com.au>
2686         * configure.in: associate the chmod commands with the files they
2687         are chmod'ing.  This way config.status will always run the correct
2688         chmod command.
2690 2003-03-04  James Henstridge  <james@daa.com.au>
2692         * configure.in: look up the docbook DTD by public id rather than
2693         system id.
2695 2003-02-26  Matthias Clasen  <maclas@gmx.de>
2697         * gtkdoc-mkdb.in (GetArgs): Prefer template or comment docs over
2698         blurbs only if they're nonempty, otherwise the empty docs from the
2699         templates override all the blurbs.
2701 2003-02-26  James Henstridge  <james@daa.com.au>
2703         * autogen.sh (THEDIR): set up so that it will choose automake 1.7
2704         or 1.6 in preference to 1.4.  Passes distcheck okay.
2706         * configure.in: update configure.in script to match
2707         recommendations of newer autoconf's, and add an AC_PREREQ()
2708         statement, since the xml catalog checks are using new autoconf
2709         features.
2711         * gtk-doc.make (xml-build.stamp): since other bits of the makefile
2712         were assuming xml, may as well hard code --output-format=xml.
2714 2003-02-19  James Henstridge  <james@daa.com.au>
2716         * Makefile.am: get rid of the dist-hook, and just include the
2717         given files in EXTRA_DIST instead.
2719         * configure.in: provide meaningful names for the commands.
2721         * acinclude.m4 (JH_CHECK_XML_CATALOG): add some extra arguments: a
2722         friendly name for the catalog entry, and actions to run if the
2723         entry was found or not.  Also include a bit more information in
2724         the config.log file if an error occurs.
2726 2003-02-18  Matthias Clasen  <maclas@gmx.de>
2728         * gtkdoc-mkhtml.in (declaration): Avoid the unportable grep
2729         option -q.  (#105311)
2731 2003-02-19  James Henstridge  <james@daa.com.au>
2733         * devhelp.xsl: put chapters that aren't at the top level into the
2734         toc tree (to make gtk's .devhelp tree look better).
2736         * gtk-doc.spec.in (Requires): make the requires lines match
2737         current requirements ...
2739         * gtkdoc-mkhtml.in (XSLTPROC): pass --nonet to xsltproc, so we
2740         don't try to download DTDs and XSLT over the net.  The configure
2741         checks should catch people who don't have the correct files in
2742         their catalog.
2744 2003-02-17  James Henstridge  <james@daa.com.au>
2746         * gtkdocize.in (--version): add --version argument.
2748 2003-02-14  James Henstridge  <james@daa.com.au>
2750         * gtkdoc-mkdb.in (GetOptions): actually accept --tmpl-dir as a
2751         command line option.  Based on a patch from Simon Josefsson
2752         <jas@extundo.com>.
2754         * gtk-doc.xsl: remove the xmlns declaration.  Not really needed
2755         for html output anyway ...
2757 2003-02-13  James Henstridge  <james@daa.com.au>
2759         * devhelp.xsl: remove refsect1's and refsect2's from book tree, as
2760         suggested by Hallski.
2762         * gtk-doc.make (install-data-local): the change to install images
2763         was superfluous, so I have removed it.
2764         (CLEANFILES): move some more stuff to CLEANFILES from the
2765         distclean-local rule.
2767 2003-02-12  James Henstridge  <james@daa.com.au>
2769         * gtk-doc.make: add some chmod calls to work arround distcheck on
2770         automake >= 1.6.
2771         (install-data-local): copy the images as well as the html files
2772         during install.
2773         (uninstall-local): add an uninstall rule to remove the docs.
2774         (CLEANFILES): add $(DOC_MODULE)-scan.o to the list of files to be
2775         cleaned up.
2777 2003-02-09  James Henstridge  <james@daa.com.au>
2779         * gtkdocize.in: script used to copy gtk-doc.make into another
2780         module.
2782         * gtk-doc.make: automake makefile fragment to handle gtk-doc
2783         support in other modules.
2785         * configure.in: check to make sure DocBook XML DTD and XSLT
2786         stylesheets are present in the XML catalog.
2788         * acinclude.m4 (JH_CHECK_XML_CATALOG): new macro to check for
2789         entries in the XML catalog.
2791 2003-02-04  James Henstridge  <james@daa.com.au>
2793         * gtk-doc.m4: a macro to check for gtk-doc.
2795         * Makefile.am (gtkdocdata_DATA): don't bother installing xml.dcl.
2796         It isn't used anymore (since switching xml mode to xsltproc).
2798         * gtkdoc-mkhtml.in (gtkdocdir): and here.
2800         * Makefile.am (gtkdocdatadir): change dir.
2802         * configure.in: put data files in $(datadir)/gtk-doc/data, so that
2803         they don't all get mixed up with the html docs installed by other
2804         packages.
2806 === release 1.0 ===
2808 2003-01-20  Damon Chaplin  <damon@gnome.org>
2810         * Released 1.0.
2812 2003-01-20  Damon Chaplin  <damon@gnome.org>
2814         * configure.in: bumped version to 1.0, and added SGML_OUTPUT_TYPE
2815         variable, which we set to 'sgml-raw' if we have openjade, or 'sgml'
2816         if we have jade. Added gtk-doc.pc to AC_OUTPUT.
2818         * gtkdoc-mkhtml.in: used SGML_OUTPUT_TYPE variable to set the output
2819         type of jade/openjade.
2821         * gtk-doc.pc.in: new pkg-config file, which apps can use to reliably
2822         check the gtk-doc version in future.
2824         * Makefile.am (pkgconfigdir): install .pc file, and add it to
2825         EXTRA_DIST.
2827         * examples/configure.in: updated example to use pkg-config for the
2828         version check.
2830 2003-01-18  James Henstridge  <james@daa.com.au>
2832         * gtkdoc-mkhtml.in (declaration): switch the output type from
2833         "sgml" to "sgml-raw" when using Jade to process docs.  This gets
2834         rid of the line breaks inside the tags, which were confusing Lynx.
2836 2003-01-15  Matthias Clasen  <maclas@gmx.de>
2838         * gtkdoc-scan.in (ScanHeader): Remove special cases for Pango and
2839         Bonobo.
2840         * gtkdoc-mkdb.in (OutputDeclaration):
2841         * gtkdoc-mktmpl.in (OutputDeclaration): Remove special cases for
2842         structs named BlablaClass.  (#95398)
2844         * gtkdoc-mkdb.in (GetInterfaces): Fix an off-by-one error.
2845         (#103466, Josh Parsons)
2847 2002-12-28 Chema Celorio <chema@celorio.com>
2849         * gtkdoc-scan[g]obj.in: add "void" to functions with no parameters,
2850         avoids warning with -Wmissing-prototypes when compiling
2851         {module}-scan.c
2853 2002-12-16  James Henstridge  <james@daa.com.au>
2855         * gtk-doc.spec.in: require perl >= 5.6.0
2857         * configure.in: require Perl >= 5.6.0
2859         * gtkdoc-fixxref.in: add "use bytes;" to fix malformed UTF-8
2860         character errors when run with a UTF-8 locale.
2862 2002-12-16  Matthias Clasen  <maclas@gmx.de>
2864         * gtkdoc-mkdb.in (OutputSGMLFile): Don't emit the additional
2865         anchors in the title which breaks the generated html (the title
2866         text is copied around). Instead, put the anchors before the
2867         synopsis. This isn't perfect, but the best we can achieve without
2868         stylesheet hackery.
2870 2002-12-13  Matthias Clasen  <maclas@gmx.de>
2872         * gtkdoc-mkdb.in: Add an --ignore-files option which can be used
2873         to omit files or directories from scanning.
2874         (OutputSGMLFile): Emit anchors for all objects contained in the
2875         file to avoid dangling links.
2876         (OutputMissingDocumentation): Emit deprecated symbols after
2877         undeprecated ones.
2879 2002-12-12  Matthias Clasen  <maclas@gmx.de>
2881         * gtkdoc-scan.in (ScanHeader): Also recognize "positive" guards
2882         like #ifdef GTK_ENABLE_BROKEN.
2884 2002-12-11  Matthias Clasen  <maclas@gmx.de>
2886         * gtk-doc.xsl: Change XPath path to "//anchor|//refentry" for the
2887         generation of index.sgml. The previous path "//anchor|refentry"
2888         was not matching any refentrys.
2890 2002-12-09  Matthias Clasen  <maclas@gmx.de>
2892         * gtkdoc-mktmpl.in (UpdateTemplates): Emit unused class structs
2893         to $MODULE-unused.txt.
2895 2002-12-08  Matthias Clasen  <maclas@gmx.de>
2897         * gtkdoc-mkdb.in (OutputStruct): Don't emit private parts
2898         of class structs to parameter lists in docs. Remove leftover
2899         debugging output.
2901         * gtkdoc-mktmpl.in (OutputDeclaration): Don't emit private parts
2902         of class structs to parameter lists in templates.
2904 2002-12-06  Matthias Clasen  <maclas@gmx.de>
2906         Improved /*< private >*/ handling:  (#95398)
2908         * gtkdoc-mkdb.in (OutputStruct): Handle /*< public >*/ and
2909         /*< private >*/ for all structs. Default to private for object and
2910         class structs, to public for all other structs.
2912         * gtkdoc-scan.in (ScanHeader): Emit declarations for class structs
2913         to $MODULE-decl.txt.
2915 2002-12-05  Matthias Clasen  <maclas@gmx.de>
2917         * gtkdoc-mktmpl.in (OutputDeclaration):
2918         * gtkdoc-mkdb.in (ReadTemplateFile): Support @Since: and
2919         @Deprecated: as a way to specify since and deprecated information
2920         in template files. This works for all kinds of symbols, even those
2921         which normally don't have parameter lists.
2923 2002-12-02  Matthias Clasen  <maclas@gmx.de>
2925         * gtkdoc-mkdb.in (MakeDeprecationNote): Support multi-paragraph
2926         deprecation notes.
2928 2002-11-29  James Henstridge  <james@daa.com.au>
2930         * gtkdoc-mkhtml.in: copy the navigation images for both XML and
2931         SGML cases.
2933         * gtk-doc.dsl.in: update DSSSL stylesheets to match layout of XSL
2934         ones.
2936 2002-11-29  Matthias Clasen  <maclas@gmx.de>
2938         * gtkdoc-scan.in (ScanHeader): Make deprecation guards work with
2939         both
2940         #ifndef DEPRECATION_GUARD
2941         #if !defined(DEPRECATION_GUARD) || defined(FOO_COMPILATION)
2942         The second form is used in GDK and GTK+ to include selected
2943         deprecated symbols when compiling the library itself.
2945 2002-11-27  Matthias Clasen  <maclas@gmx.de>
2947         * gtkdoc-mkdb.in: Parse to new tags in inline doc comments,
2948         Since: and Deprecated:, which can be placed after the Returns:
2949         tag. Emit the Since: information (which is expected to be just a
2950         version number) after the parameters and the Deprecated:
2951         information (which is expected to be one or more full sentences)
2952         inside the deprecation warning.
2953         Warn if a Deprecated: tag is found on a symbol which is not
2954         guarded by a deprecation guard in the header.
2956 2002-11-26  James Henstridge  <james@daa.com.au>
2958         * gtkdoc-mkhtml.in: set gtkdoc-bookname and gtkdoc-version
2959         parameters in sgml mode, and don't bother with the sed run after
2960         processing with jade.
2961         In XML mode, pass the version number in as a parameter too.
2963         * gtk-doc.dsl.in ($user-html-header$): add <meta> tag if
2964         gtkdoc-version is set.
2965         (generate-index-mode): if gtkdoc-bookname is set, add it to the
2966         hrefs in the index file, like the XSLT sheets do.
2968         * gtk-doc.xsl: add gtkdoc.version parameter, and use it to add a
2969         <meta> tag with the gtk-doc version number.
2971 === release 0.10 ===
2973 2002-11-16  Damon Chaplin  <damon@gnome.org>
2975         * Released 0.10.
2977 2002-11-16  Damon Chaplin  <damon@gnome.org>
2979         * configure.in: bumped version to 0.10.
2981         * Makefile.am (EXTRA_DIST): added MAINTAINERS.
2983         * README: updated requirements info, mainly to add XML stuff.
2985         * NEWS: added news for 0.10
2987         * MAINTAINERS:
2988         * AUTHORS: updated my email address.
2990 2002-11-16  James Henstridge  <james@daa.com.au>
2992         * gtk-doc.xsl: output HTML in ISO-8859-1 (latin1), as using UTF-8
2993         can trigger misinterpretation of web pages when the web server
2994         asserts that the document is encoded in latin1 in the mime type.
2996 2002-11-15  James Henstridge  <james@daa.com.au>
2998         * gtk-doc.xsl: small changes to make the output closer to valid
2999         HTML.
3001         * gtkdoc-fixxref.in (MakeXRef): when substituting in cross
3002         references, use lower case element and attribute names, and quote
3003         the attribute value.
3005 2002-11-12  James Henstridge  <james@daa.com.au>
3007         * gtkdoc-mkdb.in: put content of parameter descriptions in
3008         <simpara> elements instead of <para>'s.  This makes the generated
3009         HTML more compact, as it will omit the <p> tag inside the list
3010         item.
3012         * gtk-doc.xsl: adjust stylesheet a little.
3014 2002-11-10  James Henstridge  <james@daa.com.au>
3016         * gtk-doc.xsl: change style for documentation.
3018         * gtkdoc-mkhtml.in (declaration): copy PNG files to the html
3019         directory.
3021 2002-11-10  Matthias Clasen  <maclas@gmx.de>
3023         * gtkdoc-mkdb.in (GetArgs): Expand abbreviations in source doc
3024         comments.
3026 2002-11-09  Matthias Clasen  <maclas@gmx.de>
3028         * gtkdoc-mktmpl.in (OutputSignalTemplates): Don't replace template
3029         param names with meaningless argn names generated by gtkdoc-scangobj.
3031         * gtkdoc-mkdb.in (GetSignals): Use argument names from source doc
3032         comments, if available.
3033         (GetArgs): Use source doc comments instead of blurb, if available.
3034         (ScanSourceFile): Also accept object::signal and object:property
3035         symbols.
3036         (MergeSourceDocumentation): For signals only, prefer source doc
3037         param names over template param names.
3039 Fri Nov  8 15:10:57 2002  Owen Taylor  <otaylor@redhat.com>
3041         * gtkdoc-mkdb.in (GetPrerequisites): Add missing <para>
3042         here too.
3044 Mon Nov  4 17:17:40 2002  Owen Taylor  <otaylor@redhat.com>
3046         * gtkdoc-mkdb.in (MergeSourceDocumentation): Warn
3047         when overriding docs in template file by inline comments.
3049         * gtkdoc-mkdb.in (GetInterfaces): Add missing <para> in
3050         "Implemented interfaces" output.
3052 2002-10-29  Damon Chaplin  <damon@ximian.com>
3054         * gtkdoc-scangobj.in: in get_type_name() set is_pointer to TRUE for
3055         subtypes of G_TYPE_BOXED and G_TYPE_POINTER. This means we get things
3056         like "GtkTreeIter *iter" rather than "GtkTreeIter iter" which was
3057         incorrect. Also return 'GParamSpec*' for G_TYPE_PARAM.
3058         in lookup_signal_arg_names() changed GtkNotebook::switch-page
3059         page argument to guint. And fixed a few other entries.
3060         Also fixed argument numbering, so we don't get 2 "widget" arguments.
3062         * gtkdoc-scanobj.in: add ';' after unlink command to avoid warning.
3064 2002-10-20  Matthias Clasen  <maclas@gmx.de>
3066         * examples/Makefile.am (SCANOBJ_FILES): Add $(DOC_MODULE).prerequisites.
3068         * gtkdoc-mkdb.in: Read $MODULE.prerequisites and put list of
3069         prerequisites below the object hierarchy for interfaces.
3071         * gtkdoc-scangobj.in: Write information about interface
3072         prerequisites to $MODULE.prerequisites.
3074 2002-10-15  Matthias Clasen  <maclas@gmx.de>
3076         * gtkdoc-scangobj.in: Sort paramspec arrays for
3077         greater stability and less random tmpl file diffs.
3079 2002-10-14  Matthias Clasen  <maclas@gmx.de>
3081         * examples/Makefile.am (SCANOBJ_FILES): Add $(DOC_MODULE).interfaces.
3083         * gtkdoc-mkdb.in: Read $MODULE.interfaces and put lists of
3084         implemented interfaces/known implementations below the object
3085         hierarchy for classes/interfaces.
3087         * gtkdoc-scangobj.in: Write interface information to
3088         $MODULE.interfaces.
3090 2002-10-12  Matthias Clasen  <maclas@gmx.de>
3092         * gtkdoc-scangobj.in: Make interface appear in the object hierarchy.
3094 2002-10-11  Matthias Clasen  <maclas@gmx.de>
3096         * gtk-doc.xsl: use 'UTF-8', not UTF-8 for default.encoding, to
3097         make the encoding actually appear in the resulting HTML.
3099 2002-10-09  James Henstridge  <james@daa.com.au>
3101         * gtkdoc-mkdb.in: set $doctype_header to "" for the SGML case, as
3102         we don't add a doctype to the beginning of SGML fragments.
3104 Tue Sep 17 01:07:51 2002  Jonathan Blandford  <jrb@gnome.org>
3106         * gtk-doc.xsl: output the chunks in UTF-8 so other tools can use
3107         them.
3109 2002-09-03  James Henstridge  <james@daa.com.au>
3111         * gtk-doc.xsl: turn on rendering of variablelists as tables, and
3112         set CSS rules to style .variablelist instead of .informaltable.
3114         * gtk-doc.dsl.in (variablelist): override the variablelist handler
3115         instead of the tgroups.
3117         * gtkdoc-mkdb.in (OutputStruct): use a <variablelist> for listing
3118         the field descriptions.
3119         (OutputEnum): same here.
3120         (OutputParamDescriptions): and here.
3122 2002-08-12  James Henstridge  <james@daa.com.au>
3124         * gtk-doc.xsl: include devhelp.xsl, and call generate.devhelp when
3125         processing the docbook/xml input.
3127         * devhelp.xsl: new file, implements .devhelp file output.
3129 2002-08-18  Havoc Pennington  <hp@pobox.com>
3131         * autogen.sh: hardcode aclocal-1.4/automake-1.4 so that users with
3132         both automake 1.6 and 1.4 installed get the right automake. Means
3133         compilation from CVS will now require the latest automake 1.4
3134         release, or manually creating symlinks called "automake-1.4" and
3135         "aclocal-1.4"
3137 2002-08-08  Matthias Clasen  <maclas@gmx.de>
3139         * gtkdoc-scangobj.in: Make sure blurbs end with a '.'
3141 2002-08-08  James Henstridge  <james@daa.com.au>
3143         * gtk-doc.xsl: add a gtkdoc.bookname param, and include it in the
3144         index.sgml output (if not empty).
3146         * gtkdoc-mkhtml.in: only perform the sed operation if we are using
3147         Jade, and pass the module name as a parameter when using xsltproc.
3149 2002-08-04  Matthias Clasen  <maclas@gmx.de>
3151         * gtkdoc-scangobj.in: Don't try to list signals on types which
3152         don't support signals, e.g. boxed types.
3154 2002-06-14  jacob berkman  <jacob@ximian.com>
3156         * gtkdoc-mkdb.in: do the version check before help, so --version
3157         doesn't output --help (should fix recent build bustage)
3159 2002-06-12  Matthias Clasen  <maclas@gmx.de>
3161         * gtkdoc-mkdb.in: Make header-grabbing work without an explicit
3162         --main-sgml-file argument.
3164         * gtkdoc-mkdb.in: Emit the object hierarchy as a <screen> rather
3165         than a <literallayout>, since the Docbook XSL stylesheets don't
3166         handle <link>s inside <literallayout>.
3168         * gtkdoc-mkdb.in: Decide wether to generate standalone documents
3169         for XIncluding or entities based on the presence of the XInclude
3170         namespace declaration on the document element.
3172 2002-06-09  James Henstridge  <james@daa.com.au>
3174         * gtkdoc-mkdb.in: try to grab the header off the top of the main
3175         sgml file.
3177 2002-05-31  James Henstridge  <james@daa.com.au>
3179         * gtkdoc-mkdb.in (OutputSGML): put XIncludes in the $book_bottom
3180         variable.
3181         (OutputBook): add the XInclude namespace declaration to the book
3182         element.
3184         * gtkdoc-mkhtml.in (declaration): if the document looks like XML,
3185         process it with xsltproc.
3187         * configure.in: check for xsltproc.
3189         * gtk-doc.xsl: start of XSLT template for converting docbook/xml
3190         to HTML.
3192 2002-06-03  Matthias Clasen  <maclas@gmx.de>
3194         * gtkdoc-mkdb.in (ConvertSGMLChars): Don't use Posix character
3195         classes. Perl < 5.6 doesn't have them; and the API doc autobuilder
3196         on widget.gnome.org has an old Perl.
3198 2002-05-29  Matthias Clasen  <maclas@gmx.de>
3200         Fixes for #77193:
3202         * gtkdoc-mkdb.in (OutputSGML): Call GetSignals, GetArgs and
3203         GetHierarchy for each symbol here and accumulate.
3204         (OutputSGMLFile): Get signal, argument and hierarchy information
3205         from the caller.
3206         (GetSignals, GetArgs, GetHierarchy): Don't wrap the return value
3207         in a refsect1, so that the results of multiple calls can be accumulated.
3209 2002-05-28  Matthias Clasen  <maclas@gmx.de>
3211         * gtkdoc-mkdb.in (ConvertSGMLChars): Make this work correctly
3212         for empty elements and XML comments in doc comments.
3214 2002-05-27  Matthias Clasen  <maclas@gmx.de>
3216         * gtkdoc-mkdb.in (ReadTemplateFile, OutputSGMLFile):
3217         Use only the basename of the template file in the key for the
3218         symbol table, in order to decouple the file extensions of the
3219         template files and the generated entities (we want to generate
3220         .xml entities from .sgml template files when emitting XML).
3222 2002-05-25  Matthias Clasen  <maclas@gmx.de>
3224         * gtkdoc-mkdb.in (ConvertSGMLChars): New function which tries to
3225         be a bit more clever when escaping SGML syntax characters.
3226         (ScanSourceFile): Use ConvertSGMLChars instead of CreateValidSGML.
3227         This reduces the work needed to make gtk-doc emit XML (where <, &
3228         and friends must always be escaped).
3230 2002-05-18  Matthias Clasen  <maclas@gmx.de>
3232         * gtkdoc-mkhtml.in: Detect whether we're processing SGML or XML.
3234         * gtkdoc-mkdb.in: New option --output-format to switch between
3235         SGML and XML output.
3237         * Makefile.am (EXTRA_DIST): Add xml.dcl
3239         * xml.dcl: The XML declaration.
3241 2002-05-06  jacob berkman  <jacob@ximian.com>
3243         * gtkdoc-scangobj.in: add an include for the GTK_CHECK_VERSION
3244         macro
3246 2002-05-05  Matthias Clasen  <maclas@gmx.de>
3248         * gtkdoc-scangobj.in: Output style properties.  (#80659)
3250         * gtkdoc-mkdb.in (GetArgs): Return separate sections for
3251         properties, child properties and style properties.  (#80659)
3253 2002-05-03  Matthias Clasen  <maclas@gmx.de>
3255         * gtkdoc-scangobj.in: Fix for segfault in scangobj-generated C
3256         program on Solaris.  (#80606, Jacob Berkman)
3258 2002-05-01  Matthias Clasen  <maclas@gmx.de>
3260         * tools/docpercentages.pl: Add the script which Owen uses for the
3261         d.g.o online API docs. Its easier to keep in sync here.
3263         * gtkdoc-mkdb.in (OutputMissingDocumentation): Fix
3264         $MODULE-undocumented.txt for d.g.o online API docs.
3266         * gtkdoc-mkdb.in (GetArgs): Use blurbs for property documentation.
3268         * gtkdoc-scangobj.in: Output child properties. Output nicks and
3269         blurbs for properties.
3271 2002-04-28  Matthias Clasen  <maclas@gmx.de>
3273         * gtkdoc-mkdb.in (ScanSourceFile): Don't scan for return value
3274         descriptions unnecessarily.  (#65997)
3276 2002-03-11  Matthias Clasen  <maclas@gmx.de>
3278         * gtkdoc-scangobj.in, gtkdoc-mkdb.in: Create docs for signals on interfaces.
3280 2002-02-01  Damon Chaplin  <damon@ximian.com>
3282         * configure.in: check for openjade or jade. Patch from Stefan Kost
3283         <kost@imn.htwk-leipzig.de>.
3285         * gtkdoc-mkhtml.in: use @JADE@ so the correct version of jade is used.
3287         * autogen.sh: commented out autoheader since we don't have a config.h.
3289 === release 0.9 ===
3291 2002-01-18  Damon Chaplin  <damon@ximian.com>
3293         * Released 0.9.
3295 2002-02-01  Damon Chaplin  <damon@ximian.com>
3297         * examples/Makefile.am: added SCANOBJ_OPTIONS in case the module needs
3298         to pass options to gtkdoc-scanobj or gtkdoc-scangobj.
3300 2002-01-24  Damon Chaplin  <damon@ximian.com>
3302         * tools/gtk-doc.el: added Zucchi's emacs lisp for automatically adding
3303         skeleton comment blocks above functions. Very handy!
3305 2002-01-23  Damon Chaplin  <damon@ximian.com>
3307         * configure.in: bumped the version to 0.9, so GTK+ can depend on this
3308         if it wants to.
3310         * gtkdoc-scangobj.in: we now default to calling g_type_init() to
3311         initialize the type system, rather than gtk_init(). This means you
3312         don't need an X connection to build the docs any more. Hurrah!
3313         Also added a '--type-init-func' argument so you can change the
3314         function to be called. GTK+ uses --type-init-func="gtk_type_init(0)".
3316         * gtkdoc-scan.in (ScanHeader): removed 'Found object' debug message.
3318 === release 0.8 ===
3320 2002-01-18  Damon Chaplin  <damon@ximian.com>
3322         * Released 0.8.
3324 2002-01-18  Damon Chaplin  <damon@ximian.com>
3326         * Makefile.am (EXTRA_DIST): added gtk-doc.dcl to EXTRA_DIST.
3328 2002-01-18  Damon Chaplin  <damon@ximian.com>
3330         * gtkdoc-scangobj.in: Reverted jacob's patch for this release, since
3331         it breaks GTK+ and possibly other packages. I'll re-apply it after
3332         the release, so we can fix everything in CVS.
3334 2002-01-18  jacob berkman  <jacob@ximian.com>
3336         * gtkdoc-scangobj.in: default to calling g_type_init(), remove
3337         --nogtkinit argument and replace with a more flexible
3338         --type-init-func
3340 2002-01-18  Damon Chaplin  <damon@ximian.com>
3342         * gtkdoc-mkdb.in (ScanSourceFile): patch from Matthias Clasen
3343         <matthiasc@poet.de> to only strip first space after '*' in source
3344         code comment blocks, so example code can be indented as desired.
3345         Bug #68216.
3347 Wed Nov 21 16:50:35 2001  Owen Taylor  <otaylor@redhat.com>
3349         * gtkdoc-mkdb,tmpl.in: Add some extra quoting to
3350         error messages to make it clearer what is going on
3351         with trailing commas on enumeration declarations.
3353 Wed Nov 21 16:00:45 2001  Owen Taylor  <otaylor@redhat.com>
3355         * Applied patch from Matthias Clasen to use a modified
3356         .dcl file with the 44 character name length limit removed.
3357         (#61342)
3359 2001-10-17  Damon Chaplin  <damon@ximian.com>
3361         * gtkdoc-mkdb.in: applied patch from Matthias Clasen
3362         <matthiasc@poet.de> to take a --sgml-mode argument which means
3363         all comment blocks in the source code are assumed to be DocBook
3364         (i.e. we don't convert '<', '>' and '&' to '&lt;' etc.
3366 2001-10-09  Damon Chaplin  <damon@ximian.com>
3368         * gtkdoc-mkdb.in (OutputMissingDocumentation): changed %.2f to %.0f
3369         so hopefully the automated reports on developer.gnome.org will work
3370         OK again.
3372 2001-10-02  Damon Chaplin  <damon@ximian.com>
3374         * gtkdoc-mktmpl.in (OutputDeclaration):
3375         * gtkdoc-mkdb.in (OutputFunction): applied patch from
3376         matthiasc@poet.de (Matthias Clasen) to handle G_CONST_RETURN in a
3377         parameter list. Bug #61341.
3379 2001-10-02  Damon Chaplin  <damon@ximian.com>
3381         * gtkdoc-mkdb.in (OutputMissingDocumentation): applied patch from
3382         matthiasc@poet.de (Matthias Clasen) to output percentages better.
3383         Bug #61467.
3384         Also set percent to 100 if total is 0, avoiding divide-by-zero.
3386 2001-10-02  Damon Chaplin  <damon@ximian.com>
3388         * examples/Makefile.am (DOC_OVERRIDES): define as an empty string,
3389         even when not used.
3391 2001-09-13  Damon Chaplin  <damon@ximian.com>
3393         * gtkdoc-mkdb.in (OutputMissingDocumentation): initialize buffer to "".
3394         Fix for SGI from David Kaelbling <drk@sgi.com>.
3396 Sat Sep  8 14:08:51 2001  Jonathan Blandford  <jrb@webwynk.net>
3398         * gtkdoc-scan.in (ScanHeader): recognize GET_IFACE macros
3400 2001-09-08  Havoc Pennington  <hp@pobox.com>
3402         * gtkdoc-mkdb.in (GetArgs): Title the section on object properties
3403         "Properties" instead of "Args"
3405 2001-08-14  Laszlo Peter  <laca@ireland.sun.com>
3407         * gtkdoc-scanobj.in:
3408         * gtkdoc-scangobj.in: change \n's to \\n's in perl scripts
3409         generating C code.
3411 2001-08-12  Jens Finke <jens@gnome.org>
3413         * Updated gtk-doc.spec.in file to match gpp standard.
3415 === release 0.7 ===
3417 2001-08-04  Damon Chaplin  <damon@ximian.com>
3419         * Released 0.7
3421 2001-08-04  Damon Chaplin  <damon@ximian.com>
3423         * gtkdoc-mkdb.in (OutputFunction):
3424         * gtkdoc-mktmpl.in (OutputDeclaration): patch from Lowell Johnson
3425         <ldjohn@usgs.gov> to accept things like "long long", "short int",
3426         "char test[][CLEN]" as function parameters.
3428 2001-07-20  Anders Carlsson  <andersca@gnome.org>
3430         * gtkdoc-scangobj.in: Remove argument to g_type_init ();
3432 2001-07-09  Damon Chaplin  <damon@ximian.com>
3434         * gtkdoc-mkdb.in (ParseStructDeclaration): accept G_CONST_RETURN
3435         modifier for function return values. gtkdoc-mktmpl.in already had this.
3437 Thu Jun 21 11:57:16 2001  Owen Taylor  <otaylor@redhat.com>
3439         * gtkdoc-scangobj.in: Conform to changes in GObject API
3440         for property retrieval.
3442 2001-05-25  Peter Williams  <peterw@ximian.com>
3444         * gtkdoc-mkdb.in (ScanSourceFile): Skip single-line comments --
3445         prevents barfing on ORBit-generated files.
3447 2001-05-20  Damon Chaplin  <damon@ximian.com>
3449         * examples/Makefile.am (sgml-build.stamp): replaced use of wildcard
3450         (which isn't portable) with original *.sgml. I think this just means
3451         that the first time you try to build the docs it will fail, but if
3452         you run make again it will work.
3454         * doc/setting-up.txt: explained that make may fail the first time.
3456 2001-05-19  Damon Chaplin  <damon@ximian.com>
3458         * README:
3459         * doc/README:
3460         * doc/setting-up.txt:
3461         * doc/sections-file.txt:
3462         * doc/authors.txt: updated docs to cover simpler setup procedure.
3464         * doc/gtk_button.txt:
3465         * doc/manpage:
3466         * doc/manpage.man:
3467         * doc/notes.txt: removed out-of date stuff.
3469         * Makefile.am (dist-hook): updated so it doesn't try to remove old
3470         examples subdirectory stuff.
3472 2001-05-19  Damon Chaplin  <damon@ximian.com>
3474         * examples/gnome/*:
3475         * examples/gnomeui/*: removed out-of-date example files.
3477         * examples/configure.in:
3478         * examples/Makefile.am: new example setup mostly copied from GTK+.
3480         * examples/README: describe the example configure.in/Makefile.am.
3482 2001-05-19  Damon Chaplin  <damon@ximian.com>
3484         * gtkdoc-mkdb.in: added --help option and changed output slightly to
3485         make more compatable with XML. Patch from Toshio Kuratomi
3486         <badger@prtr-13.ucsc.edu>
3488 2001-05-19  Damon Chaplin  <damon@ximian.com>
3490         * gtkdoc-mktmpl.in (OutputDeclaration):
3491         * gtkdoc-mkdb.in (OutputFunction): changed a '?' to a '*' so we accept
3492         multi-dimensional array function parameters. Patch from Paolo Casarini
3493         <casarini@CS.UniBO.IT>
3495 2001-05-12  Damon Chaplin  <damon@ximian.com>
3497         * gtkdoc-scangobj.in:
3498         * gtkdoc-scanobj.in: used "*pos = 0" to avoid problems with backslashes
3499         in '\0'.
3501         * configure.in: removed dsssl dirs stuff, since we use public entities
3502         now.
3504         * gtkdoc-mkdb.in (OutputBook): if there is no main SGML file we create
3505         it here. Also added a --main-sgml-file option so we know where to put
3506         it.
3508         * gtkdoc-scan.in: if there is no MODULE-sections.txt file, we copy
3509         the MODULE-decl-list.txt file to it. The user can tweak it later.
3511 2001-05-11  Damon Chaplin  <damon@ximian.com>
3513         * gtk-doc.spec.in: applied patch from Toshio Kuratomi
3514         <badger@prtr-13.ucsc.edu>.
3516 2001-05-07  Joakim Ziegler  <joakim@ximian.com>
3518   * gtkdoc-mkdb.in: Added option --outputallsymbols to create a symbol list
3519     in the module doc dir.
3521   * gtkdoc-mkdb.in: Added functionality to output a list of undocumented
3522     symbols in a module, most of is is in OutputMissingDocumentation.
3524   * gtkdoc-scan.in: Small scanning fixes to facilitate the doc coverage
3525      output mentioned above.
3527 2001-04-25  Federico Mena Quintero  <federico@ximian.com>
3529         * gtkdoc-scanobj.in: Added missing output-dir in the call to
3530         GetOptions().
3532 2001-04-24  Damon Chaplin  <damon@ximian.com>
3534         * gtkdoc-scanobj.in: copied --outputdir option from gtkdoc-scangobj.in.
3536 Fri Apr 13 15:25:44 2001  Owen Taylor  <otaylor@redhat.com>
3538         * gtkdoc-mkdb.in: Restore call to OutputBook that was accidentally
3539         deleted.
3541 Thu Apr 12 17:57:12 2001  Owen Taylor  <otaylor@redhat.com>
3543         * gtkdoc-scangobj.in: Add a --outputdir option (sort of hacky.
3544         Need this because $CC, $LD can include relative paths if they
3545         are based on $LIBTOOL)
3547 2001-03-26  Damon Chaplin  <damon@ximian.com>
3549         * gtkdoc-mkdb.in (ReadSourceDocumentation): scan .h files as well,
3550         so macros can be documented there if desired. Patch from
3551         Yoann Vandoorselaere <yoann@mandrakesoft.com>
3553         * gtkdoc-mkhtml.in (gtkdocdir): use 'test -f' rather than 'test -e'
3554         which is GNU-specific.
3556 Thu Mar  8 17:26:29 2001  Tim Janik  <timj@gtk.org>
3558         * gtkdoc-scangobj.in: fix signal param type handling.
3560 Tue Mar  6 23:21:46 2001  Jonathan Blandford  <jrb@redhat.com>
3562         * gtkdoc-scanobj.in: Add gobject support.  Now works on files that
3563         don't link against GTK.
3565 Sat Mar  3 17:43:42 2001  Owen Taylor  <otaylor@redhat.com>
3567         * gtkdoc-{scan,mktmpl,mkdb}.in: Add support for G_CONST_RETURN.
3568         (Right now, it will appear as G_CONST_RETURN in the output -
3569         I'm not sure that's right - perhaps it should be converted
3570         to const.)
3572 2001-02-20  Michael Meeks  <michael@ximian.com>
3574         * gtkdoc-mktmpl.in: s/TRUE/1/
3576 2001-02-19  Damon Chaplin  <damon@ximian.com>
3578         * gtkdoc-mktmpl.in (UpdateTemplates): fixed bug handling the $changed
3579         flag.
3581 2001-02-17  Damon Chaplin  <damon@ximian.com>
3583         * gtkdoc-scan.in (ScanHeaders):
3584         (ScanHeader): patch from Johannes Stezenbach <js@convergence.de>
3585         so we don't use '\b' in the regexp to match files/dirs to ignore.
3586         '\b' can match '_' so we matched things we shouldn't have.
3588 Mon Feb 12 12:50:57 2001  Owen Taylor  <otaylor@redhat.com>
3590         * configure.in: Up version.
3592 Sun Feb 11 18:35:07 2001  Owen Taylor  <otaylor@redhat.com>
3594         * gtkdoc-mktmpl.in: Add a timestamp file for the
3595         templates like sgml.stamp
3597         * gtkdoc-mktmpl.in (OutputUnusedTemplates): Write the
3598         symbols out in sorted order instead of hash table
3599         order to reduce conflicts.
3601 Mon Feb  5 16:48:51 2001  Owen Taylor  <otaylor@redhat.com>
3603         * configure.in gtk-doc.dsl.in: Remove checks for DSSSL - use a
3604         public entity instead.
3606         * gtkdoc-scangobj.in: Fix to work with libtool better.
3608 2001-01-30  Havoc Pennington  <hp@pobox.com>
3610         * gtkdoc-fixxref.in, gtkdoc-mkdb.in, gtkdoc-mktmpl.in,
3611         gtkdoc-scan.in, gtkdoc-scangobj.in, gtkdoc-scanobj.in:
3612         Added -*- cperl -*- magic, and --deprecated-guards
3613         option.
3615 2001-01-23  Damon Chaplin  <damon@helixcode.com>
3617         * gtkdoc-scangobj.in:
3618         * gtkdoc-scanobj.in:
3619         * gtkdoc-scan.in:
3620         * gtkdoc-mkdb.in:
3621         * gtkdoc-mktmpl.in: changed so that they only update files when
3622         necessary (they write new versions of the files out, then use 'cmp'
3623         to compare with the existing versions to see if they have changed.)
3624         This should make it easier to do proper dependency rules in Makefiles,
3625         and it may cut down on CVS traffic.
3627         * gtkdoc-mkhtml.in: update a timestamp file (html.stamp) after running.
3628         * gtkdoc-mkdb.in: update a timestamp file (sgml.stamp) if any of the
3629         DocBook SGML files have been changed. So hopefully you can now use
3630         rules like this to avoid unnecessary regeneration of the HTML:
3632         all-local:
3633                 $(MAKE) scan
3634                 $(MAKE) templates
3635                 $(MAKE) sgml
3636                 $(MAKE) html.stamp
3638         html.stamp: sgml.stamp $(EXTRA_SGML_FILES)
3639                 $(MAKE) html
3641         (I've tried this with the old GTK+ reference API docs and it seems to
3642         work well.)
3644         * gtkdoc-scangobj.in:
3645         * gtkdoc-scanobj.in:
3646         * gtkdoc-scan.in:
3647         * gtkdoc-mkdb.in:
3648         * gtkdoc-mktmpl.in:
3649         * gtkdoc-mkhtml.in:
3650         * gtkdoc-mkman.in:
3651         * gtkdoc-fixxref.in:
3652         Added '--version' command-line arg to all shell & perl scripts, so
3653         you can check for version 0.5 if you want to use the above rules.
3654         (If 0.4 is used make will probably complain about not knowing how to
3655         to build sgml.stamp.)
3657         * gtkdoc-common.pl.in: new file to contain shared routines.
3658         For now it just contains the UpdateFileIfChanged routine for the above.
3659         We can move the duplicated routines here in future, though the use of
3660         global variables makes this a bit awkward.
3662         * configure.in (PACKAGE_DATA_DIR): calculates the data dir and
3663         substitutes it so that the scripts know where gtkdoc-common.pl
3664         is installed. Also added gtkdoc-common.pl to AC_OUTPUT.
3666         * Makefile.am: added gtkdoc-common.pl to gtkdocdata_DATA.
3668         * gtkdoc-mkhtml.in: deleted the old index.sgml file, since it causes
3669         problems if it is owned by root (e.g. after you run 'make install' as
3670         root. jade prompts you about overwriting it, which is annoying.
3672 2001-01-10  Havoc Pennington  <hp@redhat.com>
3674         * gtkdoc-mktmpl.in: Only move old file to backup if the old file
3675         exists, and have better error messages when doing the backups
3677 Mon Jan  8 14:57:29 2001  Owen Taylor  <otaylor@redhat.com>
3679         * gtkdoc-mktmpl.in: Canonicalize signal and argument
3680         names to -, not _.
3682         * gtkdoc-scangobj.in: Fix up for GParamSpec.
3684 2001-01-04  Fr�d�ric Gobry  <frederic.gobry@smartdata.ch>
3686         * gtkdoc-scan.in: fixed matching of < private_header > directive
3688 2000-12-19  Damon Chaplin  <damon@helixcode.com>
3690         * gtkdoc-scanobj.in:
3691         * gtkdoc-scangobj.in: added default cases to get_type_name().
3693 2000-12-10  Arturo Tena  <arturo@directmail.org>
3695         * gtkdoc-scanobj.in (get_type_name):
3696         * gtkdoc-scangobj.in (get_type_name): fixed syntax error: forgotten
3697         to close a switch statement.
3699 2000-12-10  Damon Chaplin  <damon@helixcode.com>
3701         * gtk-doc.spec.in: added spec.in file from John Gotts
3702         <jgotts@linuxsavvy.com>.
3704         * configure.in (AC_OUTPUT): added spec file.
3706         * Makefile.am: uncommented spec file stuff, now that we have one.
3708         * gtkdoc-scanobj.in (get_type_name):
3709         * gtkdoc-scangobj.in (get_type_name): updated to use the type numbers
3710         rather than the type names, which were changed in GTK+ 1.2. This
3711         should fix a problem where GTK_TYPE_STRING arguments were output as
3712         'GtkString *arg' instead of 'gchar *arg'.
3714         I'm still not sure what to output for the structured types such as
3715         GTK_TYPE_SIGNAL/ARGS/FOREIGN/CALLBACK/C_CALLBACK. Should these be
3716         expanded to several arguments to the signal handler?
3718 2000-11-25  Dan Mueth <d-mueth@uchicago.edu>
3720         * help/manual/C/: created this path
3721     * gtk-doc-manual.sgml: Put part of the outline into SGML.
3722       Chris plans to put rest of outline in here and start
3723       writing.
3724     * fdl-appendix.sgml: The FDL in SGML.  We will probably post
3725       these on the web as a single document (book) so we will
3726       need the FDL to be included as an appendix.
3728 Fri Nov  3 07:21:34 2000  Tim Janik  <timj@gtk.org>
3730         * gtkdoc-mkdb.in:
3731         (ParseStructDeclaration):
3732         (OutputStruct):
3733         * gtkdoc-mktmpl.in:
3734         (ParseStructDeclaration):
3735         support /*<protected>*/ equivalently to /*<private>*/
3737 Fri Nov  3 07:15:58 2000  Tim Janik  <timj@gtk.org>
3739         * gtkdoc-mktmpl.in:
3740         * gtkdoc-mkdb.in:
3741         (ReadTemplateFile): only eat up the first space (if at all
3742         present) after "@param:" to preserve indentation for multiline
3743         parameter descriptions.
3745 2000-10-30  Raja R Harinath  <harinath@cs.umn.edu>
3747         * gtkdoc-mkdb.in (ParseStructDeclaration):
3748         Stop scanning at '}' only when it starts a line.
3749         * gtkdoc-mktmpl.in (ParseStructDeclaration): Likewise.
3751 Mon Oct 30 02:59:54 2000  Tim Janik  <timj@gtk.org>
3753         * gtkdoc-scangobj.in: use g_signal_list_ids().
3755 Sun Oct 29 02:54:51 2000  Owen Taylor  <otaylor@redhat.com>
3757         * gtkdoc-scangobj.in: Sort signal types arrays for
3758         greater stability and less random tmpl file diffs.
3760 Sun Oct 29 01:02:35 2000  Owen Taylor  <otaylor@redhat.com>
3762         * gtkdoc-scangobj.in: Work properly with GSignal
3764 === release 0.4 ===
3766 2000-10-21  Damon Chaplin  <damon@helixcode.com>
3768         * Released 0.4
3770 2000-10-14  Damon Chaplin  <damon@helixcode.com>
3772         * AUTHORS:
3773         * MAINTAINERS: changed my email address.
3775         * Makefile.am (dist-hook): remove the CVS dirs from the dist.
3777         * doc/setting-up.txt: typo.
3779 Fri Oct  6 17:51:50 2000    <otaylor@redhat.com>
3781         * gtkdoc-scan.in gtkdoc-mkdb.in: Allow multiple
3782         --source-dir options.
3784 Thu Sep  7 11:41:12 2000  Owen Taylor  <otaylor@redhat.com>
3786         * gtkdoc-mkdb.in: Ignore all . files when scanning directories.
3788         * gtkdoc-scan.in: Add support for GLIB_VAR, GDKVAR,
3789         etc when looking for variable declarations.
3791         * gtkdoc-scan.in: Recognize GET_CLASS macros.
3793         * gtkdoc-scangobj.in: Support .lo intermediate files
3794         with libtool.
3796 Wed Sep  6 17:57:33 2000  Owen Taylor  <otaylor@redhat.com>
3798         * gtkdoc-scangobj.in: Add gtkdoc-scangobj scanner for
3799         GObject type system.
3801         * gtkdoc-scanobj.in: Allow setting $LD to allow separating
3802         compilation and linking and thus to allow using libtool.
3804         * gtkdoc-fixxref.in (ScanIndices): Allow HTMLDIR
3805         not to be present yet.
3807 Tue Sep  5 23:37:53 2000  Owen Taylor  <otaylor@redhat.com>
3809         * gtkdoc-fixxref.in: Add a --extra-dir option to
3810         allow scanning of additional uninstalled HTML
3811         directories.
3813         * gtkdoc-scan.in (ScanHeaders): Honor subdirectories
3814         appearing in --ignore-headers.
3816         * gtkdoc-mkdb.in: Append -CAPS to all all-caps identifiers
3817         to prevent an infinite expansion of special cases.
3819         * gtkdoc-fixxref.in: Add a --module-dir option to
3820         allow fixing references in an uninstalled tree.
3822         * gtkdoc-mkdb.in gtkdoc-mkhtml.in: Simple handling
3823         for macros with embedded commas in enumeration
3824         declarations.
3826 Mon Aug 28 18:18:53 2000  Owen Taylor  <otaylor@redhat.com>
3828         * configure.in (DSSSL_DIR): Remove check for AM_PATH_GTK
3829         since the dependency is only run-time not install-time,
3830         and to avoid dependency loops.
3832 2000-06-21  Damon Chaplin  <damon@helixcode.com>
3834         * gtkdoc-mkdb.in: fixed <INCLUDES> bug, I think.
3836 Wed Feb  9 11:29:25 2000  Owen Taylor  <otaylor@redhat.com>
3838         * gtkdoc-scan.in: Hack to avoid misidentifying structures
3839         as GtkObjects within Pango.
3841 1999-12-15  Raja R Harinath  <harinath@cs.umn.edu>
3843         * gtk-doc.dsl.in ($generate-chapter-toc$): Add missing close
3844         paranthesis.
3846 1999-11-23  Raja R Harinath  <harinath@cs.umn.edu>
3848         * gtk-doc.dsl.in: Use the (define (foo) ...) syntax rather than
3849         the uglier (define foo (lambda () ...)) syntax.
3850         ($generate-chapter-toc$): Simplify.
3851         ($shade-verbatim-attr$): Simplify.  Use ($table-width$) instead of
3852         "100%" for width (See docs. of NWalsh Docbook DSSSL Stylesheets
3853         for an explanation).
3855 1999-09-20  Damon Chaplin  <damon@karuna.freeserve.co.uk>
3857         * gtk-doc.dsl.in: If a Chapter has role="no-toc" we don't generate a
3858         table of contents. This is useful if a better contents page has been
3859         added manually, e.g. for the GTK+ Widgets & Objects page. (But it is
3860         a bit of a hack.)
3862         * gtkdoc-scanobj.in: added --nogtkinit flag which will make it call
3863         gtk_type_init() rather than gtk_init(). This is useful when it is
3864         run automatically to update the docs by a cron job or similar and a
3865         connection to an X server is not desirable. However, if any widgets
3866         need a connection to X in their class init function then this can't
3867         be used (e.g. GtkFontSelection at present).
3869 Mon Sep 20 09:09:12 1999  Owen Taylor  <otaylor@redhat.com>
3871         * gtkdoc-mkdb.in gtkdoc-mktmpl.in: (ParseStructDeclaration):
3872         Fixed up the code to do /*< private >*/ ... stripping.
3874 1999-09-10  Martin Baulig  <martin@home-of-linux.org>
3876         * gtkdoc.dsl.in ($generate-chapter-toc$): Return #t, not #f.
3878 1999-09-09  Martin Baulig  <martin@home-of-linux.org>
3880         * gtkdoc-scan.in (ScanHeader): Don't force typedefs and other
3881         things to start in column 0; allow some spaces in front of them.
3882         Output `typedef struct { ... } name' structs as typedef, not as
3883         structure.
3885 1999-09-08  Martin Baulig  <martin@home-of-linux.org>
3887         * gtkdoc-mkdb.in (CreateValidSGMLID): `s/::/-/g;' for CORBA objects.
3889 1999-08-22  Erik Walthinsen  <omega@cse.ogi.edu>
3891         * gtkdoc-scan.in: modified so it will find any Class, not just Gtk
3892         and Gnome classes.  Introduces the possibility of extraneous Class
3893         definitions (verified), which should be pruned somehow (haven't
3894         analyzed the false positive yet).
3896 1999-08-22  Damon Chaplin  <damon@karuna.freeserve.co.uk>
3898         * gtkdoc-mktmpl.in:
3899         * gtkdoc-mkdb.in: a few fixes to ParseStructDeclaration. It still
3900         has problems with nested structs/unions like those which occur in
3901         gtkclist.h and gtktypeutils.h.
3903         * configure.in: removed gtk-doc.spec from AC_OUTPUT, as whoever wrote
3904         this forgot to add gtk-doc.spec.in to CVS.
3905         * Makefile.am: commented out gtk-doc.spec.
3907 Wed Aug 18 03:55:30 1999  Owen Taylor  <otaylor@redhat.com>
3909         * gtkdoc-mktmpl.in: Propagate fix from gtkdoc-mkdb.in.
3910         :-(; need to libraryize, need to libraryize.
3912 Wed Aug 18 03:55:30 1999  Owen Taylor  <otaylor@redhat.com>
3914         * gtkdoc-mkdb.in: Fix bug that was preventing
3915         structure field definitions from being output.
3917 Wed Aug 18 23:25:23 1999  Owen Taylor  <otaylor@redhat.com>
3919         * configure.in: Add /usr/lib/sgml/stylesheet to list
3920         of stylesheet directories. (Found in recent Debian
3921         packages)
3923 1999-08-15  Damon Chaplin  <damon@karuna.freeserve.co.uk>
3925         * gtkdoc-mkdb.in: Output $decl_out as the struct rather than the
3926         original $declaration.
3928 1999-08-12  Damon Chaplin  <damon@karuna.freeserve.co.uk>
3930         * gtkdoc-mkdb.in:
3931         * gtkdoc-mktmpl.in: Added special case in ParseEnumDeclaration to
3932         handle GIOCondition which uses strange macros like this:
3933         typedef enum
3934         {
3935           G_IO_IN       GLIB_SYSDEF_POLLIN,
3936           ...
3937         The GLIB_SYSDEF_POLLIN macro expands to something like '=1'
3939 1999-08-05  Damon Chaplin  <damon@karuna.freeserve.co.uk>
3941         * gtk-doc.dsl.in: output <br clear=all> after sections and at end of
3942         page so that right-aligned images aren't messed up quite as much.
3944 Wed Aug  4 04:04:55 1999  Owen Taylor  <otaylor@redhat.com>
3946         * gtkdoc-mk{db,tmpl}.in (ParseStructDeclaration): Allow
3947         for bit fields.
3949         * gtkdoc-mktmpl.in (ReadObjectHierarchy): Remove
3950         call to MakeXref that slipped in accidentally.
3952 Wed Aug  4 03:30:19 1999  Owen Taylor  <otaylor@redhat.com>
3954         * doc/style-guide.txt: Removed references to creating
3955         tables explicitely in favor of demonstrating new
3956         syntax. Added a short section on /<* public >*/
3957         and /*< private *>/.
3959 Wed Aug  4 03:15:19 1999  Owen Taylor  <otaylor@redhat.com>
3961         * gtkdoc-mktmpl.in gtkdoc-mkhtml.in: Handle Struct and
3962         Enumerations in approximately the same way as we
3963         handle parameters. That is, instead of (as before)
3964         coding in the tables by hand, one uses lines like:
3966         @width: the width of the rectangle in pixels.
3968         To support migration from the older hand-coded
3969         tables, if none of the members of a structure or
3970         enumeration have a description in a @... line, then
3971         we don't generate the table at all.
3973         Also, gtkdoc-mktmpl now loads up the object heirarchy,
3974         because we need to be able to check if structures
3975         are widget structures.
3977         In general, the coding here is pretty clean, though
3978         the style is a little different. (I'm interating
3979         through strings with m/.../msg; instead of
3980         s/^...//; for one thing.) However, there are a some
3981         of FIXME's where I've whimped out on try to handle
3982         real C syntax, and the need to split out and librarize
3983         a bunch of duplicated code is greater than ever.
3985 1999-06-06  Damon Chaplin  <damon@karuna.freeserve.co.uk>
3987         * configure.in: updated version to 0.3.
3989         * doc/style-guide.txt: A couple of minor changes.
3991         * gtkdoc-mkdb.in: Get rid of a couple of messages.
3992         Output an empty <para> if an Arg isn't documented, to keep Jade happy.
3994 1999-05-22  Damon Chaplin  <damon@karuna.freeserve.co.uk>
3996         * gtk-doc.dsl.in: Renamed %shade-verbatim-attr-2% to
3997         $shade-verbatim-attr$ and removed our redefinition of
3998         $verbatim-display$ since the stylesheets version now calls
3999         $shade-verbatim-attr$ as a function which is just what we wanted.
4001         * README: Updated info on stylesheet versions supported - 1.40 is
4002         known to be OK (with this version of gtk-doc), 1.19+ may work.
4004 1999-03-31  Damon Chaplin  <damon@karuna.freeserve.co.uk>
4006         * configure.in: update version to 0.2 for next release.
4008         * gtkdoc-mktmpl.in:
4009         * gtkdoc-mkdb.in: added support for 'See Also' section.
4011         * gtk-doc.dsl.in: changed green background color slightly, and
4012         set background color for enum tables.
4014 1999-03-21  Damon Chaplin  <damon@karuna.freeserve.co.uk>
4016         * gtkdoc-mkhtml.in (gtkdocdir): use '-w no-idref' to suppress all the
4017         warnings about references to non-existent IDs.
4019 1999-03-18  Damon Chaplin  <damon@karuna.freeserve.co.uk>
4021         * gtkdoc-mkdb.in (OutputParamDescriptions): use role="params" for the
4022         table so we can adjust the stylesheet code.
4023         (OutputSGMLFile): Don't output 'one line description goes here'.
4024         (ExpandAbbreviations): allow '-' in #symbol abbreviations, so we can
4025         use #GtkWidget-struct.
4026         (MakeXRef): get rid of special '-struct' suffix, for #GtkWidget-struct.
4028         * gtk-doc.dsl.in: use the "role" attribute on tables to set the
4029         BGCOLOR.
4031         * gtkdoc-scan.in (ScanHeader): fix for scanning functions declared
4032         over multiple lines - was catching things which weren't functions.
4034 1999-03-11  Damon Chaplin  <damon@karuna.freeserve.co.uk>
4036         * examples/gnomeui/Makefile.am (clean-local):
4037         * examples/gnome/Makefile.am (clean-local): added *.args
4039         * gtkdoc-mkdb.in: added support for Args and variables. Also a few
4040         minor changes in the output, e.g. don't show macros > 2 lines long.
4042         * gtkdoc-mktmpl.in:
4043         * gtkdoc-scanobj.in: added support for Args.
4045         * gtkdoc-scan.in: added support for extern'ed variables. Also
4046         accept 'extern' before function declarations.
4048         * gtk-doc.dsl.in: made output prettier. Changed the navigation bars
4049         and the colours used for the various backgrounds.
4051         * doc/style-guide.txt: new file containinf a style guide for writing
4052         the GTK+ documentation.
4054         * doc/README: added description of style-guide.txt
4056         * doc/setting-up.txt: fixed a typo
4058         * README: added a bit about Args.
4060 1999-02-07  Damon Chaplin  <damon@karuna.freeserve.co.uk>
4062         * Makefile.am: Removed all the scripts from EXTRA_DIST, as they are
4063         now generated from the .in files which automatically go in the dist.
4065 1999-02-02  Damon Chaplin  <damon@karuna.freeserve.co.uk>
4067         * doc/setting-up.txt (scan): removed text which incorrectly said that
4068         changing section titles means you have to recreate the main SGML file.
4070 1999-02-03  Sebastian Wilhelmi  <wilhelmi@ira.uka.de>
4072         * configure.in: find perl in $PATH, generate the perl programs
4073         from their *.in counterparts.
4075         * gtkdoc-fixxref, gtkdoc-mkdb, gtkdoc-mktmpl, gtkdoc-scan,
4076         gtkdoc-scanobj: Renamed to *.in and changed /usr/bin/perl to
4077         @PERL@, as determined by configure.
4079         * .cvsignore: Added diverse config* stuff and the new generated
4080         perl programs.
4082 1999-01-28  Damon Chaplin  <damon@karuna.freeserve.co.uk>
4084         * gtk-doc.dsl.in: I forgot to make the new refentry code process the
4085         child elements, so it was only outputting anchors for each page.
4087         * doc/setting-up.txt (scan): added step to create MODULE.types file
4088         for modules which contain widgets (or objects).
4090         * gtkdoc-mkdb (OutputStruct): allow spaces inside the public/private
4091         markers, e.g. "/*  <  public  >  */"
4093 1999-01-27  Damon Chaplin  <damon@karuna.freeserve.co.uk>
4095         * Makefile.am: added scripts to EXTRA_DIST and copied examples, doc
4096         and db2man dirs in dist-hook.
4098         * doc/sections-file.txt: added a couple of examples.
4100         * doc/setting-up.txt: new document describing how to set up a module
4101         to use gtk-doc.
4103         * doc/README: added description of setting-up.txt
4105         * README: added short 'Installation' section describing the
4106         --with-dsssl-dir option.
4108         * gtk-doc.dsl.in: also output links to each RefEntry page in the
4109         index.sgml file, so libgnomeui docs can link to widgets. (The widget
4110         hierarchy links were not working before.)
4112 1999-01-26  Damon Chaplin  <damon@karuna.freeserve.co.uk>
4114         * gtkdoc-scan (ScanHeader): parse function declarations that have the
4115         return type and name on one line, and the '(' and args on the next.
4116         NOTE: functions with the start of the declaration split over 3 lines
4117         will not be parsed (e.g. return type on one line, function name on
4118         next, and '(' and first argument on the third.) I hope there aren't
4119         any.
4121         * gtkdoc-mkdb (OutputStruct): Use a different SGML ID for widget
4122         structs, since the original ID is used for the entire RefEntry.
4123         Also only show parts of widget structs which are marked with a
4124         comment '/*<public>*/'. Use '/*<private>*/' for private fields.
4126         * gtkdoc-mktmpl (UpdateTemplates): We include widget structs now,
4127         so we do want warnings if they aren't used.
4129         * examples/gnomeui/gnomeui-docs.sgml:
4130         * examples/gnomeui/gnomeui-sections.txt:
4131         * examples/gnomeui/gnomeui.types:
4132         * examples/gnome/gnome-docs.sgml:
4133         * examples/gnome/gnome-sections.txt: sync with latest source.
4135         * examples/configure.in: Add --with-gnome-libs-dir option, so it can
4136         be configured easily.
4137         * examples/gnomeui/Makefile.am (DOC_SOURCE_DIR):
4138         * examples/gnome/Makefile.am (DOC_SOURCE_DIR): use the new
4139         GNOME_LIBS_DIR.
4141         * gtkdoc-mkdb (MergeSourceDocumentation): accept parameters names in
4142         the source which use the wrong case, since there are quite a few of
4143         these in Gnome.
4145 1999-01-25  Damon Chaplin  <damon@karuna.freeserve.co.uk>
4147         * gtkdoc-mktmpl: parse G_GNUC_EXTENSION before typedef'ed types.
4149         * gtkdoc-mkdb: added support for specifying include files in the
4150         MODULE-sections.txt file, to be output at the top of the synopsis.
4152         * doc/sections-file.txt: added description of <INCLUDE> tag.
4154         * examples/gnomeui/gnomeui-sections.txt:
4155         * examples/gnome/gnome-sections.txt: added use of <INCLUDE>
4157         * examples/configure.in: changed 'gtk-reference' to
4158         'gnome-libs-reference'.
4160 1999-01-18  Damon Chaplin  <damon@karuna.freeserve.co.uk>
4162         * README: updated my email address & noted that version 1.15+ of the
4163         DocBook modular stylesheets is needed (for $table-width$).
4165         * AUTHORS: updated my email address.
4167 1998-12-20  Jeff Garzik  <jgarzik@pobox.com>
4169         * examples/gnomeui/gnomeui-docs.sgml,
4170           examples/gnomeui/gnomeui-sections.txt,
4171           examples/gnomeui/gnomeui.types:
4172         s/gtkspell/gnome-spell/g
4174 1998-12-16  Damon Chaplin  <DAChaplin@msn.com>
4176         * gtkdoc-mkdb (ExpandAbbreviations): Allow -ve contants, e.g. %-1.
4177         (ScanSourceFile): Try to handle function descriptions that start
4178         with 'Returns'. It was assuming that they were describing the return
4179         value before.
4180         Gets rid of 'Description:' which is sometimes included
4181         at the start of the function description in the source comment blocks.
4182         Makes sure newlines are preserved in the description, as consecutive
4183         newlines are converted to paragraph separators later.
4185 1998-12-15  Damon Chaplin  <DAChaplin@msn.com>
4186         * Major changes to the scripts to merge in comments within source code
4187         * gtk-doc-fixxref added
4188         * examples directory added with an example for setting up modules to
4189         use gtk-doc
4190         * documentation updated
4193 1998-11-28  Damon Chaplin  <DAChaplin@msn.com>
4195         * gtkdoc-scanobj:
4196         * gtkdoc-scan:
4197         * gtkdoc-mktmpl:
4198         * gtkdoc-mkdb: Major changes to make it easy to update the docs
4199         when the API changes. It's pretty much all automatic now.
4200         Also added licenses and function comments, and added 'use strict'.
4201         The Gnome widgets should now be visible in the hierarchy.
4202         Removed a few 'mkdir's which I don't think are necessary now.
4204 Tue Nov 24 16:32:23 1998  Owen Taylor  <otaylor@redhat.com>
4206         * README doc/authors.txt: Updated to describe the
4207         new generic scripts instead of the old ones hard-coded
4208         for GLIB and GTK+.
4210 Tue Nov 24 01:06:17 1998  Owen Taylor  <otaylor@redhat.com>
4212         * .cvsignore: Added .cvsignore
4214 Tue Nov 24 01:03:47 1998  Owen Taylor  <otaylor@redhat.com>
4216         * autogen.sh configure.in: Minor touchups so the newly
4217         imported stuff autogen's correctly.