Starting point for generating single page html. Needs refactoring with
[gtk-doc.git] / ChangeLog
bloba5dd1d0482c682dbdb24eb68f4b830fd377d1b89
1 2009-02-23  Stefan Kost  <ensonic@users.sf.net>
3         * gtk-doc-single.xsl:
4           Starting point for generating single page html. Needs refactoring with
5           gtk-doc.xsl (common stuff into gtk-doc-html.xsl).
7 2009-02-23  Stefan Kost  <ensonic@users.sf.net>
9         * TODO:
10           With fop-0.94 it works actually, while 0.95 seesm to have the
11           exceptions.
13         * gtkdoc-mkpdf.in:
14           Fix var reference.
16 2009-02-22  Stefan Kost  <ensonic@users.sf.net>
18         * TODO:
19         * gtkdoc-mkdb.in:
20           Prototype an idea.
22 2009-02-22  Stefan Kost  <ensonic@users.sf.net>
24         * Makefile.am:
25           Dist more files.
27         * configure.in:
28           Update status.
30         * gtkdoc-mkpdf.in:
31           Remove some crack left from copy'n'paste.
33 2009-02-22  Stefan Kost  <ensonic@users.sf.net>
35         * TODO:
36           Planning.
38         * configure.in:
39         * gtk-doc.m4:
40         * gtk-doc.make:
41         * gtk-doc.notmpl.make:
42         * gtkdoc-mkpdf.in:
43         * tests/gtk-doc.make:
44         * tests/gtk-doc.notmpl.make:
45         * gtkdoc-mkpdf.in (added):
46           Clean up Makefile rules (be less verbose). Added options to configure to
47           allow selecting the desired output formats. Added initial pdf support (very
48           imature yet, due to several shortcommings of fop - bugs files).
50 2009-02-21  Stefan Kost  <ensonic@users.sf.net>
52         * TODO:
53           Planning.
55         * gtkdoc-mkdb.in:
56           Update annotations and fix matching to support parameters.
58         * tests/annotations/docs/tester-sections.txt:
59         * tests/annotations/src/tester.c:
60         * tests/annotations/src/tester.h:
61           Update annotation example and add one more.
63 2009-02-21  Stefan Kost  <ensonic@users.sf.net>
65         * gtkdoc-mkdb.in:
66         * help/manual/C/gtk-doc-manual.xml:
67         * tests/gobject/src/gobject.c:
68           Allow linking to struct members. Update docs. Fixes #565126.
70 2009-02-21  Stefan Kost  <ensonic@users.sf.net>
72         * configure.in:
73         * gtkdoc-fixxref.in:
74           Fix params and running of 'highlight'.
76 2009-02-21  Stefan Kost  <ensonic@users.sf.net>
78         * gtkdoc-mkdb.in:
79           Require the line to ends after the double-colon (sans whitespace),
81 2009-02-20  Stefan Kost  <ensonic@users.sf.net>
83         patch by: Damien Lespiau <damien.lespiau@gmail.com>
85         * gtk-doc.make:
86         * gtk-doc.notmpl.make:
87         * tests/gtk-doc.make:
88         * tests/gtk-doc.notmpl.make:
89           Add --tag=CC to libtool invocations. Fixes #572396.
91 2009-02-18  Stefan Kost  <ensonic@users.sf.net>
93         * examples/Makefile.am:
94           Fix example to show to to make it work even with make distcheck.
96 2009-02-16  Stefan Kost  <ensonic@users.sf.net>
98         * style.css:
99         * tests/gobject/src/gobject.c:
100           Also style <note> tags.
102 2009-02-10  Stefan Kost  <ensonic@users.sf.net>
104         * MAINTAINERS:
105           Fix the spelling of my name.
107 2009-02-05  Stefan Kost  <ensonic@users.sf.net>
109         * TODO:
110           Some planning.
112         * gtkdoc-mkdb.in:
113           Single tabs are rendered inconsistently in browsers. Replace them with
114           a &nbsp;.
116 2009-01-31  Stefan Kost  <ensonic@users.sf.net>
118         * tests/gobject/src/gobject.c:
119           Try to link to struct members as a test for Bug #565126.
121 2009-01-30  Stefan Kost  <ensonic@users.sf.net>
123         * gtkdoc-mkdb.in:
124           Expanding urls is not a good idea yet. Need to figure out.
126 2009-01-29  Stefan Kost  <ensonic@users.sf.net>
128         * tests/tools.sh:
129           Remove, this is generated.
131 2009-01-29  Stefan Kost  <ensonic@users.sf.net>
133         * gtkdoc-mkdb.in:
134           Automatically creating ulinks for urls.
136         * tests/gobject/src/gobject.c:
137           Add a link for testing.
139 2009-01-28  Stefan Kost  <ensonic@users.sf.net>
141         * style-classic.css:
142         * style.css:
143         * tests/gobject/docs/tester-docs.xml:
144         * tests/gobject/src/gobject.c:
145           Major CSS cleanup. This is hopefully an end of layout issues related
146           to the fixed navigation bar.
148 2009-01-28  Stefan Kost  <ensonic@users.sf.net>
150         patch by: David Nečas <yeti@physics.muni.cz>
152         * gtkdoc-mkdb.in:
153         * tests/gobject/src/giface.c:
154         * tests/gobject/src/gobject.c:
155           Abbreviation where not expanded at the start of text. Fixes #569339.
157 2009-01-28  Stefan Kost  <ensonic@users.sf.net>
159         * gtkdoc-fixxref.in:
160         * tests/gobject/examples/gobject.c:
161           Expand urls in comments of examples.
163 2009-01-27  Stefan Kost  <ensonic@users.sf.net>
165         * gtkdoc-fixxref.in:
166         * style.css:
167           Use tables like described in #536928.
169         * tests/tools.sh
170           Comment on why we do the tool check like this.
171   
172         * tests/fail.sh:
173           Comment on test.
175         * tests/gobject/docs/tester-docs.xml:
176           Fix xml a bit.
178 2009-01-26  Stefan Kost  <ensonic@users.sf.net>
180         * gtkdoc-mkdb.in:
181         * tests/bugs/src/tester.h:
182         * tests/fail.sh:
183         * tests/fail/docs/tester-docs.xml:
184         * tests/fail/docs/tester-sections.txt:
185         * tests/fail/src/tester.c:
186           Add public symbols from section file when doing the -undocumented.txt
187           report. Also add the special symbols for the section docs when reading
188           the section-file. Extend test suite to check for it. Fixes #568732
190 2009-01-26  Stefan Kost  <ensonic@users.sf.net>
192         * gtkdoc-scan.in:
193         * tests/bugs/docs/tester-sections.txt:
194         * tests/bugs/src/tester.c:
195         * tests/bugs/src/tester.h:
196           Handle inline functions in headers. Fixes #532395.
198 2009-01-26  Stefan Kost  <ensonic@users.sf.net>
200         * HACKING:
201           Mention onine site for regexp testing.
203         * gtkdoc-mkdb.in:
204           Small output cleanups.
206         * gtkdoc-mktmpl.in:
207           Indenting and use LogWarning once more.
209 2009-01-23  Stefan Kost  <ensonic@users.sf.net>
211         * gtkdoc-mkdb.in:
212           Recomment out debug log the accidentialy went in.
214         * configure.in:
215         * tests/Makefile.am:
216         * tests/fail.sh:
217         * tests/tools.sh.in:
218         * tests/tools.sh.in (added):
219           Add a check that tests that all scripts are runnable.
221 2009-01-23  Stefan Kost  <ensonic@users.sf.net>
223         * gtkdoc-check.in:
224           No need to format a '\n' into a formatstring.
226         * gtkdoc-mkdb.in:
227           Add FIXMEs for Bug 568711.
229         * gtkdoc-mkhtml.in:
230           Add a comment.
232         * configure.in:
233         * tests/Makefile.am:
234         * tests/fail.sh:
235         * tests/fail/Makefile.am:
236         * tests/fail/docs/Makefile.am:
237         * tests/fail/docs/tester-docs.xml:
238         * tests/fail/docs/tester-sections.txt:
239         * tests/fail/src/Makefile.am:
240         * tests/fail/src/tester.c:
241         * tests/fail/src/tester.h:
242           Add a test suite for failure checks.
244 2009-01-23  Stefan Kost  <ensonic@users.sf.net>
246         patch by: David Nečas <yeti@physics.muni.cz>
248         * gtkdoc-scan.in:
249           Don't scan files twice. The patch was slightly changed to name the
250           hash lowercase (uppercase is used for configureation options) and
251           add a comment. Fixes #568708.
253 2009-01-23  Stefan Kost  <ensonic@users.sf.net>
255         patch by: David Nečas <yeti@physics.muni.cz>
257         * gtkdoc-mkdb.in:
258           Don't add empty <para></para> tags to the docs to avoid breaking the
259           detection of undocumented things. Fixes #568732.
261 2009-01-23  Stefan Kost  <ensonic@users.sf.net>
263         patch by: David Nečas <yeti@physics.muni.cz>
265         * gtk-doc.m4:
266           Change nonsense error message to tell that gtk-doc is needed to build
267           a given package and not gtk-doc. Fixes #568734.
269 2009-01-23  Stefan Kost  <ensonic@users.sf.net>
271         * gtkdoc-mkdb.in:
272         * gtkdoc-scan.in:
273           Treat iface/interface like class in other places too.
275 2009-01-23  Stefan Kost  <ensonic@users.sf.net>
277         patch by: David Nečas <yeti@physics.muni.cz>
279         * gtkdoc-scan.in:
280           Use CamelCase id for interfaces. Fixes #568706.
282 2009-01-23  Stefan Kost  <ensonic@users.sf.net>
284         patch by: David Nečas <yeti@physics.muni.cz>
286         * gtkdoc-mkhtml.in:
287         * gtkdoc-mkman.in:
288         * tests/gtk-doc.make:
289         * tests/gtk-doc.notmpl.make:
290           Less quirky way of knowing that we run uninstalled, which is only
291           needed for the tests anyway. In addition to the patch, make same
292           changes in mkman, add a shift to arg parsing to not loop and change
293           the makefiles for the tests. Fixes #568702.
295 2009-01-22  Stefan Kost  <ensonic@users.sf.net>
297         * gtkdoc-fixxref.in:
298           Only run the syntax highligher if we have one. Fixes #568714.
300 2009-01-22  Stefan Kost  <ensonic@users.sf.net>
302         * README:
303           Point to the right docs.
305         * TODO:
306           More tinking.
308         * style.css:
309           Remove one commented out item.
311 2009-01-21  Stefan Kost  <ensonic@users.sf.net>
313         * TODO:
314         * configure.in:
315         * gtkdoc-fixxref.in:
316         * style.css:
317           Match css of highlight with source-highlight. Handle line numbering by
318           our-selfs. Still stupid browsers copy '#' chars for each line number.
320 2009-01-21  Stefan Kost  <ensonic@users.sf.net>
322         * gtkdoc-fixxref.in:
323           Try to xref first word in 'normal' span.
325 2009-01-20  Stefan Kost  <ensonic@users.sf.net>
327         * TODO:
328         * gtkdoc-mkdb.in:
329         * tests/gobject/src/gobject.c:
330           We could add the language as a comment, it is not shown in the final output.
332 2009-01-20  Stefan Kost  <ensonic@users.sf.net>
334         * TODO:
335           More ideas.
337         * gtkdoc-fixxref.in:
338           Really fix double extension of entities.
340         * style.css:
341           Fix link color of xrefs symbols.
343 2009-01-20  Stefan Kost  <ensonic@users.sf.net>
345         * gtkdoc-fixxref.in:
346           Indent.
348         * gtkdoc-mkdb.in:
349           Fix end of string handling.
351         * style.css:
352           Use one tango colors one more time.
354 2009-01-20  Stefan Kost  <ensonic@users.sf.net>
356         * gtkdoc-mkdb.in:
357         * tests/annotations/docs/Makefile.am:
358         * tests/bugs/docs/Makefile.am:
359         * tests/bugs/docs/tester-docs.xml:
360         * tests/gobject/docs-tmpl/Makefile.am:
361         * tests/gobject/docs/Makefile.am:
362           Detect namespace prefix if not given.
364 2009-01-20  Stefan Kost  <ensonic@users.sf.net>
366         * style-classic.css:
367         * style.css:
368           Fix gap, caused by double index divs produces by index generated with
369           the docbook stylesheets.
371 2009-01-20  Stefan Kost  <ensonic@users.sf.net>
373         * TODO:
374           More ideas.
376         * gtk-doc.xsl:
377           Make sure indexdiv and glossarydiv elements have anchors.
379         * style-classic.css:
380         * style.css:
381           Fix spacing for navbar in index/glossary pages.
383         * tests/annotations/docs/tester-docs.xml:
384         * tests/gobject/docs/tester-docs.xml:
385           Cleanup samples.
387 2009-01-19  Stefan Kost  <ensonic@users.sf.net>
389         * TODO:
390           More ideas.
392         * gtk-doc.xsl:
393           Experiment with navigation for index and glossaries.
395         * gtkdoc-fixxref.in:
396         * gtkdoc-mkdb.in:
397           Fix index entries and copy doc along with the method.
399         * style.css:
400           also do the extra spacing for the index/glossary environments now.
402         * tests/gobject/docs/tester-docs.xml:
403           Experiment with a more complete doc structure.
405 2009-01-12  Stefan Kost  <ensonic@users.sf.net>
407         * gtkdoc-fixxref.in:
408           Make highligher post processing conditional.
410 2009-01-10  Stefan Kost  <ensonic@users.sf.net>
412         * configure.in:
413           Erm, not having a highlighter is not fatal.
415 2009-01-10  Stefan Kost  <ensonic@users.sf.net>
417         * HACKING:
418         * TODO:
419         * configure.in:
420         * gtkdoc-fixxref.in:
421           Look for source-highlight and highlight. Not perfect yet, highlight uses
422           different classes in the css :/.
424         * tests/gobject/docs/tester-docs.xml:
425           More header data in the examples.
427 2009-01-09  Stefan Kost  <ensonic@users.sf.net>
429         patch by: David Nečas <yeti@physics.muni.cz>
431         * gtkdoc-scan.in:
432           Treat FOO_GET_INTERFACE as standard. Fixes #567132.
434 2009-01-09  Stefan Kost  <ensonic@users.sf.net>
436         * TODO:
437         * gtk-doc.make:
438         * gtk-doc.notmpl.make:
439         * gtkdoc-fixxref.in:
440         * gtkdoc-mkdb.in:
441         * style.css:
442         * tests/gobject/examples/gobject.c:
443         * tests/gtk-doc.make:
444         * tests/gtk-doc.notmpl.make:
445           Initial go at implementing syntax highlighting for sources using
446           gnu source-highlight. Needs testing and modularisation.
448 2009-01-08  Stefan Kost  <ensonic@users.sf.net>
450         * gtkdoc-mkhtml.in:
451           Comment out echo for debugging.
453 2009-01-08  Stefan Kost  <ensonic@users.sf.net>
455         * gtk-doc.make:
456         * gtkdoc-mkhtml.in:
457         * tests/gobject/docs-tmpl/Makefile.am:
458         * tests/gobject/docs/Makefile.am:
459         * tests/gtk-doc.make:
460         * tests/gtk-doc.notmpl.make:
461           Finally, make distcheck works.
463 2009-01-08  Stefan Kost  <ensonic@users.sf.net>
465         * gtkdoc-check.in:
466         * gtkdoc-depscan.in:
467         * gtkdoc-fixxref.in:
468         * gtkdoc-mkdb.in:
469         * gtkdoc-mkhtml.in:
470         * gtkdoc-mkman.in:
471         * gtkdoc-mktmpl.in:
472         * gtkdoc-rebase.in:
473         * gtkdoc-scan.in:
474         * gtkdoc-scangobj.in:
475         * gtkdoc-scanobj.in:
476         * gtkdocize.in:
477           Add support for --help and --version to remaining tools. Also show a
478           short info on --help and format more consistently. Fixes #566911
480 2009-01-07  Stefan Kost  <ensonic@users.sf.net>
482         * gtk-doc.m4:
483         * gtk-doc.make:
484         * gtk-doc.notmpl.make:
485           Detect gtkdoc-rebase in gtk-doc.m4. Based on idea of Sven Herzberg.
486           Fixes #562310
488 2009-01-07  Stefan Kost  <ensonic@users.sf.net>
490         * NEWS:
491           Prepare for 1.12.
492           
493         * TODO:
494           More thinking about the documentation structure.
495           
496         * configure.in:
497           Add automake support for more distcheck. Use a real sourcefile for the
498           srcdir (something that we wont remove one day).
499           
500         * tests/annotations/docs/Makefile.am:
501         * tests/annotations/src/Makefile.am:
502         * tests/bugs/docs/Makefile.am:
503         * tests/bugs/src/Makefile.am:
504         * tests/gobject/docs-tmpl/Makefile.am:
505         * tests/gobject/docs/Makefile.am:
506         * tests/gobject/src/Makefile.am:
507           Add missing file to fix make distcheck. Use srcdir and not builddir to
508           locate includes.
510 2009-01-07  Stefan Kost  <ensonic@users.sf.net>
512         * TODO:
513           Ideas about syntax highlighing.
515         * style-classic.css:
516           Old color scheme.
518         * style.css:
519           Use tango colors. Simplify css.
521         * tests/gobject/src/gobject.c:
522           Tell what language this is.
524 2009-01-04  Stefan Kost  <ensonic@users.sf.net>
526         * tests/bugs/src/tester.c:
527           Fix inconsistency of prototype and docs.
529 2009-01-04  Stefan Kost  <ensonic@users.sf.net>
531         * tests/gtk-doc.make:
532         * tests/gtk-doc.notmpl.make:
533           Now all tests pass.
535 2009-01-04  Stefan Kost  <ensonic@users.sf.net>
537         * gtkdoc-mkhtml.in:
538         * tests/Makefile.am:
539         * tests/gtk-doc.make:
540         * tests/gtk-doc.notmpl.make:
541         * tests/gtkdoctest.sh:
542           Fix running tests, if no gtk-doc is installed yet.
544 2008-12-29  Stefan Kost  <ensonic@users.sf.net>
546         patch by: Bruce van der Kooij  <brucevdkooij@gmail.com>
548         * help/manual/C/gtk-doc-manual.xml:
549           Fixed three spelling errors (recommanded, conatins, alibrary).
550           Fixes #565835.
552 2008-12-29  Stefan Kost  <ensonic@users.sf.net>
554         * TODO:
555           Documentation structure ideas.
557 2008-12-05  Stefan Kost  <ensonic@users.sf.net>
559         * style.css:
560           Hightlight deprecation warnings.
562 2008-12-04  Stefan Kost  <ensonic@users.sf.net>
564         * gtkdoc-mkdb.in:
565           Fix escaping.
567 2008-12-02  Stefan Kost  <ensonic@users.sf.net>
569         * TODO:
570           Planning.
572         * gtk-doc.make:
573         * gtk-doc.notmpl.make:
574           Remove the sh -c here now that its back in scanobj.
576         * tests/annotations/docs/tester-docs.xml:
577         * tests/bugs/docs/tester-docs.xml:
578         * tests/gobject/docs-tmpl/tester-docs.xml:
579         * tests/gobject/docs/tester-docs.xml:
580           Cosmetic template update.
582 2008-12-02  Stefan Kost  <ensonic@users.sf.net>
584         * gtkdoc-mkdb.in:
585           Don't touch doctype header in expand-content-files.
587 2008-12-01  Stefan Kost  <ensonic@users.sf.net>
589         * gtkdoc-mkdb.in:
590           Add deprecation warnings for signals and properties. Also reuse code
591           for since and stability levels there. Fixes #562655.
593         * tests/gobject/src/gobject.c:
594           Add testcase for #562655.
596 2008-12-01  Stefan Kost  <ensonic@users.sf.net>
598         * gtkdoc-scangobj.in:
599         * gtkdoc-scanobj.in:
600           Reintroduce "sh -c" and comment why its used. Add real libtool support
601           to old scanobj tool as well.
603 2008-12-01  Stefan Kost  <ensonic@users.sf.net>
605         patch by: Matthias Clasen  <mclasen@redhat.com>
607         * gtkdoc-mkdb.in:
608           Fix index-id generation for child and style properties. Fixes #562064.
610 2008-11-16  Stefan Kost  <ensonic@users.sf.net>
612         * HACKING:
613         * configure.in:
614         * help/manual/C/gtk-doc-manual.xml:
615           Back to development.
616           
617 ===  Release 1.11 ===
619 2008-11-16  Stefan Kost  <ensonic@users.sf.net>
621         * HACKING:
622         * NEWS:
623           Releasing 1.11.
625         * tests/Makefile.am:
626         * tests/gtk-doc.make:
627         * tests/gtk-doc.notmpl.make:
628         * tests/gtkdoctest.sh:
629           Fix make distcheck.
631 2008-11-06  Stefan Kost  <ensonic@users.sf.net>
633         * tests/gtk-doc.make:
634         * tests/gtk-doc.notmpl.make:
635           No install rules for test.
637 2008-11-06  Stefan Kost  <ensonic@users.sf.net>
639         * gtkdoc-mkdb.in:
640           Get rid of german variable name. Generate glossary xml for 
641           annotations. Improve initial master document.
643         * tests/annotations/docs/tester-docs.xml:
644           Update example to include anotation glossary.
646 2008-11-05  Stefan Kost  <ensonic@users.sf.net>
648         patch by: Peter Kjellerstedt <pkj@axis.com>
650         * gtk-doc.make:
651         * gtk-doc.notmpl.make:
652         * tests/gtk-doc.make:
653         * tests/gtk-doc.notmpl.make:
654           Correct check for existance of gtkdoc-rebase (better fix than the
655           previous one #508897). Fixes #559281.
657 2008-10-27  Stefan Kost  <ensonic@users.sf.net>
659         patch by: Christian Persch <chpe@gnome.org>
661         * gtkdoc-scangobj.in:
662           Fix doc build when using GTK_DISABLE_SINGLE_INCLUDES. Fixes #558082.
664 2008-10-20  Stefan Kost  <ensonic@users.sf.net>
666         * TODO:
667         * devhelp2.xsd:
668           More docs and planning.
670 2008-10-20  Stefan Kost  <ensonic@users.sf.net>
672         * tests/annotations/docs/tester-docs.xml:
673         * tests/annotations/src/tester.c:
674         * tests/gobject/docs/tester-docs.xml:
675           Update annotations. Glossary enhancements.
677 2008-10-19  Stefan Kost  <ensonic@users.sf.net>
679         * devhelp2.xsd:
680           Update and document format.
682 2008-10-17  Stefan Kost  <ensonic@users.sf.net>
684         * devhelp2.xsd:
685         * devhelp2.xsl:
686           Add new language attribute and use "c" here.
688 2008-10-16  Stefan Kost  <ensonic@users.sf.net>
690         * TODO:
691         * gtkdoc-mktmpl.in:
692           Small comment cleanup and loud thinking in TODO :)
694 2008-10-15  Stefan Kost  <ensonic@users.sf.net>
696         patch by: Jeffrey Stedfast <fejj@novell.com>
698         * examples/Makefile.am:
699         * gtk-doc.make:
700         * gtk-doc.notmpl.make:
701            Allow versioned TARGET_DIR. Fixes #554718.
703 2008-10-13  Stefan Kost  <ensonic@users.sf.net>
705         * TODO:
706           planning.
708         * doc/gtkdoc.dot:
709           Document workflow
710         * devhelp2.xsl:
711           Add support for enums/flags in devhelp index.
713         * gtkdoc-mkdb.in:
714           Support annotations. Fix missing roles.
716         * tests/annotations/docs/tester-docs.xml:
717         * tests/annotations/src/tester.c:
718         * tests/annotations/src/tester.h:
719         * tests/bugs/docs/tester-sections.txt:
720         * tests/gobject/docs/tester-docs.xml:
721           Update new syntax.
723 2008-10-11  Stefan Kost  <ensonic@users.sf.net>
725         * configure.in:
726         * tests/Makefile.am:
727         * tests/annotations.sh:
728         * tests/annotations/Makefile.am:
729         * tests/annotations/docs/Makefile.am:
730         * tests/annotations/docs/tester-docs.xml:
731         * tests/annotations/docs/tester-sections.txt:
732         * tests/annotations/src/Makefile.am:
733         * tests/annotations/src/tester.c:
734         * tests/annotations/src/tester.h:
735           Add testcases for gir annotation.
737 2008-10-03  Stefan Kost  <ensonic@users.sf.net>
739         patch by: Matthew Barnes <mbarnes@redhat.com>
741         * gtkdoc-scan.in:
742         * tests/bugs/docs/tester-sections.txt:
743         * tests/bugs/src/tester.h:
744           Be more careful with "struct _<struct_name>". Fixes #554833.
746 2008-10-03  Stefan Kost  <ensonic@users.sf.net>
748         patch by: Behdad Esfahbod <behdad@gnome.org>
750         * gtk-doc.make:
751         * gtk-doc.notmpl.make:
752         * tests/gtk-doc.make:
753         * tests/gtk-doc.notmpl.make:
754           Add rules to create $(REPORT_FILES). Fixes #552822.
756 2008-10-03  Stefan Kost  <ensonic@users.sf.net>
758         patch by: Simon Josefsson <simon@josefsson.org>
760         * examples/Makefile.am:
761         * tests/bugs/docs/Makefile.am:
762         * tests/gobject/docs-tmpl/Makefile.am:
763         * tests/gobject/docs/Makefile.am:
764           Use GTKDOC_CFLAGS instead of INCLUDES in Makefile.am. Fixes #553407.
766 2008-09-24  Stefan Kost  <ensonic@users.sf.net>
768         * gtkdoc-mkdb.in:
769           Use full symbol, if it does not belong to the namespace.
771 2008-09-22  Stefan Kost  <ensonic@users.sf.net>
773         * tests/gobject/src/gobject.h:
774           Document some odd behaviour.
776 2008-09-22  Stefan Kost  <ensonic@users.sf.net>
778         * TODO:
779           More todos.
781         * tests/bugs/docs/tester-sections.txt:
782         * tests/bugs/src/tester.c:
783         * tests/bugs/src/tester.h:
784           Add testcase for bug 552602.
786         * tests/gtk-doc.make:
787         * tests/gtk-doc.notmpl.make:
788           Also use new RUN envvar here.
790 2008-09-10  Stefan Kost  <ensonic@users.sf.net>
792         * gtkdoc-mkdb.in:
793           Generate unique ids for properties, style and child properties.
794   
795         * gtk-doc.make:
796         * gtk-doc.notmpl.make:
797         * gtkdoc-scan.in:
798         * gtkdoc-scangobj.in:
799           If we use libtool, run scanner under libtool to use uninstalled
800           libraries.
802 2008-09-04  Stefan Kost  <ensonic@users.sf.net>
804         * gtkdoc-mkhtml.in:
805           Fix comparision.
807         * TODO:
808           ideas.
810         * configure.in:
811         * gtk-doc-fo.xsl:
812         * gtk-doc.xsl:
813         * gtkdoc-common.pl.in:
814         * gtkdoc-mkdb.in:
815         * help/manual/C/gtk-doc-manual.xml:
816         * tests/bugs/docs/Makefile.am:
817         * tests/bugs/docs/tester-docs.xml:
818         * tests/gobject/docs-tmpl/Makefile.am:
819         * tests/gobject/docs-tmpl/tester-docs.xml:
820         * tests/gobject/docs/Makefile.am:
821         * tests/gobject/docs/tester-docs.xml:
822         * tests/gobject/src/gobject.h:
823           Switch to docbook 4.3 dtd. Fixes #487727.
824           Add --name-space option to gtkdoc-mkdb for nicer indexes. Start with a
825           fo wrapper for pdf output.
827 2008-09-04  Stefan Kost  <ensonic@users.sf.net>
829         * gtk-doc.make:
830         * gtk-doc.notmpl.make:
831           Don't install index.sgml twice. Also remove the " || :;" construct
832           that ssems to be there only to eat the return code. 
834 2008-07-23  Stefan Kost  <ensonic@users.sf.net>
836         * gtkdoc-mkdb.in:
837         * gtkdoc-scan.in:
838         * tests/bugs/docs/tester-sections.txt:
839         * tests/bugs/src/tester.h:
840           Accept "char const *" as well. Fixes #544172.
842 2008-07-21  Stefan Kost  <ensonic@users.sf.net>
844         * gtk-doc.make:
845         * gtk-doc.notmpl.make:
846           Only specify options if gtkdoc-mkhtml can take them. Fixes #543855.
848         * gtkdoc-mkhtml.in:
849           Don't use bash specific features. Be more flexible so that we can add
850           more options.
852 2008-07-09  Stefan Kost  <ensonic@users.sf.net>
854         * gtkdoc-scan.in:
855           Fix struct/enum level parsing which could go one to high and then the
856           main struct would never be closed. 
857           Fixes #542137
859 2008-06-28  Stefan Kost  <ensonic@users.sf.net>
861         * autogen.sh:
862           Mention why this change is bad.
864 2008-06-28  Stefan Kost  <ensonic@users.sf.net>
866         patch by: David Nečas <yeti@physics.muni.cz>
868         * examples/Makefile.am:
869         * gtk-doc.make:
870         * gtk-doc.notmpl.make:
871         * gtkdoc-mkhtml.in:
872         * tests/gtk-doc.make:
873         * tests/gtk-doc.notmpl.make:
874           Add searchpath to gtkdoc.mkhtml. Fixes #460753
876 2008-06-22  Stefan Kost  <ensonic@users.sf.net>
878         * autogen.sh:
879           To support timj aclocal setup we are shipping gnome-doc-utils.m4
880           and making sure automake picks it up ;)
882 2008-06-22  Stefan Kost  <ensonic@users.sf.net>
884         * tools/migratetmpl.pl:
885           We were still removing too many <para>s.
886           Also add andrews trick to escape the c comments.
887           Add a newline to empty param docs.
889 2008-06-22  Stefan Kost  <ensonic@users.sf.net>
891         * m4/gnome-doc-utils.m4:
892           Add this to svn, so that bootstrap work where no gnome-doc-utils is
893           available yet.
895 2008-06-21  Stefan Kost  <ensonic@users.sf.net>
897         * tools/migratetmpl.pl:
898           Factor out multiline formatting and use for deprecated field too.
900 2008-06-21  Stefan Kost  <ensonic@users.sf.net>
902         * gtkdoc-mkdb.in:
903           Commenting.
905         * tools/migratetmpl.pl:
906           Convert character entities back.
908 2008-06-21  Stefan Kost  <ensonic@users.sf.net>
910         * TODO:
911           Start collection info about slowly deprecating crack.
913         * tools/migratetmpl.pl:
914           Add title.
916 2008-06-21  Stefan Kost  <ensonic@users.sf.net>
918         * tools/migratetmpl.pl:
919           Use $file in section comment not title. Convert only standalone para
920           tags.
922 2008-06-21  Stefan Kost  <ensonic@users.sf.net>
924         * tools/migratetmpl.pl:
925           Convert @Varargs: to @...:
927 2008-06-21  Stefan Kost  <ensonic@users.sf.net>
929         * tools/migratetmpl.pl:
930           Convert single line c comments to c++ ones. Indent multiline parameter docs.
932 2008-06-16  Stefan Kost  <ensonic@users.sf.net>
934         * gtkdoc-mktmpl.in:
935           Don't reuse file var, fixes warning context.
936   
937         * gtkdoc-scan.in:
938           Also accept *.hh as headers suffix.
940 2008-06-10  Stefan Kost  <ensonic@users.sf.net>
942         * gtk-doc.make:
943         * gtk-doc.notmpl.make:
944         * tests/gtk-doc.make:
945         * tests/gtk-doc.notmpl.make:
946           Include original CFLAGS / LDFLAGS when building the scanner. Allows to
947           have own FLAGS defined in addition.
949 2008-06-08  Stefan Kost  <ensonic@users.sf.net>
951         * TODO:
952           More planning.
954 2008-06-08  Stefan Kost  <ensonic@users.sf.net>
956         * TODO:
957           Add more ideas.
958   
959         * gtkdoc-scangobj.in:
960         * gtkdoc-scanobj.in:
961           Merge two fwrite calls.
962   
963         * tests/gobject/examples/gobject.c:
964         * tests/gobject/src/gobject.c:
965           Demostrate how to include source fragments from external files.
967         * tests/gobject/src/giface.h:
968         * tests/gobject/src/gobject.h:
969           Documents two entries.
971 2008-06-07  Sebastian Dröge  <slomo@circular-chaos.org>
973         * gtkdoc-scangobj.in:
974         * gtkdoc-scanobj.in:
975         Add "%s" format strings to printf-like functions when printing
976         a string. Fixes #536980.
978 2008-06-05  Stefan Kost  <ensonic@users.sf.net>
980         * gtkdoc-fixxref.in:
981         * gtkdoc-mkdb.in:
982         * gtkdoc-mktmpl.in:
983           Fix quoting.
985         * tools/migratetmpl.pl:
986           Add first version of a tool to support migration from tmpl docs to
987           source code comments.
989 2008-06-04  Stefan Kost  <ensonic@users.sf.net>
991         * autogen.sh:
992           Correct invocation for gnome-doc-prepare.
994 2008-06-04  Stefan Kost  <ensonic@users.sf.net>
996         * gtkdoc-common.pl.in:
997           Handle file or line being undefined.
999         * gtkdoc-mkdb.in:
1000           Warn about repeated symbols in sections. Also give line of previous
1001           occurrance. Also give that info for double file entries. Fixes #473342
1002           Give correct error locate for one warning. Fixes #532395 partialy
1004 2008-06-04  Stefan Kost  <ensonic@users.sf.net>
1006         * gtkdoc-mkdb.in:
1007           Don't warn about overriden docs comment if its the same text.
1009 2008-06-03  Stefan Kost  <ensonic@users.sf.net>
1011         * TODO:
1012           Spelling.
1014         * gtkdoc-mkdb.in:
1015           Warn and skip double file entries in section files.
1016           
1017         * gtkdoc-mktmpl.in:
1018           Use the new warning format in this script too.
1020         * gtkdoc-rebase.in:
1021           Also use optional parameters here.
1023 2008-06-02  Stefan Kost  <ensonic@users.sf.net>
1025         * tests/gobject/docs-tmpl/tester-docs.xml:
1026         * tests/gobject/docs-tmpl/tester-sections.txt:
1027         * tests/gobject/docs/tester-docs.xml:
1028         * tests/gobject/docs/tester-sections.txt:
1029         * tests/gobject/src/giface.c:
1030         * tests/gobject/src/gobject.c:
1031         * tests/gobject/src/gobject.h:
1032           Add some since: tags for the tests too.
1034 2008-06-02  Stefan Kost  <ensonic@users.sf.net>
1036         * TODO:
1037           tody up and add some comments regarding HTML_DIR.
1039         * gtkdoc-fixxref.in:
1040           HTML_DIR is not neccesarily set.
1042         * gtkdoc-mkhtml.in:
1043           Fix uninstalled.
1045         * tests/gobject/docs-tmpl/tester-docs.xml:
1046         * tests/gobject/docs/tester-docs.xml:
1047           Add more chapter id's and experiment with an index chapter.     
1049 2008-06-02  Stefan Kost  <ensonic@users.sf.net>
1051         * style.css:
1052           Improve spacing on indicies and glossaries.
1054 2008-06-02  Stefan Kost  <ensonic@users.sf.net>
1056         * TODO:
1057         * tests/bugs/docs/tester-docs.xml:
1058         * tests/gobject/docs/tester-docs.xml:
1059         * tests/gobject/docs/tester-sections.txt:
1060         * tests/gobject/docs-tmpl/tester-docs.xml:
1061         * tests/gobject/docs-tmpl/tester-sections.txt:
1062         * tests/gobject/src/gobject.c:
1063         * tests/gobject/src/gobject.h:
1064         * tests/gtk-doc.make:
1065         * tests/gtk-doc.notmpl.make:
1066           Add some index lists to the tests. Add a deprecated function.
1068 2008-06-02  Stefan Kost  <ensonic@users.sf.net>
1070         patch by: Felix Riemann <friemann@svn.gnome.org>
1072         * gtk-doc.xsl:
1073         * style.css:
1074           Produce valid html. Fixes #534627.
1076 2008-05-23  Stefan Kost  <ensonic@users.sf.net>
1078         * configure.in:
1079         * tests/gobject/Makefile.am:
1080         * tests/gobject/docs-tmpl/Makefile.am:
1081         * tests/gobject/docs-tmpl/tester-docs.xml:
1082         * tests/gobject/docs-tmpl/tester-sections.txt:
1083         * tests/gobject/docs-tmpl/tester.types:
1084         * tests/gtk-doc.make:
1085         * tests/gtk-doc.notmpl.make:
1086           Build same docs once again with old tmpl approach.
1088 2008-05-23  Stefan Kost  <ensonic@users.sf.net>
1090         * tests/bugs/docs/Makefile.am:
1091         * tests/gobject/docs/Makefile.am:
1092         * tests/gtk-doc.make:
1093         * tests/gtk-doc.notmpl.make:
1094           Sync names.
1096 2008-05-08  Stefan Kost  <ensonic@users.sf.net>
1098         * gtkdoc-mkdb.in:
1099         * gtkdoc-mktmpl.in:
1100           Fix a long standing bug that killed spaces in tmpl files.
1102 2008-05-05  Stefan Kost  <ensonic@users.sf.net>
1104         * gtkdoc-mkdb.in:
1105           Fix regexps changes from previous commit. When using /e the
1106           replacement part has to be a perl snippet.
1108 2008-05-05  Stefan Kost  <ensonic@users.sf.net>
1110         * gtkdoc-mkdb.in:
1111         * tests/bugs/docs/tester-sections.txt:
1112         * tests/bugs/src/tester.h:
1113           Don't expand '#' in ulink tags. Also allow to escape "#%@" with '\'.
1114           Add to testsuite. Fixes #530758
1116 2008-05-05  Stefan Kost  <ensonic@users.sf.net>
1118         * gtkdoc-mktmpl.in:
1119           It is GObject not GtkObject anymore
1121 2008-05-05  Stefan Kost  <ensonic@users.sf.net>
1123         * TODO:
1124           Make note about expanding urls.
1126         * help/manual/C/gtk-doc-manual.xml:
1127           Document the use of |[ ]| as a shortcut for program listing.
1129         * tests/gobject/src/giface.h:
1130         * tests/gobject/src/gobject.c:
1131           Fix one undocumented symbol and add an exampl of the programlisting
1132           shortcut.
1134 2008-04-22  Stefan Kost  <ensonic@users.sf.net>
1136         * HACKING:
1137           We need to update the webpage.
1139         * TODO:
1140         * configure.in:
1141           Planning.
1143         * gtkdoc-mkdb.in:
1144           Hopefully now unbreak the docbuild, if one has template but not uses
1145           them.
1147 2008-04-17  Stefan Kost  <ensonic@users.sf.net>
1149         * gtkdoc-mkdb.in:
1150           Add one more warning. Also trac location of section docs. Merge
1151           source symbols once and then on demand (if we read a template).
1153 2008-04-11  Stefan Kost  <ensonic@users.sf.net>
1155         * TODO:
1156         * configure.in:
1157           Idea about the tracing. Not that practical as it is.
1159         * gtkdoc-mkdb.in:
1160         * gtkdoc-mktmpl.in:
1161           Unify file-error messages. Improve warning detail. Fix undocumented
1162           status for template less runs.
1164 2008-04-10  Stefan Kost  <ensonic@users.sf.net>
1166         * TODO:
1167           Ideas.
1169         * gtkdoc-common.pl.in:
1170           Add common method for prining (gcc-style) warnings.
1172         * gtkdoc-mkdb.in:
1173           Use new method. Harmonize the warnings a bit. Remember locations
1174           symbols are taken from template files for use in warnings.
1176 2008-04-09  Stefan Kost  <ensonic@users.sf.net>
1178         * HACKING:
1179           Some releasing info.
1181         * gtkdoc-mkdb.in:
1182           Print file/line number in warning.
1184         * help/manual/C/gtk-doc-manual.xml:
1185           Some docs for what the <module>-overrides.txt file is for.
1187 2008-03-23  Stefan Kost  <ensonic@users.sf.net>
1189         * autogen.sh:
1190           Tell automake to not warn us about portabillity issues. Its too late
1191           for that.
1193         * ChangeLog:
1194           Surgery for the bugnumber.
1196 2008-03-21  Marc-Andre Lureau <marcandre.lureau@gmail.com>
1198         * .svnignore, Makefile.am, autogen.sh, configure.in,
1199         help/manual/.svnignore, help/manual/C/ChangeLog,
1200         help/manual/C/Makefile.am, help/manual/C/gtk-doc-manual-C.omf.in,
1201         help/manual/C/gtk-doc-manual.xml, help/manual/ChangeLog,
1202         help/manual/Makefile.am, help/manual/gtk-doc-manual.omf.in,
1203         m4/.svnignore, omf.make, xmldocs.make:
1204         GNOME doc-utils migration.  Fixes #335239
1206 2008-03-22  Stefan Kost  <ensonic@users.sf.net>
1208         * HACKING:
1209         * configure.in:
1210         * help/manual/C/gtk-doc-manual.xml:
1211           Back to development.
1213 === Release 1.10 ===
1215 2008-03-19  Stefan Kost  <ensonic@users.sf.net>
1217         * NEWS:
1218         * HACKING:
1219           Prepare for release.
1221         * style.css:
1222           Add fix for footnote positions.
1224 2008-02-27  Stefan Kost  <ensonic@users.sf.net>
1226         patch by: Carlos Garnacho <carlos@imendio.com>
1228         * tools/gtk-doc.el:
1229           Update emacs mode to work with emacs22. Fixes #513318.
1231 2008-02-01  Stefan Kost  <ensonic@users.sf.net>
1233         * gtkdoc-common.pl.in:
1234         * gtkdoc-mkdb.in:
1235         * gtkdoc-mktmpl.in:
1236         * tests/bugs/src/tester.h:
1237           Improve tmpl parsing and add some more logging. Fixes #512154.
1239 2008-01-30  Stefan Kost  <ensonic@users.sf.net>
1241         * tests/bugs/docs/tester-sections.txt:
1242         * tests/bugs/src/tester.h:
1243           Add testcase for #512154.
1245 2008-01-28  Stefan Kost  <ensonic@users.sf.net>
1247         * gtkdoc-mkdb.in:
1248           Condense all the multiple newlines in the generated xml.
1250         * tests/gtk-doc.make:
1251           Make sure the testsuite call the uninstalled scripts.
1253 2008-01-24  Stefan Kost  <ensonic@users.sf.net>
1255         * gtk-doc.xsl:
1256           Unbreak fixxref. The index.sgml file should not have leading
1257           whitespace. These were caused by indenting the xsl, which is dangerous
1258           in case of <xsl:text>.
1260         * gtkdoc-fixxref.in:
1261           Debug logging.
1263 2008-01-21  Stefan Kost  <ensonic@users.sf.net>
1265         * gtkdoc-common.pl.in:
1266           Don't warn when parsing enum struct members.
1268 2008-01-21  Stefan Kost  <ensonic@users.sf.net>
1270         * gtkdoc-mkdb.in:
1271         * gtkdoc-mktmpl.in:
1272           Give file and line number when complaining about duplicate
1273           definitions. Seems to not have been applied with older commit.
1275         * gtkdoc-scan.in:
1276         * tests/gobject/src/gobject.h:
1277           Handle typedef enums.
1279 2008-01-17  Stefan Kost  <ensonic@users.sf.net>
1281         * gtk-doc.make:
1282         * gtk-doc.notmpl.make:
1283           Don't fail in dist when no .types file is present. Fixes #509539.
1285 2008-01-16  Stefan Kost  <ensonic@users.sf.net>
1287         * gtkdoc-mkdb.in:
1288         * gtkdoc-mktmpl.in:
1289           Give file and line number when complaining about duplicate
1290           definitions.
1292 2008-01-14  Stefan Kost  <ensonic@users.sf.net>
1294         patch by: Joe Marcus Clarke <marcus@freebsd.org>
1296         * gtk-doc.make:
1297         * gtk-doc.notmpl.make:
1298           Do not abort the build, if gtk-doc is not installed. Fixes #508897
1300 2007-12-20  Mathias Hasselmann  <mathias@openismus.com>
1302         * configure.in:
1303         Lower Python dependency to 2.3 (#503054). Just warn when Python
1304         wasn't found. Print a configuration summary before leaving the
1305         configure script.
1306         * Makefile.am:
1307         Do not install gtkdoc-depscan when Python wasn't found.
1309 2007-12-20  Mathias Hasselmann  <mathias@openismus.com>
1311         * gtkdoc-depscan.in:
1312         Use old and/or pattern instead of the new ternary operator.
1313         This drops the Python 2.5 dependency for that script.
1314         Original patch by Frederic Peters. (#503054)
1316 2007-12-17  Mathias Hasselmann  <mathias@openismus.com>
1318         * configure.in:
1319           Use AM_PATH_PYTHON instread of AC_PATH_PROG to find Python.
1320           (#503710)
1322 2007-12-17  Stefan Kost  <ensonic@users.sf.net>
1324         * gtk-doc.xsl:
1325           Render accronyms from docbook and glossary in html.
1327 2007-12-17  Stefan Kost  <ensonic@users.sf.net>
1329         * tests/bugs/docs/tester-docs.sgml:
1330         * tests/bugs/docs/tester-docs.xml:
1331         * tests/gobject/docs/tester-docs.sgml:
1332         * tests/gobject/docs/tester-docs.xml:
1333           Add the xml instead of the sgml docs.
1335 2007-12-12  Stefan Kost  <ensonic@users.sf.net>
1337         * gtk-doc.make:
1338         * gtk-doc.notmpl.make:
1339           Revert last change and reopen #503119. Needs a different fix.
1341 2007-12-12  Stefan Kost  <ensonic@users.sf.net>
1343         * gtk-doc.make:
1344         * gtk-doc.notmpl.make:
1345           Use content_files as a dependency the sgml-build.stamp.
1347 2007-12-11  Mathias Hasselmann  <mathias@openismus.com>
1349         * gtkdoc-depscan.in:
1350           Use colon as name-version-separator in book names.
1352 2007-12-11  Mathias Hasselmann  <mathias@openismus.com>
1354         * gtkdoc-depscan.in:
1355           Also scan devhelp folders.
1357 2007-12-11  Mathias Hasselmann  <mathias@openismus.com>
1359         * gtkdoc-depscan.in: 
1360           Print reasonable error message when passing
1361           non-existant files on command line.
1363 2007-12-11  Stefan Kost  <ensonic@users.sf.net>
1365         patch by: Kouhei Sutou <kou@cozmixng.org>
1367         * gtk-doc.xsl:
1368           Consitently use UTF-8 instead of US-ASCII for output encoding.
1369           Fixes #497367
1371 2007-12-10  Mathias Hasselmann  <mathias@openismus.com>
1373         * configure.in:
1374         * gtkdoc-depscan.in:
1375         * Makefile.am:
1376           Add gtkdoc-depscan, which resolves source code dependencies
1377           by scanning devhelp2 books.
1379 2007-12-10  Stefan Kost  <ensonic@users.sf.net>
1381         * devhelp2.xsd:
1382           Update schema.
1383           
1384         * gtk-doc.notmpl.make:
1385           Remove left-over 'fi'.
1387 2007-12-05  Stefan Kost  <ensonic@users.sf.net>
1389         * gtk-doc.make:
1390         * gtk-doc.notmpl.make:
1391           Better fix for #501066.
1393 2007-12-05  Stefan Kost  <ensonic@users.sf.net>
1395         * devhelp2.xsd:
1396           Add first version of the schema.
1397           
1398         * devhelp2.xsl:
1399           Unbreak the devhelp2 file generation.
1401         * tests/gtkdoctest.sh:
1402           Add comment about doing schmea checks once they work.
1404 2007-12-04  Stefan Kost  <ensonic@users.sf.net>
1406         * gtk-doc.make:
1407         * gtk-doc.notmpl.make:
1408           Apply build flags cleanups from #498521. Spotted by
1409           dmacks@netspace.org.
1411 2007-12-04  Stefan Kost  <ensonic@users.sf.net>
1413         * tests/gobject/src/giface.c:
1414         * tests/gobject/src/gobject.c:
1415           Uhm, unbreak the links in the test docs.
1417 2007-12-04  Stefan Kost  <ensonic@users.sf.net>
1419         * tests/gobject/src/giface.c:
1420         * tests/gobject/src/gobject.c:
1421           Little test cleanup. The bug was already fixed.
1423 2007-12-04  Stefan Kost  <ensonic@users.sf.net>
1425         * tests/gobject/docs/tester-sections.txt:
1426         * tests/gobject/docs/tester.types:
1427         * tests/gobject/src/Makefile.am:
1428         * tests/gobject/src/giface.c:
1429         * tests/gobject/src/giface.h:
1430         * tests/gobject/src/gobject.c:
1431         * tests/gobject/src/gobject.h:
1432         * tests/gobject/src/tester.c:
1433         * tests/gobject/src/tester.h:
1434           Refactor tests for #489279.
1436 2007-12-04  Stefan Kost  <ensonic@users.sf.net>
1438         * gtkdoc-common.pl.in:
1439         * tests/bugs/docs/tester-sections.txt:
1440         * tests/bugs/src/tester.h:
1441           Add testcase for #501038. Improve struct parsing to correctly finish
1442           if the last line in struct declaration was a preprocessor statement.
1443           Fixes  #501038.
1445 2007-12-04  Stefan Kost  <ensonic@users.sf.net>
1447         patch by: David Nečas <yeti@physics.muni.cz>
1449         * gtkdoc-common.pl.in:
1450         * tests/bugs/docs/tester-sections.txt:
1451         * tests/bugs/src/tester.c:
1452         * tests/bugs/src/tester.h:
1453           Handle forward typedef'd enums. Fixes #446648.
1455 2007-12-02  Loïc Minier  <lool@dooz.org>
1457         * gtk-doc.make:
1458         * gtk-doc.notmpl.make:
1459           Add double-quotes around `which gtkdoc-rebase` to prevent "test"
1460           from failing with "/bin/sh: line 11: test: !=: unary operator
1461           expected ".  Fixes #501066.
1463 2007-11-11  Stefan Kost  <ensonic@users.sf.net>
1465         patch by: David Nečas <yeti@physics.muni.cz>
1467         * gtk-doc.xsl:
1468         * gtkdoc-mkdb.in:
1469           Avoid generated node ids. Fixes #365913.
1471 2007-11-11  Stefan Kost  <ensonic@users.sf.net>
1473         * gtk-doc.xsl:
1474         * gtkdoc-mkdb.in:
1475         * style.css:
1476           Alternative and cleaner footer implementation (unblock #365913).
1478 2007-11-11  Stefan Kost  <ensonic@users.sf.net>
1480         patch by: David Nečas <yeti@physics.muni.cz>
1482         * gtkdoc-mkdb.in:
1483         * gtkdoc-scangobj.in:
1484           Display proper types for pointer properties. Fixes #468278.
1486 2007-10-31  Stefan Kost  <ensonic@users.sf.net>
1488         * gtkdoc-mkdb.in:
1489           Only warn about missing deprecation guards for declared symbols.
1490           Fixes #492005.
1492 2007-10-31  Stefan Kost  <ensonic@users.sf.net>
1494         * tests/gtk-doc.make:
1495         * tests/gtkdoctest.sh:
1496           Run our own check script. Clean the make output a bit.
1498 2007-10-31  Stefan Kost  <ensonic@users.sf.net>
1500         * help/manual/C/gtk-doc-manual.xml:
1501           Small doc fix.
1503 2007-10-31  Stefan Kost  <ensonic@users.sf.net>
1505         * Makefile.am:
1506           Formatting.
1508         * configure.in:
1509         * tests/gtk-doc.make:
1510           Cleanup the 'make check' deps configure check.
1512 2007-10-01  Stefan Kost  <ensonic@users.sf.net>
1514         * configure.in:
1515         * help/manual/C/gtk-doc-manual.xml:
1516           Back to development.
1518 === Release 1.9 ===
1520 2007-09-30  Stefan Kost  <ensonic@users.sf.net>
1522         * NEWS:
1523           Releasing 1.9.
1525 2007-09-27  Stefan Kost  <ensonic@users.sf.net>
1527         * gtk-doc.make:
1528         * gtk-doc.notmpl.make:
1529         * gtkdoc-rebase.in:
1530           New day, new fix. Remove testing $(DESTDIR) from makefile and use
1531           Getopt::Long qw(:config gnu_getopt); in rebase.
1533 2007-09-26  Stefan Kost  <ensonic@users.sf.net>
1535         * gtk-doc.make:
1536           And actually saving before commiting might greatly help.
1538 2007-09-26  Stefan Kost  <ensonic@users.sf.net>
1540         * gtk-doc.make:
1541         * gtk-doc.notmpl.make:
1542           Another attempt to fix the rules.
1544 2007-09-26  Stefan Kost  <ensonic@users.sf.net>
1546         * gtk-doc.make:
1547         * gtk-doc.notmpl.make:
1548           If there is nothing to install, don't rebase.
1550 2007-09-26  Stefan Kost  <ensonic@users.sf.net>
1552         * gtk-doc.make:
1553         * gtk-doc.notmpl.make:
1554           Unbreak the last change.
1556 2007-09-26  Stefan Kost  <ensonic@users.sf.net>
1558         * gtk-doc.make:
1559         * gtk-doc.notmpl.make:
1560           Handle DESTDIR= case.
1562 2007-09-26  Stefan Kost  <ensonic@users.sf.net>
1564         * gtk-doc.make:
1565         * gtk-doc.notmpl.make:
1566         * gtkdoc-rebase.in:
1567           Fix destdir option name.
1569 2007-09-25  Stefan Kost  <ensonic@users.sf.net>
1571         * tests/gtk-doc.make:
1572           Get make distcheck fully working.
1574 2007-09-25  Stefan Kost  <ensonic@users.sf.net>
1576         * tests/Makefile.am:
1577         * tests/bugs.sh:
1578         * tests/gobject.sh:
1579         * tests/gtkdoctest.sh:
1580           Try to get make distcheck to run.
1582         * tests/gtk-doc.make:
1583           Don't dist docs generated during test runs and remove some cruft.
1586 2007-09-24  Stefan Kost  <ensonic@users.sf.net>
1588         patch by: David Nečas <yeti@physics.muni.cz>
1590         * NEWS:
1591         * tests/bugs/docs/Makefile.am:
1592         * tests/gobject/docs/Makefile.am:
1593         * tests/gtk-doc.make:
1594           Adapt xml/ cleaning from gtk-doc.notmpl.make.  Clean log files.
1596 2007-09-24  Stefan Kost  <ensonic@users.sf.net>
1598         * NEWS:
1599           Current release notes.
1601 2007-09-24  Stefan Kost  <ensonic@users.sf.net>
1603         * MAINTAINERS:
1604           Make mango happy.
1606         * examples/Makefile.am:
1607         * gtk-doc.make:
1608         * gtk-doc.notmpl.make:
1609           Process files from DISTCLEANFILES in the dist-hooks.
1611 2007-09-24  Stefan Kost  <ensonic@users.sf.net>
1613         patch by: David Nečas <yeti@physics.muni.cz>
1615         * Makefile.am:
1616           Add gtk-doc.notmpl.make to EXTRA_DIST. Fixes #479913.
1618 2007-09-20  Stefan Kost  <ensonic@users.sf.net>
1620         * gtkdoc-fixxref.in:
1621           Revert online option for fixxref now that we have a rebase command.
1623 2007-09-18  Stefan Kost  <ensonic@users.sf.net>
1625         * gtkdoc-scan.in:
1626           Handle function pointers. Fixes #477532.
1628 2007-09-18  Stefan Kost  <ensonic@users.sf.net>
1630         patch by: David Nečas <yeti@physics.muni.cz>
1632         * gtkdoc-scan.in:
1633           Parse reoccuring const. Fixes #471014.
1635         * tests/bugs/docs/Makefile.am:
1636         * tests/bugs/docs/tester-sections.txt:
1637         * tests/bugs/src/tester.c:
1638         * tests/bugs/src/tester.h:
1639         * tests/gobject/docs/Makefile.am:
1640         * tests/gobject/src/tester.c:
1641         * tests/gobject/src/tester.h:
1642           Add more tests and cleanup the test-code a little.
1644 2007-09-17  Stefan Kost  <ensonic@users.sf.net>
1646         * gtk-doc.make:
1647         * gtk-doc.notmpl.make:
1648           Revert some Makefile improvements, as we can't control the quoting
1649           reliably.
1651 2007-09-11  Stefan Kost  <ensonic@users.sf.net>
1653         * gtkdoc-mkdb.in:
1654           Default master doc should have proper extension. Fixes #467773.
1656 2007-09-11  Stefan Kost  <ensonic@users.sf.net>
1658         patch by: David Nečas <yeti@physics.muni.cz>
1660         * gtk-doc.make:
1661         * gtk-doc.notmpl.make:
1662           Makefile improvements.
1664 2007-09-03  Stefan Kost  <ensonic@users.sf.net>
1666         * MAINTAINERS:
1667           Update MAINTAINER to adhere to rules given on
1668           http://live.gnome.org/MaintainersCorner#maintainers
1670 2007-08-23  Benjamin Otte  <otte@gnome.org>
1672         * gtkdoc-mktmpl.in:
1673           sync with gtkdoc-mkdb completely. Really fixes #419997
1675 2007-08-21  Stefan Kost  <ensonic@users.sf.net>
1677         * gtkdoc-mkdb.in:
1678         * style.css:
1679           Add divider and empty space at the bottom. Mostly fixes #448879.
1681 2007-08-21  Stefan Kost  <ensonic@users.sf.net>
1683         * gtk-doc.make:
1684         * gtk-doc.notmpl.make:
1685           Make use of rebase if possible. Fixes #465920
1687         * gtkdoc-rebase.in:
1688           Rebase improvements and fixes.          
1690 2007-08-16  Stefan Kost  <ensonic@users.sf.net>
1692         * .cvsignore:
1693         * help/.cvsignore:
1694         * help/manual/.cvsignore:
1695         * help/manual/C/.cvsignore:
1696           Get rid of cvsignore files.
1698 2007-08-14  Stefan Kost  <ensonic@users.sf.net>
1700         * gtkdoc-common.pl.in:
1701         * tests/bugs/docs/tester-sections.txt:
1702         * tests/bugs/src/tester.h:
1703           Don't die when encountering #if/#endif in enums. Fixes #324535.
1705 2007-08-14  Stefan Kost  <ensonic@users.sf.net>
1707         patch by: Frederic Peters <fpeters@0d.be>
1709         * style.css:
1710           Styling hr tags.
1712 2007-08-14  Stefan Kost  <ensonic@users.sf.net>
1714         * help/manual/C/gtk-doc-manual.xml:
1715           Document new features and bump version.
1717 2007-08-13  Stefan Kost  <ensonic@users.sf.net>
1719         * gtkdoc-mkdb.in:
1720           Fix the funny side-effect of last 'broken-returns' fix.
1722 2007-08-13  Stefan Kost  <ensonic@users.sf.net>
1724         * gtkdoc-scan.in:
1725         * tests/bugs/src/tester.h:
1726           Really fix #460127.
1728 2007-08-13  Stefan Kost  <ensonic@users.sf.net>
1730         * gtkdoc-mkdb.in:
1731           Now the 'broken' returns seems to work better. Fixes #380824 more.
1733 2007-08-13  Stefan Kost  <ensonic@users.sf.net>
1735         * tests/bugs/docs/tester-sections.txt:
1736         * tests/bugs/src/tester.c (bug_379466, bug_380824):
1737         * tests/bugs/src/tester.h (test):
1738           New test.
1739         * tests/gtkdoctest.sh:
1740           Fix bashism.
1742 2007-08-12  Stefan Kost  <ensonic@users.sf.net>
1744         * tests/bugs/docs/tester-sections.txt:
1745         * tests/bugs/src/tester.h:
1746           Add another test for a bug we fixed with the changes below.
1747           Fixes #460127.
1749 2007-08-12  Stefan Kost  <ensonic@users.sf.net>
1751         * gtkdoc-scan.in:
1752         * tests/bugs/docs/tester-sections.txt:
1753         * tests/bugs/src/tester.c:
1754         * tests/bugs/src/tester.h:
1755           Improved scan logic. Fixes #411739.
1757 2007-08-12  Stefan Kost  <ensonic@users.sf.net>
1759         * gtkdoc-mkdb.in:
1760         * tests/bugs/src/tester.h:
1761           Handle newline in declarations better. Fixes #379466.
1762           Ensure space in multiline declarations when removing the newline.
1763           Fix missing argument docs in template free build.
1765 2007-08-12  Stefan Kost  <ensonic@users.sf.net>
1767         * gtkdoc-mkdb.in:
1768         * gtkdoc-mktmpl.in:
1769           Handle "unsigned long|unsigned short|signed long|signed short".
1770           Fixes #445693.
1772 2007-08-12  Stefan Kost  <ensonic@users.sf.net>
1774         * Makefile.am:
1775         * configure.in:
1776         * gtkdoc-check:
1777         * gtkdoc-check.in:
1778           Replacing my shell based test script by Davids perl based one. Add
1779           licence, copyright and docs header. Integrate with build.
1781 2007-08-12  Stefan Kost  <ensonic@users.sf.net>
1783         patch by: David Nečas <yeti@physics.muni.cz>
1785         * gtkdoc-scangobj.in:
1786           Make introspection of interfaces work in more cases. Fixes #355352.
1788 2007-08-12  Stefan Kost  <ensonic@users.sf.net>
1790         patch by: David Nečas <yeti@physics.muni.cz>
1792         * configure.in:
1793           Cleanup glib detection for tests.
1795 2007-08-11  Stefan Kost  <ensonic@users.sf.net>
1797         * gtkdoc-check:
1798           Fix modulename check.
1800 2007-08-11  Stefan Kost  <ensonic@users.sf.net>
1802         * Makefile.am:
1803           Install new makefile.
1805         * configure.in:
1806           Bump version as we're working on 1.9.
1808         * gtkdocize.in:
1809           Add option to select makefile-flavour.
1811 2007-08-11  Stefan Kost  <ensonic@users.sf.net>
1813         * gtk-doc.make:
1814           Add dummy rule to make first build run through. Fixes #156643
1816 2007-08-11  Stefan Kost  <ensonic@users.sf.net>
1818         * style.css:
1819           Hide fixed navigationbar when printing. Fixes #449618
1821 2007-08-11  Stefan Kost  <ensonic@users.sf.net>
1823         * gtk-doc.notmpl.make:
1824           Add new makefile for tmpl-less build.
1826 2007-08-11  Stefan Kost  <ensonic@users.sf.net>
1828         patch by: David Nečas <yeti@physics.muni.cz>
1830         * autogen.sh:
1831           Accepts automake 1.10 too. Fixes #459225
1833 2007-08-11  Stefan Kost  <ensonic@users.sf.net>
1835         * gtkdoc-mkdb.in:
1836           Make the tmpl-less build work.
1838         * tests/gtk-doc.make:
1839           Switch again to the tmpl-less build.
1841 2007-08-10  Stefan Kost  <ensonic@users.sf.net>
1843         patch by: Rouslan Solomakhin <rouslan@solomakhin.net>
1845         * configure.in:
1846           Fix the build.
1848 2007-08-10  Stefan Kost  <ensonic@users.sf.net>
1850         * gtk-doc.make:
1851         * tests/gtk-doc.make:
1852           Revert fix for #433338 and reopen bug. Breaks if file is not there,
1853           e.g. if --rebuild-types is used.
1855 2007-08-10  Stefan Kost  <ensonic@users.sf.net>
1857         * gtk-doc.make:
1858           Some cleanups.
1860         * tests/gtk-doc.make:
1861           Try the tmpl free build here.
1863 2007-08-10  Stefan Kost  <ensonic@users.sf.net>
1865         * examples/Makefile.am:
1866           Add commented out TESTS.
1868         * gtk-doc.m4:
1869           Check for location of gtkdoc-check.
1871         * Makefile.am:
1872         * gtkdoc-check:
1873           Test doc status and print result in check like layout.
1875 2007-08-02  Stefan Kost  <ensonic@users.sf.net>
1877         patch by: Sven Herzberg <herzi@gnome-de.org>
1879         * gtk-doc.make:
1880         * tests/gtk-doc.make:
1881           Rebuild documentation of $(DOC_MODULE).types changed. Fixes #433338
1883 2007-08-02  Stefan Kost  <ensonic@users.sf.net>
1885         patch by: David Nečas <yeti@physics.muni.cz>
1887         * Makefile.am:
1888         * configure.in:
1889         * gtkdoc-rebase.in:
1890           Allow rebasing cross-references in generated docs. Fixes #434134.
1892 2007-08-02  Stefan Kost  <ensonic@users.sf.net>
1894         * gtkdoc-mkhtml.in:
1895           Add a hack to gtkdoc-mkhtml to run uninstalled too.
1897 2007-08-02  Stefan Kost  <ensonic@users.sf.net>
1899         Patch by: David Nečas <yeti@physics.muni.cz>
1901         * gtk-doc.xsl:
1902           Generate ONLINE tag in index.sgml.
1904         * gtkdoc-fixxref.in:
1905           Allow to base links against online versions of xreffed docs.
1906           Fixes #454916.
1907           
1908         * gtkdoc-mkdb.in:
1909           Add releaseinfo to doctemplates.
1911         * tests/bugs/docs/tester-docs.sgml:
1912         * tests/gobject/docs/tester-docs.sgml:
1913           Update templates.
1915 2007-08-02  Stefan Kost  <ensonic@users.sf.net>
1917         * tests/bugs/docs/Makefile.am:
1918         * tests/gobject/docs/Makefile.am:
1919         * tests/gtk-doc.make:
1920           Use PERL5LIB envvar to use uninstalled gtkdoc-common.pl for tests.
1921           Use tee to both show and redirect logs.
1922           Build test-docs in check-local instead of all-local.
1923           Fixes #459725.
1925 2007-07-25  Stefan Kost  <ensonic@users.sf.net>
1927         * gtkdoc-mkdb.in:
1928         * gtkdoc-scan.in:
1929           Some more debug prints and code cleaning.
1931 2007-07-23  Stefan Kost  <ensonic@users.sf.net>
1933         Patch by: Yeti <yeti@physics.muni.cz>
1935         * gtk-doc.make:
1936         * gtkdoc-mkdb.in:
1937           Report undeclared symbols into a file. Fixes #436565.
1939 2007-07-18  Stefan Kost  <ensonic@users.sf.net>
1941         * gtkdoc-mkdb.in:
1942           Readd two debug prints and remove one obsolete one.
1944         * tests/bugs/Makefile.am:
1945         * tests/gobject/Makefile.am:
1946           Enforce 'make clean' before 'make check'.
1948 2007-07-18  Stefan Kost  <ensonic@users.sf.net>
1950         Patch by: Yeti <yeti@physics.muni.cz>
1952         * gtkdoc-mkdb.in:
1953           Cleanup broek-return handling and add ignore_broken_returns for
1954           section docs. Fixes #457077
1956         * tests/bugs/docs/Makefile.in:
1957         * tests/gobject/docs/Makefile.in:
1958           Remove.
1960         * tests/gtk-doc.make:
1961           Use the local tools so that 'make check' works uninstalled.
1962           
1964 2007-07-18  Stefan Kost  <ensonic@users.sf.net>
1966         * tests/bugs/docs/tester-sections.txt:
1967         * tests/bugs/src/tester.c: (bug_419997):
1968         * tests/bugs/src/tester.h:
1969         * tests/gobject/src/tester.c: (gtkdoc_tester_class_init):
1970         * tests/gobject/src/tester.h:
1971           Add more test cases.
1973 2007-07-17  Stefan Kost  <ensonic@users.sf.net>
1975         * tests/bugs/docs/Makefile.in:
1976         * tests/bugs/docs/tester-sections.txt:
1977         * tests/bugs/src/tester.c: (bug_141869_a), (bug_141869_b),
1978         (bug_379466), (bug_445693):
1979         * tests/bugs/src/tester.h:
1980         * tests/gtk-doc.make:
1981         * tests/gtkdoctest.sh:
1982           Improve test suite.
1984 2007-07-17  Stefan Kost  <ensonic@users.sf.net>
1986         Patch by: Yeti <yeti@physics.muni.cz>
1988         * gtkdoc-common.pl.in:
1989         * gtkdoc-mkdb.in:
1990         * gtkdoc-mktmpl.in:
1991         * gtkdoc-scan.in:
1992           Improve paramenter parsing to allow parameter names that contain
1993           const or restricted. Fixes #419997
1994           Also fix the signed/unsigned more.
1996 2007-07-17  Stefan Kost  <ensonic@users.sf.net>
1998         * Makefile.am:
1999         * autogen.sh:
2000         * configure.in:
2001         * tests/Makefile.am:
2002         * tests/bugs.sh:
2003         * tests/bugs/Makefile.am:
2004         * tests/bugs/docs/Makefile.am:
2005         * tests/bugs/docs/Makefile.in:
2006         * tests/bugs/docs/tester-docs.sgml:
2007         * tests/bugs/docs/tester-sections.txt:
2008         * tests/bugs/docs/tester.types:
2009         * tests/bugs/src/Makefile.am:
2010         * tests/bugs/src/tester.c: (bug_445693), (bug_141869_a),
2011         (bug_141869_b):
2012         * tests/bugs/src/tester.h:
2013         * tests/gobject.sh:
2014         * tests/gobject/Makefile.am:
2015         * tests/gobject/docs/Makefile.am:
2016         * tests/gobject/docs/Makefile.in:
2017         * tests/gobject/docs/tester-docs.sgml:
2018         * tests/gobject/docs/tester-sections.txt:
2019         * tests/gobject/docs/tester.types:
2020         * tests/gobject/src/Makefile.am:
2021         * tests/gobject/src/tester.c: (gtkdoc_tester_new),
2022         (gtkdoc_tester_get_property), (gtkdoc_tester_set_property),
2023         (gtkdoc_tester_class_init), (gtkdoc_tester_get_type):
2024         * tests/gobject/src/tester.h:
2025         * tests/gtk-doc.make:
2026         * tests/gtkdoctest.sh:
2027         Add test-suite. Fixes #457173
2029 2007-07-16  Stefan Kost  <ensonic@users.sf.net>
2031         Patch by: Yeti <yeti@physics.muni.cz>
2033         * gtkdoc-mkdb.in:
2034         Avoid useless $return_start access.
2036 2007-07-16  Stefan Kost  <ensonic@users.sf.net>
2038         Patch by: Petteri Räty <betelgeuse@gentoo.org>
2040         * gtk-doc.m4:
2041         Make gtk-doc.m4 fail when needed gtk-doc is not installed and notify
2042         user. Fixes #323938 and #450338.
2044 2007-07-15  Stefan Kost  <ensonic@users.sf.net>
2046         * gtkdoc-mkdb.in:
2047         * gtkdoc-mktmpl.in:
2048         Handle signed/unsigned without int. Fixes #141869.
2050 2007-07-15  Stefan Kost  <ensonic@users.sf.net>
2052         Patch by: Yeti <yeti@physics.muni.cz>
2054         * gtkdoc-mkdb.in:
2055         Improve handling of legacy "return" statement doc parsing. Warn about
2056         those.
2058 2007-07-15  Stefan Kost  <ensonic@users.sf.net>
2060         * gtkdoc-mkdb.in:
2061         Fix perl warning about usage of undefined symbol.
2063 2007-07-15  Stefan Kost  <ensonic@users.sf.net>
2065         * gtkdoc-mkdb.in:
2066         * gtkdoc-mktmpl.in:
2067         Sync the function decl arg parsing. Fixes #419308.
2069 2007-07-15  Stefan Kost  <ensonic@users.sf.net>
2071         * gtkdoc-fixxref.in:
2072         Improve the ---help output a little.
2074 2007-07-15  Stefan Kost  <ensonic@users.sf.net>
2076         * gtkdoc-fixxref.in:
2077         Improve detection of absolute/relatives paths. Skip duplicate paths.
2078         Fixes #453717.
2080 2007-06-14  Lo�c Minier  <lool@dooz.org>
2082         * gtk-doc.make:
2083         Cleanup $(DOC_MODULE)-undocumented.txt files in
2084         maintainer-clean-local.  Fixes #415388.
2086 2007-06-14  Lo�c Minier  <lool@dooz.org>
2088         * gtk-doc.m4:
2089         Fix warnings in m4 macros when running "autoreconf -fi -Wall";
2090         Guillem Jover. Fixes #428596.
2092 2007-06-11  Damon Chaplin  <damon@gnome.org>
2094         * gtkdoc-mkdb.in (ExpandAbbreviations): just output "signal" and
2095         "property" as the text for cross-reference links to signals and
2096         properties, rather than something like "Object::signal" which can get
2097         a bit long. Also tidied up the code a little.
2098         (GetArgs): put the " inside the literal element.
2099         (GetSignals): use a literal element for the signal name in the title,
2100         to match the properties.
2102 2007-03-16  Stefan Kost  <ensonic@users.sf.net>
2104         * gtkdoc-common.pl.in: handle preprocessor statements in enum and
2105         struct declarations. Fixes #418027.
2107 2007-02-27  Stefan Kost  <ensonic@users.sf.net>
2109         * gtk-doc.xsl: create toc for part and reference
2111         * style.css: Fix  placement of div.reference
2113 === release 1.8 ===
2115 2007-02-16  Damon Chaplin  <damon@gnome.org>
2117         * Released 1.8.
2119 2007-02-16  Damon Chaplin  <damon@gnome.org>
2121         * gtkdoc-scan.in: only rebuild the .types file automatically on the
2122         very first run (i.e. when there are no sections or types files).
2124         * gtkdoc-scangobj.in: skip gnome_keyring_item_info_get_type if it is
2125         in the .types file as it isn't a real GObject type. This is a hack to
2126         avoid breaking the GNOME build. See bug #386508.
2128 2007-02-11  Stefan Kost  <ensonic@users.sf.net>
2130         * gtk-doc.xsl: fix prerequisite section in nav-header
2132 2007-02-07  Stefan Kost  <ensonic@users.sf.net>
2134         * style.css: fixing footnote subscripts, make tables look nicer.
2135         #405051
2137 2007-02-07  Damon Chaplin  <damon@gnome.org>
2139         * gtk-doc.make: make $(DOC_MODULE)-sections.txt and
2140         $(DOC_MODULE)-overrides.txt depend on scan-build.stamp, so that
2141         parallel make works. #404122, Ed Catmur.
2143 2007-02-07  Damon Chaplin  <damon@gnome.org>
2145         * gtkdoc-scangobj.in: don't return if !G_TYPE_IS_OBJECT (object_type)
2146         as that means interface properties don't get output. This was broken
2147         by the patch for #348058.
2149 2007-01-21  Damon Chaplin  <damon@gnome.org>
2151         * gtkdoc-mkdb.in: added "--default-includes" option to specify the
2152         default "#include"s to place at the top of the synopsis of each
2153         section. Normally this is specified in a <INCLUDE>...</INCLUDE> line
2154         in MODULE-sections.txt, but if you are using the "--rebuild-sections"
2155         option to automatically rebuild the MODULE-sections.txt file you can't
2156         use that. #395023.
2158 2007-01-21  Damon Chaplin  <damon@gnome.org>
2160         * gtkdoc-mktmpl.in (ReadTemplateFile):
2161         * gtkdoc-mkdb.in (ReadTemplateFile): improved param regexp to handle
2162         weird macro vararg names like "format...". #398971.
2164 2007-01-16  Damon Chaplin  <damon@gnome.org>
2166         * gtkdoc-mkdb.in: support "Include" setting in section docs in source
2167         code, same as <INCLUDE>...</INCLUDE> setting in sections.txt file.
2168         Part of #395023.
2170 2007-01-16  Damon Chaplin  <damon@gnome.org>
2172         * gtkdoc-mkdb.in (OutputMacro): try to line up multiple lines of
2173         arguments if possible. #384249
2175 2007-01-16  Damon Chaplin  <damon@gnome.org>
2177         * gtkdoc-scan.in (ScanHeader): for headers marked private, return
2178         immediately so we don't add anything to the sections file. #395005.
2180 2007-01-16  Damon Chaplin  <damon@gnome.org>
2182         * gtkdoc-mkdb.in: a number of changes to help when adding example code
2183         to the docs (#368382):
2185          a) Support CDATA in source code comments. (We don't touch anything in
2186             CDATA.)
2187          b) Support |[ ... ]| to include example code. (Just gets converted to
2188             <informalexample><programlisting>)
2189          c) Improve <programlisting> handling, by not inserting <para></para>
2190             and not expanding "()", "@" or "%". (It still expands '#' so people
2191             can use cross-references to any symbols if they want to.).
2192          d) Improve '#' links a bit by skipping symbols that look like C
2193             preprocessor directives (e.g. "#include").
2194          e) Improve '&' handling a bit by converting to '&amp;' if it doesn't
2195             already look like the start of an entity reference.
2196          f) Added special case for "#include <xxxx>" in <programlisting> so the
2197             "<" and ">" get replaced by entities.
2199         * gtkdoc-mktmpl.in (ReadTemplateFile):
2200         * gtkdoc-mkdb.in (ReadTemplateFile): fixed param regexp so it handles
2201         "@...:" for varargs again. It also cleans up messed up template files
2202         luckily.
2204 2007-01-04  Damon Chaplin  <damon@gnome.org>
2206         * gtk-doc.make (dist-hook): abort dist if html docs aren't generated.
2207         #166462, Gustavo Carneiro.
2209 2007-01-03  Damon Chaplin  <damon@gnome.org>
2211         * gtkdoc-mkdb.in: improved output a little - made field widths larger,
2212         removed signal prototypes from synopsis, and capitalized all signal
2213         flags (to be consistent with argument capitalization). #384247,
2214         Hans Petter Jansson.
2216 2007-01-03  Damon Chaplin  <damon@gnome.org>
2218         * gtkdoc-mktmpl.in (OutputDeclaration):
2219         * gtkdoc-mkdb.in (OutputFunction): fix parsing of "char * const"
2220         arguments, with an extra "\s*". #387681
2222 2007-01-03  Damon Chaplin  <damon@gnome.org>
2224         * omf.make:
2225         * xmldocs.make: updated to new versions from gnome-common. #363622
2226         Also reverted the changes made for #316508 since they may cause
2227         problems. We'll let the scrollkeeper/gnome-common/autoconf people
2228         sort out that issue.
2230 2006-12-07  Ross Burton  <ross@burtonini.com>
2232         * help/manual/C/gtk-doc-manual.xml:
2233         Add examples of how to document structs, properties and signals
2234         (#383401).
2236 2006-12-04  Damon Chaplin  <damon@gnome.org>
2238         * gtkdoc-scangobj.in: added a '--query-child-properties' argument to
2239         allow you to specify a function to return a list of child properties
2240         for a class (similar to GtkContainer child properties). #379203
2242 2006-10-16  Damon Chaplin  <damon@gnome.org>
2244         * gtkdoc-scangobj.in: remove a shadow declaration to avoid compiler
2245         warnings. #362475
2247 2006-10-15  Damon Chaplin  <damon@gnome.org>
2249         * gtkdoc-scan.in: added a '--rebuild-sections' option that will
2250         automatically recreate the MODULE-sections.txt file each time.
2251         (This only works for projects with very neat header files.) #310494.
2253 2006-10-15  Damon Chaplin  <damon@gnome.org>
2255         Bug #338517: Automatically creating/updating .types file:
2257         * gtkdoc-scan.in: added a '--rebuild-types' option which will
2258         automatically update the .types file using all _get_type() functions
2259         found in the headers. (It will also do this if no .types file is found,
2260         i.e. when gtk-doc is first run on a project.)
2262         * gtk-doc.make (scan-build.stamp): run gtkdoc-scan before
2263         gtkdoc-scangobj so we can use the generated .types file.
2265         * gtkdoc-scangobj.in: if the .types file doesn't have any #include
2266         directives, just output "extern GType *get_type();" declarations for
2267         each *_get_type() function.
2269 2006-10-14  Damon Chaplin  <damon@gnome.org>
2271         * gtkdoc-mkdb.in (ExpandAbbreviationsExceptCDATA): new function used
2272         to expand abbreviations in extra files, but leaving CDATA sections
2273         as they are. (#360579)
2275 2006-10-14  Damon Chaplin  <damon@gnome.org>
2277         * gtkdoc-mkdb.in (OutputSGML): Allow the section id to be set from
2278         within the source code "SECTION:" comment block. (#349855)
2280 2006-10-13  Damon Chaplin  <damon@gnome.org>
2282         * style.css: added missing comma from previous fix (#360967).
2284 2006-10-13  Damon Chaplin  <damon@gnome.org>
2286         * gtkdoc-mkdb.in (OutputSymbolTraits): new function to output the
2287         "Since" and "Stability Level:" paragraphs, with roles to allow
2288         XSLT styling. (#348046)
2290 2006-10-13  Damon Chaplin  <damon@gnome.org>
2292         * gtkdoc-scangobj.in: support interfaces on non-GObject types.
2293         (#348058, Josh Parsons).
2295 2006-10-13  Damon Chaplin  <damon@gnome.org>
2297         * gtkdoc-scangobj.in: make sure interfaces are initialized so the
2298         signals query works. (#355352)
2300 2006-10-13  Damon Chaplin  <damon@gnome.org>
2302         * style.css: Make sure appendix title isn't obscured by navigation bar
2303         (#360967, Philip Kovacs).
2305 2006-09-09  Matthias Clasen  <mclasen@redhat.com>
2307         * gtkdoc-scangobj.in (get_type_name): Don't set is_pointer
2308         to TRUE for enum and flags types.  (#354880, Yevgen Muntyan)
2310 === release 1.7 ===
2312 2006-07-29  Damon Chaplin  <damon@gnome.org>
2314         * Released 1.7.
2316 2006-06-30  Damon Chaplin  <damon@gnome.org>
2318         * gtkdoc-mkdb.in (ScanSourceFile): fix regexp to allow section names
2319         with '-' in them.
2321         * gtk-doc.make (all-local, docs): added separate 'docs' target that can
2322         be used even when the '--disable-gtk-doc' configure option is used.
2324 2006-06-15  Jody Goldberg <jody@gnome.org>
2326         * gtkdoc-mkdb.in (OutputFunction) : finish off #341872
2327           Support 'T const * const *foo' and other more complex types.
2328           Support ptr2ptr2func as a func argument.
2329             'void foo (void (**func) (void))'
2330         * gtkdoc-mktmpl.in : ditto.
2332           (committed by Damon with minor changes to spacing so GTK+ docs are
2333            unchanged).
2335 2006-06-09  Damon Chaplin  <damon@gnome.org>
2337         * gtkdoc-mkdb.in:
2338         * gtk-doc.xsl: use the 'role' attribute rather than the 'id' attribute
2339         to identify the different sections for the navigation bar, since 'id'
2340         must be unique throughout the entire document. Also fixed a few minor
2341         issues with the output. (#342861, Leonardo Boshell)
2343 2006-05-30  Damon Chaplin  <damon@gnome.org>
2345         * gtkdoc-fixxref.in (FixHTMLFile): Use the 's' modifier to the
2346         substitution so we handle links spanning more than one line.
2347         (#342845).
2349 2006-05-22  Damon Chaplin  <damon@gnome.org>
2351         * configure.in:
2352         * Makefile.am:
2353         * help/Makefile.am:
2354         * help/manual/Makefile.am: use a separate Makefile.am for each
2355         subdirectory rather than using "SUBDIRS=help/manual/C".
2357 2006-05-21  Jody Goldberg <jody@gnome.org>
2359         * gtkdoc-common.pl.in (ParseStructDeclaration) : Support
2360           'long double foo' and
2361           'T const * const *foo' (#341872)
2362         * gtkdoc-mktmpl.in (OutputDeclaration) : handle ptrs to ptrs to
2363           functions 'void func (void (**ptr2ptr2func)(int a))'
2365 2006-05-21  Damon Chaplin  <damon@gnome.org>
2367         * gtkdoc-mkdb.in (ScanSourceFile): don't check basename for '.[hc]'
2368         suffix since we allow other suffixes as well now. (#340199)
2370         * gtkdoc-mktmpl.in (OutputSignalTemplates): check if the parameter
2371         is actually in the source code comment block. If not, use the default
2372         name. Otherwise we were outputting an empty "@:" in the templates.
2373         (ReadTemplateFile): remove empty "@:" lines caused by above bug.
2375 2006-04-15  Damon Chaplin  <damon@gnome.org>
2377         * xmldocs.make: use gtkdochelpdir rather than docdir to avoid clash
2378         with autoconf. (#316508)
2380         * tools/gtk-doc.el: Output "Returns:" rather than "Return value:",
2381         and a "C-x4s" binding for inserting a blank section header.
2383         * gtk-doc.make (sgml-build.stamp): added $(DOC_MODULE)-sections.txt
2384         to the dependencies, since although the templates depend on it, they
2385         may not be changed, but the XML should still be rebuilt.
2387         * gtkdoc-mkdb.in (ScanSourceFile): allow whitespace after "SECTION:".
2389 2006-04-13  Damon Chaplin  <damon@gnome.org>
2391         * gtkdoc-mkdb.in (ReadArgsFile): When outputting a warning about a
2392         property, use a single colon ':', since that is what is used to
2393         document properties in the source code. (2 colons are used for signals)
2395         * gtk-doc.make (sgml-build.stamp): added $(HFILE_GLOB) here, to
2396         catch any new documentation in the headers.
2398 2006-04-12  Damon Chaplin  <damon@gnome.org>
2400         * gtkdoc-mkdb.in (tagify2): strip special "-struct" suffix from
2401         text of links to widget structs.
2403 2006-04-09  Stefan Kost  <ensonic@users.sf.net>
2405         * TODO:
2406         fix link after live.gnome.org wiki changes
2408 === release 1.6 ===
2410 2006-04-09  Damon Chaplin  <damon@gnome.org>
2412         * Released 1.6.
2414 2006-03-29  Stefan Kost  <ensonic@users.sf.net>
2416         * gtkdoc-scangobj.in:
2417         missing '*' for arg in signal prototype in docs (#335486)
2419 2006-03-26  Damon Chaplin  <damon@gnome.org>
2421         * gtkdoc-mkdb.in (MergeSourceDocumentation): don't output warnings
2422         for overridden titles, since that happens a lot. (#320010)
2424         * configure.in: check for pkg-config >= 0.19.
2426         * Makefile.am (pkgconfigdir): put the .pc file in $(datadir) rather
2427         than $(libdir), since gtk-doc is architecture-independant. (#120950)
2429         * configure.in: removed the hard dependancy on openjade or jade, since
2430         XML is used mostly now rather than SGML. We just output a warning
2431         rather than an error if neither openjade or jade are found.
2433 2006-03-21  Stefan Kost  <ensonic@users.sf.net>
2435         * style.css:
2436         add sect1 to pages with top-page offset adjustment (#166363)
2438 2006-03-19  Damon Chaplin  <damon@gnome.org>
2440         * gtkdoc-scan.in (ScanHeader): try to handle the start of function
2441         declarations spread over 3 lines. (#321708, Jorn Baayen)
2443 2006-03-19  Damon Chaplin  <damon@gnome.org>
2445         (OutputOldParams): don't bother outputting unused parameters if they
2446         don't have any documentation as that is pointless.
2448 2006-03-19  Damon Chaplin  <damon@gnome.org>
2450         * gtkdoc-mktmpl.in (ReadTemplateFile): Add a workaround for an old
2451         bug handling macros with arguments spread over several lines. (#318666)
2453 2006-03-19  Damon Chaplin  <damon@gnome.org>
2455         * gtkdoc-mkdb.in (MakeIndexterms): Make sure we still output an index
2456         term if there isn't 'deprecated' or 'since' info.
2457         (#334851, Tommi Komulainen).
2459 2006-03-19  Damon Chaplin  <damon@gnome.org>
2461         * gtkdoc-scan.in (ScanHeader): added "--ignore-decorators" option to
2462         ignore a list of declarators in function declarations.
2463         (#316512, Bertram Felgenhauer).
2465 2006-03-19  Damon Chaplin  <damon@gnome.org>
2467         * gtkdoc-mkdb.in (GetSignals, GetArgs): call MakeIndexTerms() to make
2468         sure that signals appear in the deprecated/new symbol indices.
2469         (#332007, Tommi Komulainen).
2471 2006-03-19  Damon Chaplin  <damon@gnome.org>
2473         * gtkdoc-mkdb.in (OutputEnum, ExpandAbbreviations, symbolify):
2474         allow use of '#Object::signal' and '#Object:property' to link to
2475         signals and properties, and add links to enum constant values.
2476         (#332483, Stefan Kost)
2478 2006-03-15  Matthias Clasen  <mclasen@redhat.com>
2480         * gtkdoc-mkdb.in (MakeIndexterms): Create separate indexterms
2481         for different roles, since the docbook stylesheets don't handle
2482         multiple roles in one attribute.  (#331586, Tommi Komulainen)
2484 === release 1.5 ===
2486 2006-03-07  Damon Chaplin  <damon@gnome.org>
2488         * Released 1.5.
2490 2006-03-06  Tommi Komulainen  <tommi.komulainen@nokia.com>
2492         * gtkdoc-scan.in (ScanHeader): Print object name after <TITLE> in
2493         order to get get object hierarchy, signals and properties
2494         documentation appear automatically (#333380)
2496 2006-01-24  Stefan Kost  <ensonic@users.sf.net>
2498         * gtkdoc-mkdb.in: patch from Damon Chaplin to fix signal flag parsing
2500 2006-01-08  Damon Chaplin  <damon@gnome.org>
2502         * gtkdoc-mkdb.in: patch from Jonathan Blandford to add support for a
2503         "--source-suffixes" option so you can scan files with any suffixes
2504         you want (e.g. C++ files).
2506 2005-12-19  Matthias Clasen  <mclasen@redhat.com>
2508         * gtkdoc-mktmpl.in: Use \w+: instead of \S+: when
2509         matching parameter names, so that @Deprecated:2.10:
2510         works in template files like in source code comments.
2512         * gtkdoc-mkdb.in: Add a missing "and" to the versioned
2513         deprecation note.
2515 2005-12-09  Stefan Kost  <ensonic@users.sf.net>
2517         * devhelp.xsl:
2518           try more to downgrade devhelp for old file format
2520 2005-12-09  Stefan Kost  <ensonic@users.sf.net>
2522         * Makefile.am:
2523           add devhelp2 files
2524         * autogen.sh:
2525           create a autoregen.sh
2526         * devhelp.xsl:
2527         * devhelp2.xsl:
2528         * gtk-doc.xsl:
2529           generate two separate versions
2530         * gtkdoc-mkdb.in:
2531           fix parsing const after type (#322556)
2532         * gtkdoc-mktmpl.in:
2533           fix parseing multiline macro heads (#320588)
2534         * gtkdoc-scangobj.in:
2535           allow additional root types (#323581)
2537 2005-12-05  Matthias Clasen  <mclasen@redhat.com>
2539         * gtkdoc-mktmpl.in (OutputDeclaration):
2540         * gtkdoc-mkdb.in (OutputFunction): Allow parameters to be declared
2541         volatile (this happens in GLib nowadays)
2543 2005-10-11  Stefan Kost  <ensonic@users.sf.net>
2545         * gtkdoc-mkdb.in:
2546           remove left-over debug-print
2548 2005-10-10  Stefan Kost  <ensonic@users.sf.net>
2550         * devhelp.xsl:
2551         * gtkdoc-mkdb.in:
2552           enhance gtkdoc devhelp output (#318129)
2554 2005-10-05  Stefan Kost  <ensonic@users.sf.net>
2556         * gtkdoc-common.pl.in:
2557           revert exchanging &nbsp; with &#160;
2559 2005-10-04  Damon Chaplin  <damon@gnome.org>
2561         * gtkdoc-scanobj.in: patch from Andrae Steiner to add missing ';'
2562         (#317938)
2564 2005-09-29  Stefan Kost  <ensonic@users.sf.net>
2566         * TODO:
2567           additionally point people to the gnome-wiki
2569         * gtkdoc-mkdb.in:
2570           don't warn on macros with return docs (#314267)
2572 2005-09-28 Matthias Clasen <mclasen@redhat.com>
2574         Show signal flags:  (#316789)
2576         * gtkdoc-scangobj.in: Emit flags for signals
2577         as <FLAGS> element in $MODULE.signals
2579         * gtkdoc-mkdb.in: Emit signal flags similar
2580         to property flags.
2582         * gtkdoc-mktmpl.in: Handle <FLAGS> here, too.
2584 2005-09-20  Stefan Kost  <ensonic@users.sf.net>
2586         * doc/README:
2587         * doc/authors.txt:
2588         * doc/gnome.txt:
2589         * doc/sections-file.txt:
2590         * doc/setting-up.txt:
2591         * doc/style-guide.txt:
2592         * gtkdoc-common.pl.in:
2593           adding a note about where the new docs are
2595 2005-09-15  Damon Chaplin  <damon@gnome.org>
2597         * gtkdoc-scan.in (ScanHeader):
2598         * gtkdoc-mktmpl.in (OutputDeclaration):
2599         * gtkdoc-mkdb.in (OutputFunction): patch from dodji seketeli to handle
2600         functions returning explicit enums. (#303337)
2602         Patch from Stepan Kasal:
2604         * gtkdoc-mkhtml.in, gtkdoc-mkman.in, gtkdocize.in: Add datarootdir
2605         variable, for compatibility with future Autoconf releases.
2607         * configure.in (PACKAGE_DATA_DIR): Simplify the computation;
2608         use a local macro AC_DEFINE_DIR, based on a macro from Autoconf
2609         macro archive. (#313876)
2611 2005-09-15  Damon Chaplin  <damon@gnome.org>
2613         * gtkdoc-scangobj.in: Patch from Stepan Kasal to avoid some gcc
2614         warnings. (#312985)
2616         * gtkdoc-scanobj.in:
2617         * gtkdoc-scangobj.in: Use brackets around open() arguments to avoid
2618         precedence problems. (#314838)
2620         * gtkdoc-scanobj.in:
2621         * gtkdoc-scangobj.in: Output more messages about compilation, linking
2622         and running of scanner, to try to help track down any problems.
2623         Also use "sh -c" to run the scanner (#167688)
2625         * gtkdoc-scanobj.in:
2626         * gtkdoc-scangobj.in: patch from Stefan Kost to improve error messages,
2627         though I changed it slightly so it doesn't output errno.
2629 2005-09-09  Damon Chaplin  <damon@gnome.org>
2631         * gtkdoc-mkdb.in:
2632         * style.css:
2633         * gtk-doc.xsl: Use a fixed navigation bar at the top of the page.
2634         Patch from Stefan Kost with minor changes by me. (#313569)
2636 2005-08-18  Damon Chaplin  <damon@gnome.org>
2638         * gtkdoc-scangobj.in: added "const" in a few places to avoid lots
2639         of warnings if all gcc warnings are on. (#312985)
2641 2005-08-15  Stefan Kost  <ensonic@users.sf.net>
2643         * COPYING-DOCS:
2644         * Makefile.am:
2645         * configure.in:
2646         * omf.make:
2647         * xmldocs.make:
2648           adding the infrastructure for installation of gtkdoc manual
2650 2005-08-12  Stefan Kost  <ensonic@users.sf.net>
2652         * gtkdoc-mkdb.in:
2653         fix warning about uninitialized var EXPAND_CONTENT_FILES
2655 Tue Aug  9 12:01:27 2005  tjlocal  <timj@imendio.com>
2657         * autogen.sh: bail out with exit $? for failing programs.
2659 2005-07-26  Damon Chaplin  <damon@gnome.org>
2661         * gtk-doc.make: Pass DOC_MAIN_SGML_FILE as the main filename to
2662         gtkdoc-mkdb. Avoids creating spurious foo.sgml files in an XML build.
2663         Patch from Malcolm Tredinnick. (#311344)
2665         Prefix build messages with "gtk-doc: " rather than surrounding them
2666         with "***" which looks like an error. (#170008)
2668 2005-07-26  Damon Chaplin  <damon@gnome.org>
2670         * README: removed comment about not being able to add section
2671         documentation to source code files, which is not true any more.
2673 === release 1.4 ===
2675 2005-07-03  Damon Chaplin  <damon@gnome.org>
2677         * Released 1.4.
2679 2005-06-20  Matthias Clasen  <mclasen@redhat.com>
2681         * gtkdoc-mkdb.in: Fix typos in warnings.
2683 2005-06-17  Mikael Hallendal  <micke@imendio.com>
2685         * README: Updated Devhelp web address.
2687 2005-05-16  Matthias Clasen  <mclasen@redhat.com>
2689         * gtkdoc-mkdb.in: Add "expand-content-files:s" to the GetOptions() call.
2691 2005-05-10  Owen Taylor  <otaylor@redhat.com>
2693         * gtkdoc-mkdb.in: Add an --expand-content-files option
2694         to specify extra files to expand abbreviations in and
2695         copy into the output directory.
2697         * gtk-doc.make examples/Makefile.am: Add expand_content_files
2698         variable.
2700         * gtkdoc-mktmpl.in (OutputTemplateFile): Add an
2701         --only-section-tmpl flag so that projects that keep everything
2702         but section descriptions inline can avoid cvs conflicts.
2704         * gtk-doc.make examples/Makefile.am: Add support for
2705         MKTMPL_OPTIONS
2707         * configure.in: Up version to 1.4.
2709 2005-05-02  Matthias Clasen <mclasen@redhat.com>
2711         * gtkdoc-mkdb.in: Accept C comments between struct name
2712         and struct definition. GObject has an instance of this.
2714 2005-03-21  Matthias Clasen <mclasen@redhat.com>
2716         * gtk-doc.dcl: Allow ':' in names. (#169087)
2718 2005-03-21  James Henstridge  <james@jamesh.id.au>
2720         * gtk-doc.xsl (encoding): output US-ASCII instead of ISO-8859-1.
2721         This ensures that the output will be display correctly when served
2722         as either ISO-8859-1 or UTF-8.
2724 2005-02-26  Sven Neumann  <sven@gimp.org>
2726         * gtkdoc-mkdb.in (MakeIndexterms): allow space in Since: keywords,
2727         only strip leading and trailing whitespace (bug #168384).
2729 2005-02-16  Damon Chaplin  <damon@gnome.org>
2731         * gtkdoc-mkdb.in (ScanSourceFile): add support for "@stability:"
2732         in the inline section docs (Brian Cameron).
2734 2005-02-07  Damon Chaplin  <damon@gnome.org>
2736         * gtkdoc-mkdb.in (MergeSourceDocumentation): allow use of "@...:" in
2737         the source code as well as "@Varargs:". Patch from Benjamin Otte.
2738         #166366.
2740 2005-02-04  Damon Chaplin  <damon@gnome.org>
2742         * gtkdoc-mkdb.in (ParseStabilityLevel): don't reset $stability if it
2743         isn't Stable/Unstable/Private (Brian Cameron).
2744         (ScanSourceFile): skip whitespace after "SECTION:".
2746 2005-02-01  Damon Chaplin  <damon@gnome.org>
2748         * gtkdoc-mkdb.in (ScanSourceFile, MergeSourceDocumentation): patch
2749         from Stefan Kost to support section documentation within the source
2750         code (long description, short description, see also and title).
2752         * gtkdoc-mkdb.in:
2753         * gtkdoc-mktmpl.in: patch from Brian Cameron to support stability
2754         levels.
2756         * gtkdoc-mkdb.in (OutputFunction):
2757         * gtkdoc-mktmpl.in (OutputDeclaration):
2758         * gtkdoc-common.pl.in (ParseStructDeclaration): patch from Roger Leigh
2759         to add support for the "restrict" keyword.
2761         * gtkdoc-scan.in (ScanHeader): patch from Roger Leigh to add support
2762         for "unsigned" to one of the regexps.
2764 2005-01-31  Damon Chaplin  <damon@gnome.org>
2766         * gtk-doc.make (scan-build.stamp): added "2>&1" to grep command to
2767         ignore any errors.
2769         * gtkdoc-mkdb.in: patch from Stefan Kost to not add '<' '>' around
2770         include files that already have '"' '"' around them, and to try to
2771         gather more information about undocumented symbols. #164462.
2773 2005-01-28  Damon Chaplin  <damon@gnome.org>
2775         * gtk-doc.make: use dist-hook rather than EXTRA_DIST to copy the
2776         $(DOC_MODULE).types file over, so we can skip this if it doesn't exist.
2777         #156300.
2779 2005-01-12  Damon Chaplin  <damon@gnome.org>
2781         * README: patch from Stefan Kost to mention GObject classes
2782         and describe the transformation process to XML/SGML and HTML,
2783         and to mention Devhelp.
2785 === release 1.3 ===
2787 2005-01-09  Damon Chaplin  <damon@gnome.org>
2789         * Released 1.3.
2791 2005-01-09  Damon Chaplin  <damon@gnome.org>
2793         * gtkdoc-mkdb.in (MergeSourceDocumentation): output better warnings
2794         using the type information. Patch from Stefan Kost. #161979
2796         * gtkdoc-scan.in (ScanHeader): support "typedef struct a *b;". Fixes
2797         last part of #156318.
2799         * gtkdoc-common.pl.in (ParseStructDeclaration): return an empty array
2800         for forward struct declarations. Part of #156318.
2802         * gtkdoc-mktmpl.in:
2803         * gtkdoc-mkdb.in: updated a few of the warnings to make them a bit
2804         easier to understand.
2806 2004-11-22  James Henstridge  <james@jamesh.id.au>
2808         * acconfig.h: remove file, since we don't have a config.h
2810         * configure.in: make sure $ACLOCAL_FLAGS is passed to aclocal on a
2811         rebuild.
2813         * autogen.sh: use Automake-1.9 if available, and call aclocal,
2814         autoconf, automake, etc in the same order as autoreconf does.
2816         * gtkdocize.in: if the AC_CONFIG_MACRO_DIR option is used in the
2817         configure script, copy gtk-doc.m4 to that directory in the source
2818         tree.
2820 2004-11-16  Damon Chaplin  <damon@gnome.org>
2822         * gtkdoc-mkdb.in (OutputFunction): output "const" rather than
2823         "G_CONST_RETURN". #157674.
2825         * gtkdoc-mktmpl.in (OutputDeclaration): skip "void" return types but
2826         not if it has modifiers e.g. "void *". #156963.
2828         * gtkdoc-scan.in (ScanHeader): handle __attribute__. Patch from
2829         Simon Josefsson. #156962.
2831 2004-10-31  Damon Chaplin  <damon@gnome.org>
2833         * gtkdoc-mkdb.in (OutputStruct): handle opaque/forward struct
2834         declarations. #156318 again. Tiny fix to avoid warnings.
2836 2004-10-28  Damon Chaplin  <damon@gnome.org>
2838         * gtkdoc-mktmpl.in (ReadDeclarationsFile):
2839         * gtkdoc-mkdb.in (ReadDeclarationsFile):
2840         * gtkdoc-scan.in (ScanHeader): handle opaque/forward struct
2841         declarations. #156318.
2843 2004-10-25  Damon Chaplin  <damon@gnome.org>
2845         * gtkdoc-mkdb.in (OutputParamDescriptions): use a &nbsp; after Returns:
2846         so it doesn't break before the colon.
2848 2004-10-24  Damon Chaplin  <damon@gnome.org>
2850         * gtkdoc-common.pl (ParseEnumDeclaration): handle "typedef enum XXX {"
2851         #156297. Patch from Simon Josefsson.
2853 2004-10-20  Damon Chaplin  <damon@gnome.org>
2855         * gtkdoc-mkdb.in (ReadDeclarationsFile): set a flag to indicate a
2856         struct has a typedef declaration.
2857         (OutputStruct): better output for structs with typedefs. #83269.
2859         * gtkdoc-scan.in (ScanHeader): leave the struct declaration as it is.
2860         Don't strip out 'typedef'. Also allow simple "struct foo {".
2862 2004-10-19  Damon Chaplin  <damon@gnome.org>
2864         * gtkdoc-fixxref.in: use pkg-config to find where GLib is installed
2865         and scan that directory for index files. Also scan $GNOME2_PATH.
2866         These are only used as a last resort. If they are used we have to
2867         output links as absolute URLs, rather than the default relative ones.
2869 2004-10-18  Damon Chaplin  <damon@gnome.org>
2871         * gtkdoc-common.pl.in (ParseStructDeclaration): support function
2872         pointers that return "foo const *" #141870.
2874         * gtkdoc-scan.in (ScanHeader):
2875         * gtkdoc-mkdb.in (OutputFunction):
2876         * gtkdoc-mktmpl.in (OutputDeclaration): handle functions with const
2877         or struct return types. #141870 and #148507.
2879 2004-10-15  Damon Chaplin  <damon@gnome.org>
2881         * gtkdoc-common.pl.in (ParseStructDeclaration)
2882         (ParseEnumDeclaration): moved these here, rather than have 2 copies
2883         in gtkdoc-mkdb.in and gtkdoc-mktmpl.in.
2885         * gtkdoc-common.pl.in (ParseStructDeclaration): handle struct fields
2886         better. We can now handle things like *foo, ***bar, *baz[12][23],
2887         foo : 25 all on one line. Fixes part of #151219.
2888         Also support the 'short' modifier to fix #90565.
2889         And use $nbsp; rather than spaces to try to avoid splitting
2890         declarations in the output.
2891         Also take an extra arg specifying whether to include parameters in
2892         the function pointer fields.
2894         * gtkdoc-scan.in (ScanHeader): Deal with array types in typedefs.
2895         (Eg, "typedef unsigned char MD5Digest[16];") From Dan Winship.
2896         Last bit of #151219.
2898 2004-10-14  Damon Chaplin  <damon@gnome.org>
2900         * gtkdoc-mkdb.in (CreateValidSGMLID): use ":CAPS" rather than
2901         "-CAPS" to distinguish all-caps identifiers, to avoid clashing with
2902         identifiers ending in _caps! Bug #113120.
2904         * gtkdoc-mkdb.in (MergeSourceDocumentation): if it looks like a
2905         parameter has been described, but not in the right place, output
2906         a better error message. Bug #141871.
2908         * gtkdoc-mkdb.in (OutputMacro, OutputFunction, GetSignals): allow
2909         the author to use <!--PARAMETERS--> to specify the position of the
2910         parameter table if they want. Hopefully good enough for bug #99567.
2911         (MergeSourceDocumentation): end the paragraph before <!--PARAMETERS-->
2912         and start a new one after it.
2914         * doc/authors.txt: document <!--PARAMETERS-->.
2916         * style.css: don't underline links normally, as we output lots of
2917         them and it makes it very cluttered. Only underline links when the
2918         mouse hovers over them, and change the color. Fixes #108037.
2920         * gtk-doc.make (scan-build.stamp): depend on $(CFILE_GLOB) as well,
2921         since changes in properties need to be picked up by gtkdoc-scangobj.
2922         Bug #52458.
2924         * gtkdoc-mkdb.in: (ParseStructDeclaration): for fields that are
2925         function pointers, only return the function name, as otherwise the
2926         output gets really messy. Fixes #66618.
2928         * gtkdoc-mktmpl.in:
2929         * gtkdoc-mkdb.in:
2930         * gtkdoc-scan.in:
2931         * gtkdoc-scanobj.in:
2932         * gtkdoc-scangobj.in: use '@PACKAGE_DATA_DIR@' instead of
2933         "@PACKAGE_DATA_DIR@" so that it isn't interpolated. It failed when
2934         $prefix was /software/@sys/usr. Fixes #113456.
2936 2004-10-13  Damon Chaplin  <damon@gnome.org>
2938         * gtkdoc-scanobj.in:
2939         * gtkdoc-scangobj.in: patch from Olexiy Avramchenko to add 3 new
2940         GdkEvent subtypes.
2942         * gtkdoc-scanobj.in:
2943         * gtkdoc-scangobj.in: patch from Benjamin Otte to get rid of
2944         -Wsign-compare warnings. Bug #137013.
2946 Fri Sep 17 01:13:24 2004  Matthias Clasen  <maclas@gmx.de>
2948         * gtk-doc.xsl: Add the images from the gallery on top
2949         of the refentry they point to.
2951         * style.css: Move the css bits of the gallery implementation
2952         here.
2954 Fri Sep 17 00:30:16 2004  Matthias Clasen  <maclas@gmx.de>
2956         * gtk-doc.xsl: Don't generate <link rel="refentry">
2957         links, since e.g. the GTK+ docs contain MANY refentries.
2959 2004-09-10  Damon Chaplin  <damon@gnome.org>
2961         * autogen.sh: support automake 1.8. (part of #151219).
2963         * examples/Makefile.am: require automake 1.6.
2965         * gtkdoc-scan.in: create an empty MODULE-overrides.txt file if it
2966         doesn't exist. gtkdoc.make expects one to exist.
2968         * doc/setting-up.txt: updated to document new procedure using
2969         gtkdoc.make.
2971         * examples/Makefile.am: updated to use gtkdoc.make.
2973         * examples/configure.in: removed this. gtkdoc.make is used instead
2974         now.
2976         * examples/README: updated.
2978         * Makefile.am (EXTRA_DIST): removed examples/configure.in.
2980 Wed Sep  8 01:12:25 2004  Matthias Clasen  <maclas@gmx.de>
2982         * gtkdoc-scan.in (ScanHeader):
2983         * gtkdoc-mktmpl.in (OutputDeclaration):
2984         * gtkdoc-mkdb.in (OutputFunction): Accept mixtures of *
2985         and const in return types.
2987 Wed Sep 01 05:58:08 2004  Matthias Clasen  <maclas@gmx.de>
2989         * gtkdoc-mkdb.in: Remove a debug printf
2991 Tue Aug 24 02:30:08 2004  Matthias Clasen  <maclas@gmx.de>
2993         * gtk-doc.xsl: Add support for a gallery of widget images.
2995 Wed Jul 28 13:00:54 2004  Jonathan Blandford  <jrb@gnome.org>
2997         * gtk-doc.xsl: remove the examples from the toc.
2999 2004-07-28  Damon Chaplin  <damon@gnome.org>
3001         * doc/sections-file.txt: mention use of '#' for comments.
3003         * gtkdoc-mkdb.in: removed HEADER_FILE stuff, since it isn't used now.
3005 2004-07-23  Damon Chaplin  <damon@gnome.org>
3007         * examples/Makefile.am (all-local): add empty all-local target for
3008         when ENABLE_GTK_DOC is false. (#148209, Martin Quinson)
3010 Fri Jul 23 13:21:34 2004  Matthias Clasen  <maclas@gmx.de>
3012         * gtkdoc-mkdb.in (ScanSourceFile): Fix regexps for matching
3013         ignored files.  (#148211, Martin Quinson)
3015 2004-07-03  Matthias Clasen  <mclasen@redhat.com>
3017         * style.css: Add a missing '}' and align arguments to the
3018         top of their descriptions.  (#145363, #145364, Mariano
3019         Su�rez-Alvarez)
3021 2004-05-18  Matthias Clasen  <mclasen@redhat.com>
3023         * gtk-doc.xsl: Let the docbook stylesheets generate
3024         extra <link rel=...> elements.  (#140221, Geert Stappers)
3026 2004-05-10  Geert Stappers  <stappers@stappers.nl>
3028         * TODO: new file, basicly a reference to bugzilla.
3030         * examples/README: tell about gtk-doc.make.
3032 2004-05-06  Geert Stappers  <stappers@stappers.nl>
3034         * MAINTAINERS: Add myself.
3036 2004-05-05  Matthias Clasen  <mclasen@redhat.com>
3038         * gtk-doc.xsl: Correct the docbook stylesheet version
3039         in which filtered index support will appear to 1.66.
3041 2004-04-27  Geert Stappers  <stappers@stappers.nl>
3043         * README: Updated the information on Debian packages.
3044         Removed old author and time stamp line.
3046 2004-04-21  Matthias Clasen  <mclasen@redhat.com>
3048         * doc/sections-file.txt: Add hint about private types.
3050         * README: Update.
3052         * MAINTAINERS: Add myself.
3054         * gtkdoc-mkdb.in (ReadKnownSymbols): New function which
3055         extracts information about public and private symbols from
3056         the $MODULE-sections.txt file.
3057         (ReadObjectHierarchy): Prune the tree, based on the information
3058         collected by ReadKnownSymbols.
3059         (ReadInterfaces): Also filter out private interfaces here
3060         (ReadPrerequisites): ...and here.
3062 2004-04-19  Matthias Clasen  <mclasen@redhat.com>
3064         * Makefile.am: Add version-greater-or-equal.xsl.
3066         * version-greater-or-equal.xsl: New file, implementing
3067         the version-greater-or-equal template for comparing version
3068         numbers.
3070         * gtk-doc.xsl: Import version-greater-or-equal.xsl and
3071         use the version-greater-or-equal template to a) check that
3072         the xsl stylesheets are not too old and b) to avoid creating
3073         multiple indices if the xsl stylesheets don't support filtered
3074         indices.  (#107774)
3076         * gtkdoc-mkdb.in (MakeIndexterms): Emit role attributes
3077         on indexterms which can be used to create filtered indices
3078         with sufficiently new xsl stylesheets. The required functionality
3079         will appear in version 1.62 of the xsl stylesheets.  (#115530)
3081 2004-04-16  Matthias Clasen  <mclasen@redhat.com>
3083         * style.css: Style information in a separate stylesheet.
3085         * gtkdoc-mkhtml.in: Copy css files.
3087         * Makefile.am (gtkdocdata_DATA): Add style.css
3089         * gtk-doc.xsl: Use a stylesheet instead of hardwiring
3090         styles.  (#134683, Vincent Torri)
3092         * gtkdoc-mkdb.in (GetSignals): Organize the properties
3093         descriptions to fit better with the other sections, and
3094         also display information about allowed and default values.
3096 2004-04-15  Matthias Clasen  <mclasen@redhat.com>
3098         * gtkdoc-scangobj.in: Use introspection more fully to emit
3099         allowed ranges for integral types and default values.
3101         * gtkdoc-mkdb.in (GetSignals): Handle missing signal parameter
3102         names better.
3104 2004-03-04  Damon Chaplin  <damon@gnome.org>
3106         * autogen.sh: fixed URLs to download autoconf/automake/libtool.
3107         Patch from Frederic L. W. Meunier.
3109 2004-02-16  Damon Chaplin  <damon@gnome.org>
3111         * .cvsignore: added gtk-doc.cat and gtkdocize.
3113 === release 1.2 ===
3115 2004-02-16  Damon Chaplin  <damon@gnome.org>
3117         * Released 1.2.
3119 2004-02-16  Damon Chaplin  <damon@gnome.org>
3121         * gtk-doc.cat.in: removed public ID for gtk-doc.dtd, since we don't
3122         use it any more.
3124 Sat Feb 14 02:14:27 2004  Matthias Clasen  <maclas@gmx.de>
3126         * gtk-doc.m4: Avoid unnecessary checks if gtk-doc is
3127         disabled.  (#134221, Julio M. Merino Vidal)
3129 Sat Feb 14 02:03:01 2004  Matthias Clasen  <maclas@gmx.de>
3131         * gtk-doc.make: Don't create unneeded empty
3132         directories.  (#134319, Julio M. Merino Vidal)
3134 Sat Feb 14 01:37:38 2004  Matthias Clasen  <maclas@gmx.de>
3136         * gtk-doc.make: Add an empty all-local target to make it work
3137         with non-GNU make.  (#134343, Julio M. Merino Vidal)
3139 Wed Jan 28 00:52:00 2004  Matthias Clasen  <maclas@gmx.de>
3141         * gtkdoc-mkdb.in (OutputObjectList): Avoid emitting invalid
3142         docbook markup if there are no objects. Partial fix for #132661.
3144 Sun Jan 25 22:01:15 2004  Matthias Clasen  <maclas@gmx.de>
3146         * gtkdoc-mkdb.in: Accept both the old and the new XInclude
3147         namespace.  (#131675, Edd Dumbill)
3149 2004-01-23  Thomas Vander Stichele  <thomas at apestaart dot org>
3151         * gtkdoc-mkhtml.in: exit when tools return non-zero so errors can
3152           be caught.
3154 Thu Jan 15 23:06:10 2004  Matthias Clasen  <maclas@gmx.de>
3156         * gtk-doc.xsl: Set the chunk.fast parameter, to gain some
3157         speed.
3159 Thu Jan 15 23:05:23 2004  Matthias Clasen  <maclas@gmx.de>
3161         * gtkdoc-fixxref.in: Make it work again without explicit
3162         --module.
3164 Sat Dec 27 01:36:08 2003  Matthias Clasen  <maclas@gmx.de>
3166         * gtkdoc-scangobj.in:
3167         * gtkdoc-mktmpl.in:
3168         * gtkdoc-scan.in:
3169         * gtkdoc-fixxref.in: Add --help.  (#126915)
3171 Sat Dec 27 00:43:42 2003  Matthias Clasen  <maclas@gmx.de>
3173         * gtkdoc-mkdb.in (ParseEnumDeclaration):
3174         * gtkdoc-mktmpl.in (ParseEnumDeclaration): Support a trailing ,
3175         in enum declarations. These are a GNU C extension, but also
3176         blessed by C99.  (#129949, Thomas Vander Stichele)
3178 Sun Nov 16 00:29:03 2003  Matthias Clasen  <maclas@gmx.de>
3180         * gtkdoc-scangobj.in: Don't use g_strdown(). (#127028,
3181         David Schleef)
3183 Sun Nov 16 00:26:05 2003  Matthias Clasen  <maclas@gmx.de>
3185         * gtkdoc-scangobj.in: If compiled against GLib >= 2.3.0, look
3186         for properties on interfaces.  (#127068, James M. Cape)
3188 2003-11-03  Dan Winship  <danw@ximian.com>
3190         * gtkdoc-scangobj.in: Clean up $MODULE-scan.o even when using
3191         libtool
3193         * gtkdoc-scanobj.in: Likewise
3195         * gtk-doc.make (CLEANFILES): Remove $(MODULE)-scan.o from here
3196         (clean-local): rm -rf .libs
3198 Wed Oct  8 01:21:54 2003  Matthias Clasen  <maclas@gmx.de>
3200         * gtkdoc-scan.in (ScanHeader): Make gtkdoc-scan grok
3201         typedef struct { } foo; in addition to the more baroque
3202         typedef struct _foo foo; struct _foo { };
3203         (#116807, Malcolm Tredinnick)
3205 Wed Oct  8 01:21:35 2003  Matthias Clasen  <maclas@gmx.de>
3207         * gtkdoc-mkdb.in (OutputParamDescriptions): Remove a pointless
3208         warning.
3210 2003-10-01  Matthias Clasen  <maclas@gmx.de>
3212         Make signals and properties end up in the right template
3213         file (#116569, Owen Taylor):
3215         * gtkdoc-mktmpl.in (OutputSignalTemplates):
3216         (OutputArgTemplates): Return a string rather than directly
3217         writing to OUTPUT.
3218         (OutputTemplateFile): Don't interpret $title as the name of
3219         the object to print signal and property templates for.
3220         (UpdateTemplates): Collect signal and property templates for all
3221         objects contained in the section.
3223 2003-08-10  James Henstridge  <james@daa.com.au>
3225         * acinclude.m4 (JH_PATH_XML_CATALOG): allow caller to specify
3226         actions if found or not found.
3227         (JH_CHECK_XML_CATALOG): when requiring JH_PATH_XML_CATALOG, don't
3228         error out if it is not found.
3230 2003-08-03  Matthias Clasen  <maclas@gmx.de>
3232         * doc/gnome.txt: Add some hints regarding markup of examples.
3234 2003-07-22  Matthias Clasen  <maclas@gmx.de>
3236         * configure.in:
3237         * gtk-doc.cat: Fix a problem with the previous commit.
3239 2003-07-21  Matthias Clasen  <maclas@gmx.de>
3241         Applied patches from Sebastian Rittau to add maintainer mode and an SGML catalog.  (#117955, #117956)
3243         * gtk-doc.cat.in: New catalog file.
3244         * configure.in: Added gtk-doc.catalog to output files.
3245         * Makefile.am: Install gtk-doc.catalog.
3247         * configure.in: Added AM_MAINTAINER_MODE.
3248         * autogen.sh: Added --enable-maintainer-mode to configure options.
3250 2003-07-09  Matthias Clasen  <maclas@gmx.de>
3252         * gtkdoc-mktmpl.in (ParseStructDeclaration):
3253         * gtkdoc-mkdb.in (ParseStructDeclaration): Accept volatile struct members, which have just
3254         made their appearance in glib.
3256 2003-06-29  Matthias Clasen  <maclas@gmx.de>
3258         * gtkdoc-mkdb.in (ExpandAbbreviations): When expanding @param, catch the common @param->field
3259         and @param.field, to reduce the need for littering the C sources with <literal>foo->bar</literal>.
3261 2003-06-25  Matthias Clasen  <maclas@gmx.de>
3263         Changes for #115528:
3265         * gtkdoc-mkdb.in (OutputSGML): Collect hierarchy, interfaces, implementations, prerequisites
3266         and derived interfaces separately.
3267         (OutputSGMLFile): Take two more arguments: implementations and derived interfaces.
3268         (GetHierarchy): Also put immediate children in the local tree.
3269         (GetInterfaces): Split into GetInterfaces and GetImplementations.
3270         (GetImplementations): New function to get the implementations of an interface.
3271         (GetDerived): New function to get the known derived interfaces of an interface.
3273         * gtkdoc-mkdb.in (MakeXRef): Accept a second, optional parameter for the
3274         text of the link.
3275         (ExpandAbbreviations): Add semantic markup inside the links, so that
3276         non-crossreferenced symbols come out properly formatted after link
3277         removal.  (#61345)
3279 2003-06-15  Matthias Clasen  <maclas@gmx.de>
3281         Support for a flat index of all symbols.  (#92861)
3282         To use, put an empty <index/> element in your driver document.
3284         * gtkdoc-mkdb.in (MakeIndexterms): New function, emits an indexterm.
3285         (OutputMacro, OutputTypedef, OutputStruct, OutputEnum,
3286         OutputUnion, OutputVariable, OutputFunction): Use MakeIndexterms.
3287         to emit indexterms for symbols.
3289         * gtkdoc-mkdb.in (GetSignals):
3290         (GetArgs): Emit Since: information for signals and properties.
3292 Thu Jun 12 15:55:57 2003  Owen Taylor  <otaylor@redhat.com>
3294         * gtkdoc-mkhtml.in (declaration): Replace head -1 with -n 1.
3295         (Merge change by Elliot Lee from Red Hat package)
3297 2003-06-11  Matthias Clasen  <maclas@gmx.de>
3299         * doc/gnome.txt: Updates to the documentation of inline comments.
3301 2003-06-03  Matthias Clasen  <maclas@gmx.de>
3303         * gtk-doc.spec.in: Add a missing Provides: and include the .pc file.
3304         (#106568, Joe Pranevich)
3306 2003-05-27  Matthias Clasen  <maclas@gmx.de>
3308         * gtkdoc-mkdb.in (GetSignals):
3309         (GetArgs): Add signals and properties to the statistics.
3310         (OutputMissingDocumentation): Emit undocumented signals and
3311         properties.  (#113645)
3313 2003-04-21  Matthias Clasen  <maclas@gmx.de>
3315         * tools/docpercentages.pl: Fix autolinkification for undocumented
3316         symbols.
3318         * doc/style-guide.txt: Typo fix.
3320 === release 1.1 ===
3322 2003-04-18  James Henstridge  <james@daa.com.au>
3324         * Released 1.1.
3326 2003-04-18  James Henstridge  <james@daa.com.au>
3328         * NEWS: add news items.
3330         * configure.in: increment version number.
3332 2003-03-14  Matthias Clasen  <maclas@gmx.de>
3334         * gtkdoc-mkdb.in (OutputBook): Fix the public identifier for
3335         DocBook V3.0: Davenport, not DavenPort.
3336         (#108343, Mariano Suarez-Alvarez)
3338 2003-03-10  James Henstridge  <james@daa.com.au>
3340         * configure.in: associate the chmod commands with the files they
3341         are chmod'ing.  This way config.status will always run the correct
3342         chmod command.
3344 2003-03-04  James Henstridge  <james@daa.com.au>
3346         * configure.in: look up the docbook DTD by public id rather than
3347         system id.
3349 2003-02-26  Matthias Clasen  <maclas@gmx.de>
3351         * gtkdoc-mkdb.in (GetArgs): Prefer template or comment docs over
3352         blurbs only if they're nonempty, otherwise the empty docs from the
3353         templates override all the blurbs.
3355 2003-02-26  James Henstridge  <james@daa.com.au>
3357         * autogen.sh (THEDIR): set up so that it will choose automake 1.7
3358         or 1.6 in preference to 1.4.  Passes distcheck okay.
3360         * configure.in: update configure.in script to match
3361         recommendations of newer autoconf's, and add an AC_PREREQ()
3362         statement, since the xml catalog checks are using new autoconf
3363         features.
3365         * gtk-doc.make (xml-build.stamp): since other bits of the makefile
3366         were assuming xml, may as well hard code --output-format=xml.
3368 2003-02-19  James Henstridge  <james@daa.com.au>
3370         * Makefile.am: get rid of the dist-hook, and just include the
3371         given files in EXTRA_DIST instead.
3373         * configure.in: provide meaningful names for the commands.
3375         * acinclude.m4 (JH_CHECK_XML_CATALOG): add some extra arguments: a
3376         friendly name for the catalog entry, and actions to run if the
3377         entry was found or not.  Also include a bit more information in
3378         the config.log file if an error occurs.
3380 2003-02-18  Matthias Clasen  <maclas@gmx.de>
3382         * gtkdoc-mkhtml.in (declaration): Avoid the unportable grep
3383         option -q.  (#105311)
3385 2003-02-19  James Henstridge  <james@daa.com.au>
3387         * devhelp.xsl: put chapters that aren't at the top level into the
3388         toc tree (to make gtk's .devhelp tree look better).
3390         * gtk-doc.spec.in (Requires): make the requires lines match
3391         current requirements ...
3393         * gtkdoc-mkhtml.in (XSLTPROC): pass --nonet to xsltproc, so we
3394         don't try to download DTDs and XSLT over the net.  The configure
3395         checks should catch people who don't have the correct files in
3396         their catalog.
3398 2003-02-17  James Henstridge  <james@daa.com.au>
3400         * gtkdocize.in (--version): add --version argument.
3402 2003-02-14  James Henstridge  <james@daa.com.au>
3404         * gtkdoc-mkdb.in (GetOptions): actually accept --tmpl-dir as a
3405         command line option.  Based on a patch from Simon Josefsson
3406         <jas@extundo.com>.
3408         * gtk-doc.xsl: remove the xmlns declaration.  Not really needed
3409         for html output anyway ...
3411 2003-02-13  James Henstridge  <james@daa.com.au>
3413         * devhelp.xsl: remove refsect1's and refsect2's from book tree, as
3414         suggested by Hallski.
3416         * gtk-doc.make (install-data-local): the change to install images
3417         was superfluous, so I have removed it.
3418         (CLEANFILES): move some more stuff to CLEANFILES from the
3419         distclean-local rule.
3421 2003-02-12  James Henstridge  <james@daa.com.au>
3423         * gtk-doc.make: add some chmod calls to work arround distcheck on
3424         automake >= 1.6.
3425         (install-data-local): copy the images as well as the html files
3426         during install.
3427         (uninstall-local): add an uninstall rule to remove the docs.
3428         (CLEANFILES): add $(DOC_MODULE)-scan.o to the list of files to be
3429         cleaned up.
3431 2003-02-09  James Henstridge  <james@daa.com.au>
3433         * gtkdocize.in: script used to copy gtk-doc.make into another
3434         module.
3436         * gtk-doc.make: automake makefile fragment to handle gtk-doc
3437         support in other modules.
3439         * configure.in: check to make sure DocBook XML DTD and XSLT
3440         stylesheets are present in the XML catalog.
3442         * acinclude.m4 (JH_CHECK_XML_CATALOG): new macro to check for
3443         entries in the XML catalog.
3445 2003-02-04  James Henstridge  <james@daa.com.au>
3447         * gtk-doc.m4: a macro to check for gtk-doc.
3449         * Makefile.am (gtkdocdata_DATA): don't bother installing xml.dcl.
3450         It isn't used anymore (since switching xml mode to xsltproc).
3452         * gtkdoc-mkhtml.in (gtkdocdir): and here.
3454         * Makefile.am (gtkdocdatadir): change dir.
3456         * configure.in: put data files in $(datadir)/gtk-doc/data, so that
3457         they don't all get mixed up with the html docs installed by other
3458         packages.
3460 === release 1.0 ===
3462 2003-01-20  Damon Chaplin  <damon@gnome.org>
3464         * Released 1.0.
3466 2003-01-20  Damon Chaplin  <damon@gnome.org>
3468         * configure.in: bumped version to 1.0, and added SGML_OUTPUT_TYPE
3469         variable, which we set to 'sgml-raw' if we have openjade, or 'sgml'
3470         if we have jade. Added gtk-doc.pc to AC_OUTPUT.
3472         * gtkdoc-mkhtml.in: used SGML_OUTPUT_TYPE variable to set the output
3473         type of jade/openjade.
3475         * gtk-doc.pc.in: new pkg-config file, which apps can use to reliably
3476         check the gtk-doc version in future.
3478         * Makefile.am (pkgconfigdir): install .pc file, and add it to
3479         EXTRA_DIST.
3481         * examples/configure.in: updated example to use pkg-config for the
3482         version check.
3484 2003-01-18  James Henstridge  <james@daa.com.au>
3486         * gtkdoc-mkhtml.in (declaration): switch the output type from
3487         "sgml" to "sgml-raw" when using Jade to process docs.  This gets
3488         rid of the line breaks inside the tags, which were confusing Lynx.
3490 2003-01-15  Matthias Clasen  <maclas@gmx.de>
3492         * gtkdoc-scan.in (ScanHeader): Remove special cases for Pango and
3493         Bonobo.
3494         * gtkdoc-mkdb.in (OutputDeclaration):
3495         * gtkdoc-mktmpl.in (OutputDeclaration): Remove special cases for
3496         structs named BlablaClass.  (#95398)
3498         * gtkdoc-mkdb.in (GetInterfaces): Fix an off-by-one error.
3499         (#103466, Josh Parsons)
3501 2002-12-28 Chema Celorio <chema@celorio.com>
3503         * gtkdoc-scan[g]obj.in: add "void" to functions with no parameters,
3504         avoids warning with -Wmissing-prototypes when compiling
3505         {module}-scan.c
3507 2002-12-16  James Henstridge  <james@daa.com.au>
3509         * gtk-doc.spec.in: require perl >= 5.6.0
3511         * configure.in: require Perl >= 5.6.0
3513         * gtkdoc-fixxref.in: add "use bytes;" to fix malformed UTF-8
3514         character errors when run with a UTF-8 locale.
3516 2002-12-16  Matthias Clasen  <maclas@gmx.de>
3518         * gtkdoc-mkdb.in (OutputSGMLFile): Don't emit the additional
3519         anchors in the title which breaks the generated html (the title
3520         text is copied around). Instead, put the anchors before the
3521         synopsis. This isn't perfect, but the best we can achieve without
3522         stylesheet hackery.
3524 2002-12-13  Matthias Clasen  <maclas@gmx.de>
3526         * gtkdoc-mkdb.in: Add an --ignore-files option which can be used
3527         to omit files or directories from scanning.
3528         (OutputSGMLFile): Emit anchors for all objects contained in the
3529         file to avoid dangling links.
3530         (OutputMissingDocumentation): Emit deprecated symbols after
3531         undeprecated ones.
3533 2002-12-12  Matthias Clasen  <maclas@gmx.de>
3535         * gtkdoc-scan.in (ScanHeader): Also recognize "positive" guards
3536         like #ifdef GTK_ENABLE_BROKEN.
3538 2002-12-11  Matthias Clasen  <maclas@gmx.de>
3540         * gtk-doc.xsl: Change XPath path to "//anchor|//refentry" for the
3541         generation of index.sgml. The previous path "//anchor|refentry"
3542         was not matching any refentrys.
3544 2002-12-09  Matthias Clasen  <maclas@gmx.de>
3546         * gtkdoc-mktmpl.in (UpdateTemplates): Emit unused class structs
3547         to $MODULE-unused.txt.
3549 2002-12-08  Matthias Clasen  <maclas@gmx.de>
3551         * gtkdoc-mkdb.in (OutputStruct): Don't emit private parts
3552         of class structs to parameter lists in docs. Remove leftover
3553         debugging output.
3555         * gtkdoc-mktmpl.in (OutputDeclaration): Don't emit private parts
3556         of class structs to parameter lists in templates.
3558 2002-12-06  Matthias Clasen  <maclas@gmx.de>
3560         Improved /*< private >*/ handling:  (#95398)
3562         * gtkdoc-mkdb.in (OutputStruct): Handle /*< public >*/ and
3563         /*< private >*/ for all structs. Default to private for object and
3564         class structs, to public for all other structs.
3566         * gtkdoc-scan.in (ScanHeader): Emit declarations for class structs
3567         to $MODULE-decl.txt.
3569 2002-12-05  Matthias Clasen  <maclas@gmx.de>
3571         * gtkdoc-mktmpl.in (OutputDeclaration):
3572         * gtkdoc-mkdb.in (ReadTemplateFile): Support @Since: and
3573         @Deprecated: as a way to specify since and deprecated information
3574         in template files. This works for all kinds of symbols, even those
3575         which normally don't have parameter lists.
3577 2002-12-02  Matthias Clasen  <maclas@gmx.de>
3579         * gtkdoc-mkdb.in (MakeDeprecationNote): Support multi-paragraph
3580         deprecation notes.
3582 2002-11-29  James Henstridge  <james@daa.com.au>
3584         * gtkdoc-mkhtml.in: copy the navigation images for both XML and
3585         SGML cases.
3587         * gtk-doc.dsl.in: update DSSSL stylesheets to match layout of XSL
3588         ones.
3590 2002-11-29  Matthias Clasen  <maclas@gmx.de>
3592         * gtkdoc-scan.in (ScanHeader): Make deprecation guards work with
3593         both
3594         #ifndef DEPRECATION_GUARD
3595         #if !defined(DEPRECATION_GUARD) || defined(FOO_COMPILATION)
3596         The second form is used in GDK and GTK+ to include selected
3597         deprecated symbols when compiling the library itself.
3599 2002-11-27  Matthias Clasen  <maclas@gmx.de>
3601         * gtkdoc-mkdb.in: Parse to new tags in inline doc comments,
3602         Since: and Deprecated:, which can be placed after the Returns:
3603         tag. Emit the Since: information (which is expected to be just a
3604         version number) after the parameters and the Deprecated:
3605         information (which is expected to be one or more full sentences)
3606         inside the deprecation warning.
3607         Warn if a Deprecated: tag is found on a symbol which is not
3608         guarded by a deprecation guard in the header.
3610 2002-11-26  James Henstridge  <james@daa.com.au>
3612         * gtkdoc-mkhtml.in: set gtkdoc-bookname and gtkdoc-version
3613         parameters in sgml mode, and don't bother with the sed run after
3614         processing with jade.
3615         In XML mode, pass the version number in as a parameter too.
3617         * gtk-doc.dsl.in ($user-html-header$): add <meta> tag if
3618         gtkdoc-version is set.
3619         (generate-index-mode): if gtkdoc-bookname is set, add it to the
3620         hrefs in the index file, like the XSLT sheets do.
3622         * gtk-doc.xsl: add gtkdoc.version parameter, and use it to add a
3623         <meta> tag with the gtk-doc version number.
3625 === release 0.10 ===
3627 2002-11-16  Damon Chaplin  <damon@gnome.org>
3629         * Released 0.10.
3631 2002-11-16  Damon Chaplin  <damon@gnome.org>
3633         * configure.in: bumped version to 0.10.
3635         * Makefile.am (EXTRA_DIST): added MAINTAINERS.
3637         * README: updated requirements info, mainly to add XML stuff.
3639         * NEWS: added news for 0.10
3641         * MAINTAINERS:
3642         * AUTHORS: updated my email address.
3644 2002-11-16  James Henstridge  <james@daa.com.au>
3646         * gtk-doc.xsl: output HTML in ISO-8859-1 (latin1), as using UTF-8
3647         can trigger misinterpretation of web pages when the web server
3648         asserts that the document is encoded in latin1 in the mime type.
3650 2002-11-15  James Henstridge  <james@daa.com.au>
3652         * gtk-doc.xsl: small changes to make the output closer to valid
3653         HTML.
3655         * gtkdoc-fixxref.in (MakeXRef): when substituting in cross
3656         references, use lower case element and attribute names, and quote
3657         the attribute value.
3659 2002-11-12  James Henstridge  <james@daa.com.au>
3661         * gtkdoc-mkdb.in: put content of parameter descriptions in
3662         <simpara> elements instead of <para>'s.  This makes the generated
3663         HTML more compact, as it will omit the <p> tag inside the list
3664         item.
3666         * gtk-doc.xsl: adjust stylesheet a little.
3668 2002-11-10  James Henstridge  <james@daa.com.au>
3670         * gtk-doc.xsl: change style for documentation.
3672         * gtkdoc-mkhtml.in (declaration): copy PNG files to the html
3673         directory.
3675 2002-11-10  Matthias Clasen  <maclas@gmx.de>
3677         * gtkdoc-mkdb.in (GetArgs): Expand abbreviations in source doc
3678         comments.
3680 2002-11-09  Matthias Clasen  <maclas@gmx.de>
3682         * gtkdoc-mktmpl.in (OutputSignalTemplates): Don't replace template
3683         param names with meaningless argn names generated by gtkdoc-scangobj.
3685         * gtkdoc-mkdb.in (GetSignals): Use argument names from source doc
3686         comments, if available.
3687         (GetArgs): Use source doc comments instead of blurb, if available.
3688         (ScanSourceFile): Also accept object::signal and object:property
3689         symbols.
3690         (MergeSourceDocumentation): For signals only, prefer source doc
3691         param names over template param names.
3693 Fri Nov  8 15:10:57 2002  Owen Taylor  <otaylor@redhat.com>
3695         * gtkdoc-mkdb.in (GetPrerequisites): Add missing <para>
3696         here too.
3698 Mon Nov  4 17:17:40 2002  Owen Taylor  <otaylor@redhat.com>
3700         * gtkdoc-mkdb.in (MergeSourceDocumentation): Warn
3701         when overriding docs in template file by inline comments.
3703         * gtkdoc-mkdb.in (GetInterfaces): Add missing <para> in
3704         "Implemented interfaces" output.
3706 2002-10-29  Damon Chaplin  <damon@ximian.com>
3708         * gtkdoc-scangobj.in: in get_type_name() set is_pointer to TRUE for
3709         subtypes of G_TYPE_BOXED and G_TYPE_POINTER. This means we get things
3710         like "GtkTreeIter *iter" rather than "GtkTreeIter iter" which was
3711         incorrect. Also return 'GParamSpec*' for G_TYPE_PARAM.
3712         in lookup_signal_arg_names() changed GtkNotebook::switch-page
3713         page argument to guint. And fixed a few other entries.
3714         Also fixed argument numbering, so we don't get 2 "widget" arguments.
3716         * gtkdoc-scanobj.in: add ';' after unlink command to avoid warning.
3718 2002-10-20  Matthias Clasen  <maclas@gmx.de>
3720         * examples/Makefile.am (SCANOBJ_FILES): Add $(DOC_MODULE).prerequisites.
3722         * gtkdoc-mkdb.in: Read $MODULE.prerequisites and put list of
3723         prerequisites below the object hierarchy for interfaces.
3725         * gtkdoc-scangobj.in: Write information about interface
3726         prerequisites to $MODULE.prerequisites.
3728 2002-10-15  Matthias Clasen  <maclas@gmx.de>
3730         * gtkdoc-scangobj.in: Sort paramspec arrays for
3731         greater stability and less random tmpl file diffs.
3733 2002-10-14  Matthias Clasen  <maclas@gmx.de>
3735         * examples/Makefile.am (SCANOBJ_FILES): Add $(DOC_MODULE).interfaces.
3737         * gtkdoc-mkdb.in: Read $MODULE.interfaces and put lists of
3738         implemented interfaces/known implementations below the object
3739         hierarchy for classes/interfaces.
3741         * gtkdoc-scangobj.in: Write interface information to
3742         $MODULE.interfaces.
3744 2002-10-12  Matthias Clasen  <maclas@gmx.de>
3746         * gtkdoc-scangobj.in: Make interface appear in the object hierarchy.
3748 2002-10-11  Matthias Clasen  <maclas@gmx.de>
3750         * gtk-doc.xsl: use 'UTF-8', not UTF-8 for default.encoding, to
3751         make the encoding actually appear in the resulting HTML.
3753 2002-10-09  James Henstridge  <james@daa.com.au>
3755         * gtkdoc-mkdb.in: set $doctype_header to "" for the SGML case, as
3756         we don't add a doctype to the beginning of SGML fragments.
3758 Tue Sep 17 01:07:51 2002  Jonathan Blandford  <jrb@gnome.org>
3760         * gtk-doc.xsl: output the chunks in UTF-8 so other tools can use
3761         them.
3763 2002-09-03  James Henstridge  <james@daa.com.au>
3765         * gtk-doc.xsl: turn on rendering of variablelists as tables, and
3766         set CSS rules to style .variablelist instead of .informaltable.
3768         * gtk-doc.dsl.in (variablelist): override the variablelist handler
3769         instead of the tgroups.
3771         * gtkdoc-mkdb.in (OutputStruct): use a <variablelist> for listing
3772         the field descriptions.
3773         (OutputEnum): same here.
3774         (OutputParamDescriptions): and here.
3776 2002-08-12  James Henstridge  <james@daa.com.au>
3778         * gtk-doc.xsl: include devhelp.xsl, and call generate.devhelp when
3779         processing the docbook/xml input.
3781         * devhelp.xsl: new file, implements .devhelp file output.
3783 2002-08-18  Havoc Pennington  <hp@pobox.com>
3785         * autogen.sh: hardcode aclocal-1.4/automake-1.4 so that users with
3786         both automake 1.6 and 1.4 installed get the right automake. Means
3787         compilation from CVS will now require the latest automake 1.4
3788         release, or manually creating symlinks called "automake-1.4" and
3789         "aclocal-1.4"
3791 2002-08-08  Matthias Clasen  <maclas@gmx.de>
3793         * gtkdoc-scangobj.in: Make sure blurbs end with a '.'
3795 2002-08-08  James Henstridge  <james@daa.com.au>
3797         * gtk-doc.xsl: add a gtkdoc.bookname param, and include it in the
3798         index.sgml output (if not empty).
3800         * gtkdoc-mkhtml.in: only perform the sed operation if we are using
3801         Jade, and pass the module name as a parameter when using xsltproc.
3803 2002-08-04  Matthias Clasen  <maclas@gmx.de>
3805         * gtkdoc-scangobj.in: Don't try to list signals on types which
3806         don't support signals, e.g. boxed types.
3808 2002-06-14  jacob berkman  <jacob@ximian.com>
3810         * gtkdoc-mkdb.in: do the version check before help, so --version
3811         doesn't output --help (should fix recent build bustage)
3813 2002-06-12  Matthias Clasen  <maclas@gmx.de>
3815         * gtkdoc-mkdb.in: Make header-grabbing work without an explicit
3816         --main-sgml-file argument.
3818         * gtkdoc-mkdb.in: Emit the object hierarchy as a <screen> rather
3819         than a <literallayout>, since the Docbook XSL stylesheets don't
3820         handle <link>s inside <literallayout>.
3822         * gtkdoc-mkdb.in: Decide wether to generate standalone documents
3823         for XIncluding or entities based on the presence of the XInclude
3824         namespace declaration on the document element.
3826 2002-06-09  James Henstridge  <james@daa.com.au>
3828         * gtkdoc-mkdb.in: try to grab the header off the top of the main
3829         sgml file.
3831 2002-05-31  James Henstridge  <james@daa.com.au>
3833         * gtkdoc-mkdb.in (OutputSGML): put XIncludes in the $book_bottom
3834         variable.
3835         (OutputBook): add the XInclude namespace declaration to the book
3836         element.
3838         * gtkdoc-mkhtml.in (declaration): if the document looks like XML,
3839         process it with xsltproc.
3841         * configure.in: check for xsltproc.
3843         * gtk-doc.xsl: start of XSLT template for converting docbook/xml
3844         to HTML.
3846 2002-06-03  Matthias Clasen  <maclas@gmx.de>
3848         * gtkdoc-mkdb.in (ConvertSGMLChars): Don't use Posix character
3849         classes. Perl < 5.6 doesn't have them; and the API doc autobuilder
3850         on widget.gnome.org has an old Perl.
3852 2002-05-29  Matthias Clasen  <maclas@gmx.de>
3854         Fixes for #77193:
3856         * gtkdoc-mkdb.in (OutputSGML): Call GetSignals, GetArgs and
3857         GetHierarchy for each symbol here and accumulate.
3858         (OutputSGMLFile): Get signal, argument and hierarchy information
3859         from the caller.
3860         (GetSignals, GetArgs, GetHierarchy): Don't wrap the return value
3861         in a refsect1, so that the results of multiple calls can be accumulated.
3863 2002-05-28  Matthias Clasen  <maclas@gmx.de>
3865         * gtkdoc-mkdb.in (ConvertSGMLChars): Make this work correctly
3866         for empty elements and XML comments in doc comments.
3868 2002-05-27  Matthias Clasen  <maclas@gmx.de>
3870         * gtkdoc-mkdb.in (ReadTemplateFile, OutputSGMLFile):
3871         Use only the basename of the template file in the key for the
3872         symbol table, in order to decouple the file extensions of the
3873         template files and the generated entities (we want to generate
3874         .xml entities from .sgml template files when emitting XML).
3876 2002-05-25  Matthias Clasen  <maclas@gmx.de>
3878         * gtkdoc-mkdb.in (ConvertSGMLChars): New function which tries to
3879         be a bit more clever when escaping SGML syntax characters.
3880         (ScanSourceFile): Use ConvertSGMLChars instead of CreateValidSGML.
3881         This reduces the work needed to make gtk-doc emit XML (where <, &
3882         and friends must always be escaped).
3884 2002-05-18  Matthias Clasen  <maclas@gmx.de>
3886         * gtkdoc-mkhtml.in: Detect whether we're processing SGML or XML.
3888         * gtkdoc-mkdb.in: New option --output-format to switch between
3889         SGML and XML output.
3891         * Makefile.am (EXTRA_DIST): Add xml.dcl
3893         * xml.dcl: The XML declaration.
3895 2002-05-06  jacob berkman  <jacob@ximian.com>
3897         * gtkdoc-scangobj.in: add an include for the GTK_CHECK_VERSION
3898         macro
3900 2002-05-05  Matthias Clasen  <maclas@gmx.de>
3902         * gtkdoc-scangobj.in: Output style properties.  (#80659)
3904         * gtkdoc-mkdb.in (GetArgs): Return separate sections for
3905         properties, child properties and style properties.  (#80659)
3907 2002-05-03  Matthias Clasen  <maclas@gmx.de>
3909         * gtkdoc-scangobj.in: Fix for segfault in scangobj-generated C
3910         program on Solaris.  (#80606, Jacob Berkman)
3912 2002-05-01  Matthias Clasen  <maclas@gmx.de>
3914         * tools/docpercentages.pl: Add the script which Owen uses for the
3915         d.g.o online API docs. Its easier to keep in sync here.
3917         * gtkdoc-mkdb.in (OutputMissingDocumentation): Fix
3918         $MODULE-undocumented.txt for d.g.o online API docs.
3920         * gtkdoc-mkdb.in (GetArgs): Use blurbs for property documentation.
3922         * gtkdoc-scangobj.in: Output child properties. Output nicks and
3923         blurbs for properties.
3925 2002-04-28  Matthias Clasen  <maclas@gmx.de>
3927         * gtkdoc-mkdb.in (ScanSourceFile): Don't scan for return value
3928         descriptions unnecessarily.  (#65997)
3930 2002-03-11  Matthias Clasen  <maclas@gmx.de>
3932         * gtkdoc-scangobj.in, gtkdoc-mkdb.in: Create docs for signals on interfaces.
3934 2002-02-01  Damon Chaplin  <damon@ximian.com>
3936         * configure.in: check for openjade or jade. Patch from Stefan Kost
3937         <kost@imn.htwk-leipzig.de>.
3939         * gtkdoc-mkhtml.in: use @JADE@ so the correct version of jade is used.
3941         * autogen.sh: commented out autoheader since we don't have a config.h.
3943 === release 0.9 ===
3945 2002-01-18  Damon Chaplin  <damon@ximian.com>
3947         * Released 0.9.
3949 2002-02-01  Damon Chaplin  <damon@ximian.com>
3951         * examples/Makefile.am: added SCANOBJ_OPTIONS in case the module needs
3952         to pass options to gtkdoc-scanobj or gtkdoc-scangobj.
3954 2002-01-24  Damon Chaplin  <damon@ximian.com>
3956         * tools/gtk-doc.el: added Zucchi's emacs lisp for automatically adding
3957         skeleton comment blocks above functions. Very handy!
3959 2002-01-23  Damon Chaplin  <damon@ximian.com>
3961         * configure.in: bumped the version to 0.9, so GTK+ can depend on this
3962         if it wants to.
3964         * gtkdoc-scangobj.in: we now default to calling g_type_init() to
3965         initialize the type system, rather than gtk_init(). This means you
3966         don't need an X connection to build the docs any more. Hurrah!
3967         Also added a '--type-init-func' argument so you can change the
3968         function to be called. GTK+ uses --type-init-func="gtk_type_init(0)".
3970         * gtkdoc-scan.in (ScanHeader): removed 'Found object' debug message.
3972 === release 0.8 ===
3974 2002-01-18  Damon Chaplin  <damon@ximian.com>
3976         * Released 0.8.
3978 2002-01-18  Damon Chaplin  <damon@ximian.com>
3980         * Makefile.am (EXTRA_DIST): added gtk-doc.dcl to EXTRA_DIST.
3982 2002-01-18  Damon Chaplin  <damon@ximian.com>
3984         * gtkdoc-scangobj.in: Reverted jacob's patch for this release, since
3985         it breaks GTK+ and possibly other packages. I'll re-apply it after
3986         the release, so we can fix everything in CVS.
3988 2002-01-18  jacob berkman  <jacob@ximian.com>
3990         * gtkdoc-scangobj.in: default to calling g_type_init(), remove
3991         --nogtkinit argument and replace with a more flexible
3992         --type-init-func
3994 2002-01-18  Damon Chaplin  <damon@ximian.com>
3996         * gtkdoc-mkdb.in (ScanSourceFile): patch from Matthias Clasen
3997         <matthiasc@poet.de> to only strip first space after '*' in source
3998         code comment blocks, so example code can be indented as desired.
3999         Bug #68216.
4001 Wed Nov 21 16:50:35 2001  Owen Taylor  <otaylor@redhat.com>
4003         * gtkdoc-mkdb,tmpl.in: Add some extra quoting to
4004         error messages to make it clearer what is going on
4005         with trailing commas on enumeration declarations.
4007 Wed Nov 21 16:00:45 2001  Owen Taylor  <otaylor@redhat.com>
4009         * Applied patch from Matthias Clasen to use a modified
4010         .dcl file with the 44 character name length limit removed.
4011         (#61342)
4013 2001-10-17  Damon Chaplin  <damon@ximian.com>
4015         * gtkdoc-mkdb.in: applied patch from Matthias Clasen
4016         <matthiasc@poet.de> to take a --sgml-mode argument which means
4017         all comment blocks in the source code are assumed to be DocBook
4018         (i.e. we don't convert '<', '>' and '&' to '&lt;' etc.
4020 2001-10-09  Damon Chaplin  <damon@ximian.com>
4022         * gtkdoc-mkdb.in (OutputMissingDocumentation): changed %.2f to %.0f
4023         so hopefully the automated reports on developer.gnome.org will work
4024         OK again.
4026 2001-10-02  Damon Chaplin  <damon@ximian.com>
4028         * gtkdoc-mktmpl.in (OutputDeclaration):
4029         * gtkdoc-mkdb.in (OutputFunction): applied patch from
4030         matthiasc@poet.de (Matthias Clasen) to handle G_CONST_RETURN in a
4031         parameter list. Bug #61341.
4033 2001-10-02  Damon Chaplin  <damon@ximian.com>
4035         * gtkdoc-mkdb.in (OutputMissingDocumentation): applied patch from
4036         matthiasc@poet.de (Matthias Clasen) to output percentages better.
4037         Bug #61467.
4038         Also set percent to 100 if total is 0, avoiding divide-by-zero.
4040 2001-10-02  Damon Chaplin  <damon@ximian.com>
4042         * examples/Makefile.am (DOC_OVERRIDES): define as an empty string,
4043         even when not used.
4045 2001-09-13  Damon Chaplin  <damon@ximian.com>
4047         * gtkdoc-mkdb.in (OutputMissingDocumentation): initialize buffer to "".
4048         Fix for SGI from David Kaelbling <drk@sgi.com>.
4050 Sat Sep  8 14:08:51 2001  Jonathan Blandford  <jrb@webwynk.net>
4052         * gtkdoc-scan.in (ScanHeader): recognize GET_IFACE macros
4054 2001-09-08  Havoc Pennington  <hp@pobox.com>
4056         * gtkdoc-mkdb.in (GetArgs): Title the section on object properties
4057         "Properties" instead of "Args"
4059 2001-08-14  Laszlo Peter  <laca@ireland.sun.com>
4061         * gtkdoc-scanobj.in:
4062         * gtkdoc-scangobj.in: change \n's to \\n's in perl scripts
4063         generating C code.
4065 2001-08-12  Jens Finke <jens@gnome.org>
4067         * Updated gtk-doc.spec.in file to match gpp standard.
4069 === release 0.7 ===
4071 2001-08-04  Damon Chaplin  <damon@ximian.com>
4073         * Released 0.7
4075 2001-08-04  Damon Chaplin  <damon@ximian.com>
4077         * gtkdoc-mkdb.in (OutputFunction):
4078         * gtkdoc-mktmpl.in (OutputDeclaration): patch from Lowell Johnson
4079         <ldjohn@usgs.gov> to accept things like "long long", "short int",
4080         "char test[][CLEN]" as function parameters.
4082 2001-07-20  Anders Carlsson  <andersca@gnome.org>
4084         * gtkdoc-scangobj.in: Remove argument to g_type_init ();
4086 2001-07-09  Damon Chaplin  <damon@ximian.com>
4088         * gtkdoc-mkdb.in (ParseStructDeclaration): accept G_CONST_RETURN
4089         modifier for function return values. gtkdoc-mktmpl.in already had this.
4091 Thu Jun 21 11:57:16 2001  Owen Taylor  <otaylor@redhat.com>
4093         * gtkdoc-scangobj.in: Conform to changes in GObject API
4094         for property retrieval.
4096 2001-05-25  Peter Williams  <peterw@ximian.com>
4098         * gtkdoc-mkdb.in (ScanSourceFile): Skip single-line comments --
4099         prevents barfing on ORBit-generated files.
4101 2001-05-20  Damon Chaplin  <damon@ximian.com>
4103         * examples/Makefile.am (sgml-build.stamp): replaced use of wildcard
4104         (which isn't portable) with original *.sgml. I think this just means
4105         that the first time you try to build the docs it will fail, but if
4106         you run make again it will work.
4108         * doc/setting-up.txt: explained that make may fail the first time.
4110 2001-05-19  Damon Chaplin  <damon@ximian.com>
4112         * README:
4113         * doc/README:
4114         * doc/setting-up.txt:
4115         * doc/sections-file.txt:
4116         * doc/authors.txt: updated docs to cover simpler setup procedure.
4118         * doc/gtk_button.txt:
4119         * doc/manpage:
4120         * doc/manpage.man:
4121         * doc/notes.txt: removed out-of date stuff.
4123         * Makefile.am (dist-hook): updated so it doesn't try to remove old
4124         examples subdirectory stuff.
4126 2001-05-19  Damon Chaplin  <damon@ximian.com>
4128         * examples/gnome/*:
4129         * examples/gnomeui/*: removed out-of-date example files.
4131         * examples/configure.in:
4132         * examples/Makefile.am: new example setup mostly copied from GTK+.
4134         * examples/README: describe the example configure.in/Makefile.am.
4136 2001-05-19  Damon Chaplin  <damon@ximian.com>
4138         * gtkdoc-mkdb.in: added --help option and changed output slightly to
4139         make more compatable with XML. Patch from Toshio Kuratomi
4140         <badger@prtr-13.ucsc.edu>
4142 2001-05-19  Damon Chaplin  <damon@ximian.com>
4144         * gtkdoc-mktmpl.in (OutputDeclaration):
4145         * gtkdoc-mkdb.in (OutputFunction): changed a '?' to a '*' so we accept
4146         multi-dimensional array function parameters. Patch from Paolo Casarini
4147         <casarini@CS.UniBO.IT>
4149 2001-05-12  Damon Chaplin  <damon@ximian.com>
4151         * gtkdoc-scangobj.in:
4152         * gtkdoc-scanobj.in: used "*pos = 0" to avoid problems with backslashes
4153         in '\0'.
4155         * configure.in: removed dsssl dirs stuff, since we use public entities
4156         now.
4158         * gtkdoc-mkdb.in (OutputBook): if there is no main SGML file we create
4159         it here. Also added a --main-sgml-file option so we know where to put
4160         it.
4162         * gtkdoc-scan.in: if there is no MODULE-sections.txt file, we copy
4163         the MODULE-decl-list.txt file to it. The user can tweak it later.
4165 2001-05-11  Damon Chaplin  <damon@ximian.com>
4167         * gtk-doc.spec.in: applied patch from Toshio Kuratomi
4168         <badger@prtr-13.ucsc.edu>.
4170 2001-05-07  Joakim Ziegler  <joakim@ximian.com>
4172   * gtkdoc-mkdb.in: Added option --outputallsymbols to create a symbol list
4173     in the module doc dir.
4175   * gtkdoc-mkdb.in: Added functionality to output a list of undocumented
4176     symbols in a module, most of is is in OutputMissingDocumentation.
4178   * gtkdoc-scan.in: Small scanning fixes to facilitate the doc coverage
4179      output mentioned above.
4181 2001-04-25  Federico Mena Quintero  <federico@ximian.com>
4183         * gtkdoc-scanobj.in: Added missing output-dir in the call to
4184         GetOptions().
4186 2001-04-24  Damon Chaplin  <damon@ximian.com>
4188         * gtkdoc-scanobj.in: copied --outputdir option from gtkdoc-scangobj.in.
4190 Fri Apr 13 15:25:44 2001  Owen Taylor  <otaylor@redhat.com>
4192         * gtkdoc-mkdb.in: Restore call to OutputBook that was accidentally
4193         deleted.
4195 Thu Apr 12 17:57:12 2001  Owen Taylor  <otaylor@redhat.com>
4197         * gtkdoc-scangobj.in: Add a --outputdir option (sort of hacky.
4198         Need this because $CC, $LD can include relative paths if they
4199         are based on $LIBTOOL)
4201 2001-03-26  Damon Chaplin  <damon@ximian.com>
4203         * gtkdoc-mkdb.in (ReadSourceDocumentation): scan .h files as well,
4204         so macros can be documented there if desired. Patch from
4205         Yoann Vandoorselaere <yoann@mandrakesoft.com>
4207         * gtkdoc-mkhtml.in (gtkdocdir): use 'test -f' rather than 'test -e'
4208         which is GNU-specific.
4210 Thu Mar  8 17:26:29 2001  Tim Janik  <timj@gtk.org>
4212         * gtkdoc-scangobj.in: fix signal param type handling.
4214 Tue Mar  6 23:21:46 2001  Jonathan Blandford  <jrb@redhat.com>
4216         * gtkdoc-scanobj.in: Add gobject support.  Now works on files that
4217         don't link against GTK.
4219 Sat Mar  3 17:43:42 2001  Owen Taylor  <otaylor@redhat.com>
4221         * gtkdoc-{scan,mktmpl,mkdb}.in: Add support for G_CONST_RETURN.
4222         (Right now, it will appear as G_CONST_RETURN in the output -
4223         I'm not sure that's right - perhaps it should be converted
4224         to const.)
4226 2001-02-20  Michael Meeks  <michael@ximian.com>
4228         * gtkdoc-mktmpl.in: s/TRUE/1/
4230 2001-02-19  Damon Chaplin  <damon@ximian.com>
4232         * gtkdoc-mktmpl.in (UpdateTemplates): fixed bug handling the $changed
4233         flag.
4235 2001-02-17  Damon Chaplin  <damon@ximian.com>
4237         * gtkdoc-scan.in (ScanHeaders):
4238         (ScanHeader): patch from Johannes Stezenbach <js@convergence.de>
4239         so we don't use '\b' in the regexp to match files/dirs to ignore.
4240         '\b' can match '_' so we matched things we shouldn't have.
4242 Mon Feb 12 12:50:57 2001  Owen Taylor  <otaylor@redhat.com>
4244         * configure.in: Up version.
4246 Sun Feb 11 18:35:07 2001  Owen Taylor  <otaylor@redhat.com>
4248         * gtkdoc-mktmpl.in: Add a timestamp file for the
4249         templates like sgml.stamp
4251         * gtkdoc-mktmpl.in (OutputUnusedTemplates): Write the
4252         symbols out in sorted order instead of hash table
4253         order to reduce conflicts.
4255 Mon Feb  5 16:48:51 2001  Owen Taylor  <otaylor@redhat.com>
4257         * configure.in gtk-doc.dsl.in: Remove checks for DSSSL - use a
4258         public entity instead.
4260         * gtkdoc-scangobj.in: Fix to work with libtool better.
4262 2001-01-30  Havoc Pennington  <hp@pobox.com>
4264         * gtkdoc-fixxref.in, gtkdoc-mkdb.in, gtkdoc-mktmpl.in,
4265         gtkdoc-scan.in, gtkdoc-scangobj.in, gtkdoc-scanobj.in:
4266         Added -*- cperl -*- magic, and --deprecated-guards
4267         option.
4269 2001-01-23  Damon Chaplin  <damon@helixcode.com>
4271         * gtkdoc-scangobj.in:
4272         * gtkdoc-scanobj.in:
4273         * gtkdoc-scan.in:
4274         * gtkdoc-mkdb.in:
4275         * gtkdoc-mktmpl.in: changed so that they only update files when
4276         necessary (they write new versions of the files out, then use 'cmp'
4277         to compare with the existing versions to see if they have changed.)
4278         This should make it easier to do proper dependency rules in Makefiles,
4279         and it may cut down on CVS traffic.
4281         * gtkdoc-mkhtml.in: update a timestamp file (html.stamp) after running.
4282         * gtkdoc-mkdb.in: update a timestamp file (sgml.stamp) if any of the
4283         DocBook SGML files have been changed. So hopefully you can now use
4284         rules like this to avoid unnecessary regeneration of the HTML:
4286         all-local:
4287                 $(MAKE) scan
4288                 $(MAKE) templates
4289                 $(MAKE) sgml
4290                 $(MAKE) html.stamp
4292         html.stamp: sgml.stamp $(EXTRA_SGML_FILES)
4293                 $(MAKE) html
4295         (I've tried this with the old GTK+ reference API docs and it seems to
4296         work well.)
4298         * gtkdoc-scangobj.in:
4299         * gtkdoc-scanobj.in:
4300         * gtkdoc-scan.in:
4301         * gtkdoc-mkdb.in:
4302         * gtkdoc-mktmpl.in:
4303         * gtkdoc-mkhtml.in:
4304         * gtkdoc-mkman.in:
4305         * gtkdoc-fixxref.in:
4306         Added '--version' command-line arg to all shell & perl scripts, so
4307         you can check for version 0.5 if you want to use the above rules.
4308         (If 0.4 is used make will probably complain about not knowing how to
4309         to build sgml.stamp.)
4311         * gtkdoc-common.pl.in: new file to contain shared routines.
4312         For now it just contains the UpdateFileIfChanged routine for the above.
4313         We can move the duplicated routines here in future, though the use of
4314         global variables makes this a bit awkward.
4316         * configure.in (PACKAGE_DATA_DIR): calculates the data dir and
4317         substitutes it so that the scripts know where gtkdoc-common.pl
4318         is installed. Also added gtkdoc-common.pl to AC_OUTPUT.
4320         * Makefile.am: added gtkdoc-common.pl to gtkdocdata_DATA.
4322         * gtkdoc-mkhtml.in: deleted the old index.sgml file, since it causes
4323         problems if it is owned by root (e.g. after you run 'make install' as
4324         root. jade prompts you about overwriting it, which is annoying.
4326 2001-01-10  Havoc Pennington  <hp@redhat.com>
4328         * gtkdoc-mktmpl.in: Only move old file to backup if the old file
4329         exists, and have better error messages when doing the backups
4331 Mon Jan  8 14:57:29 2001  Owen Taylor  <otaylor@redhat.com>
4333         * gtkdoc-mktmpl.in: Canonicalize signal and argument
4334         names to -, not _.
4336         * gtkdoc-scangobj.in: Fix up for GParamSpec.
4338 2001-01-04  Fr�d�ric Gobry  <frederic.gobry@smartdata.ch>
4340         * gtkdoc-scan.in: fixed matching of < private_header > directive
4342 2000-12-19  Damon Chaplin  <damon@helixcode.com>
4344         * gtkdoc-scanobj.in:
4345         * gtkdoc-scangobj.in: added default cases to get_type_name().
4347 2000-12-10  Arturo Tena  <arturo@directmail.org>
4349         * gtkdoc-scanobj.in (get_type_name):
4350         * gtkdoc-scangobj.in (get_type_name): fixed syntax error: forgotten
4351         to close a switch statement.
4353 2000-12-10  Damon Chaplin  <damon@helixcode.com>
4355         * gtk-doc.spec.in: added spec.in file from John Gotts
4356         <jgotts@linuxsavvy.com>.
4358         * configure.in (AC_OUTPUT): added spec file.
4360         * Makefile.am: uncommented spec file stuff, now that we have one.
4362         * gtkdoc-scanobj.in (get_type_name):
4363         * gtkdoc-scangobj.in (get_type_name): updated to use the type numbers
4364         rather than the type names, which were changed in GTK+ 1.2. This
4365         should fix a problem where GTK_TYPE_STRING arguments were output as
4366         'GtkString *arg' instead of 'gchar *arg'.
4368         I'm still not sure what to output for the structured types such as
4369         GTK_TYPE_SIGNAL/ARGS/FOREIGN/CALLBACK/C_CALLBACK. Should these be
4370         expanded to several arguments to the signal handler?
4372 2000-11-25  Dan Mueth <d-mueth@uchicago.edu>
4374         * help/manual/C/: created this path
4375     * gtk-doc-manual.sgml: Put part of the outline into SGML.
4376       Chris plans to put rest of outline in here and start
4377       writing.
4378     * fdl-appendix.sgml: The FDL in SGML.  We will probably post
4379       these on the web as a single document (book) so we will
4380       need the FDL to be included as an appendix.
4382 Fri Nov  3 07:21:34 2000  Tim Janik  <timj@gtk.org>
4384         * gtkdoc-mkdb.in:
4385         (ParseStructDeclaration):
4386         (OutputStruct):
4387         * gtkdoc-mktmpl.in:
4388         (ParseStructDeclaration):
4389         support /*<protected>*/ equivalently to /*<private>*/
4391 Fri Nov  3 07:15:58 2000  Tim Janik  <timj@gtk.org>
4393         * gtkdoc-mktmpl.in:
4394         * gtkdoc-mkdb.in:
4395         (ReadTemplateFile): only eat up the first space (if at all
4396         present) after "@param:" to preserve indentation for multiline
4397         parameter descriptions.
4399 2000-10-30  Raja R Harinath  <harinath@cs.umn.edu>
4401         * gtkdoc-mkdb.in (ParseStructDeclaration):
4402         Stop scanning at '}' only when it starts a line.
4403         * gtkdoc-mktmpl.in (ParseStructDeclaration): Likewise.
4405 Mon Oct 30 02:59:54 2000  Tim Janik  <timj@gtk.org>
4407         * gtkdoc-scangobj.in: use g_signal_list_ids().
4409 Sun Oct 29 02:54:51 2000  Owen Taylor  <otaylor@redhat.com>
4411         * gtkdoc-scangobj.in: Sort signal types arrays for
4412         greater stability and less random tmpl file diffs.
4414 Sun Oct 29 01:02:35 2000  Owen Taylor  <otaylor@redhat.com>
4416         * gtkdoc-scangobj.in: Work properly with GSignal
4418 === release 0.4 ===
4420 2000-10-21  Damon Chaplin  <damon@helixcode.com>
4422         * Released 0.4
4424 2000-10-14  Damon Chaplin  <damon@helixcode.com>
4426         * AUTHORS:
4427         * MAINTAINERS: changed my email address.
4429         * Makefile.am (dist-hook): remove the CVS dirs from the dist.
4431         * doc/setting-up.txt: typo.
4433 Fri Oct  6 17:51:50 2000    <otaylor@redhat.com>
4435         * gtkdoc-scan.in gtkdoc-mkdb.in: Allow multiple
4436         --source-dir options.
4438 Thu Sep  7 11:41:12 2000  Owen Taylor  <otaylor@redhat.com>
4440         * gtkdoc-mkdb.in: Ignore all . files when scanning directories.
4442         * gtkdoc-scan.in: Add support for GLIB_VAR, GDKVAR,
4443         etc when looking for variable declarations.
4445         * gtkdoc-scan.in: Recognize GET_CLASS macros.
4447         * gtkdoc-scangobj.in: Support .lo intermediate files
4448         with libtool.
4450 Wed Sep  6 17:57:33 2000  Owen Taylor  <otaylor@redhat.com>
4452         * gtkdoc-scangobj.in: Add gtkdoc-scangobj scanner for
4453         GObject type system.
4455         * gtkdoc-scanobj.in: Allow setting $LD to allow separating
4456         compilation and linking and thus to allow using libtool.
4458         * gtkdoc-fixxref.in (ScanIndices): Allow HTMLDIR
4459         not to be present yet.
4461 Tue Sep  5 23:37:53 2000  Owen Taylor  <otaylor@redhat.com>
4463         * gtkdoc-fixxref.in: Add a --extra-dir option to
4464         allow scanning of additional uninstalled HTML
4465         directories.
4467         * gtkdoc-scan.in (ScanHeaders): Honor subdirectories
4468         appearing in --ignore-headers.
4470         * gtkdoc-mkdb.in: Append -CAPS to all all-caps identifiers
4471         to prevent an infinite expansion of special cases.
4473         * gtkdoc-fixxref.in: Add a --module-dir option to
4474         allow fixing references in an uninstalled tree.
4476         * gtkdoc-mkdb.in gtkdoc-mkhtml.in: Simple handling
4477         for macros with embedded commas in enumeration
4478         declarations.
4480 Mon Aug 28 18:18:53 2000  Owen Taylor  <otaylor@redhat.com>
4482         * configure.in (DSSSL_DIR): Remove check for AM_PATH_GTK
4483         since the dependency is only run-time not install-time,
4484         and to avoid dependency loops.
4486 2000-06-21  Damon Chaplin  <damon@helixcode.com>
4488         * gtkdoc-mkdb.in: fixed <INCLUDES> bug, I think.
4490 Wed Feb  9 11:29:25 2000  Owen Taylor  <otaylor@redhat.com>
4492         * gtkdoc-scan.in: Hack to avoid misidentifying structures
4493         as GtkObjects within Pango.
4495 1999-12-15  Raja R Harinath  <harinath@cs.umn.edu>
4497         * gtk-doc.dsl.in ($generate-chapter-toc$): Add missing close
4498         paranthesis.
4500 1999-11-23  Raja R Harinath  <harinath@cs.umn.edu>
4502         * gtk-doc.dsl.in: Use the (define (foo) ...) syntax rather than
4503         the uglier (define foo (lambda () ...)) syntax.
4504         ($generate-chapter-toc$): Simplify.
4505         ($shade-verbatim-attr$): Simplify.  Use ($table-width$) instead of
4506         "100%" for width (See docs. of NWalsh Docbook DSSSL Stylesheets
4507         for an explanation).
4509 1999-09-20  Damon Chaplin  <damon@karuna.freeserve.co.uk>
4511         * gtk-doc.dsl.in: If a Chapter has role="no-toc" we don't generate a
4512         table of contents. This is useful if a better contents page has been
4513         added manually, e.g. for the GTK+ Widgets & Objects page. (But it is
4514         a bit of a hack.)
4516         * gtkdoc-scanobj.in: added --nogtkinit flag which will make it call
4517         gtk_type_init() rather than gtk_init(). This is useful when it is
4518         run automatically to update the docs by a cron job or similar and a
4519         connection to an X server is not desirable. However, if any widgets
4520         need a connection to X in their class init function then this can't
4521         be used (e.g. GtkFontSelection at present).
4523 Mon Sep 20 09:09:12 1999  Owen Taylor  <otaylor@redhat.com>
4525         * gtkdoc-mkdb.in gtkdoc-mktmpl.in: (ParseStructDeclaration):
4526         Fixed up the code to do /*< private >*/ ... stripping.
4528 1999-09-10  Martin Baulig  <martin@home-of-linux.org>
4530         * gtkdoc.dsl.in ($generate-chapter-toc$): Return #t, not #f.
4532 1999-09-09  Martin Baulig  <martin@home-of-linux.org>
4534         * gtkdoc-scan.in (ScanHeader): Don't force typedefs and other
4535         things to start in column 0; allow some spaces in front of them.
4536         Output `typedef struct { ... } name' structs as typedef, not as
4537         structure.
4539 1999-09-08  Martin Baulig  <martin@home-of-linux.org>
4541         * gtkdoc-mkdb.in (CreateValidSGMLID): `s/::/-/g;' for CORBA objects.
4543 1999-08-22  Erik Walthinsen  <omega@cse.ogi.edu>
4545         * gtkdoc-scan.in: modified so it will find any Class, not just Gtk
4546         and Gnome classes.  Introduces the possibility of extraneous Class
4547         definitions (verified), which should be pruned somehow (haven't
4548         analyzed the false positive yet).
4550 1999-08-22  Damon Chaplin  <damon@karuna.freeserve.co.uk>
4552         * gtkdoc-mktmpl.in:
4553         * gtkdoc-mkdb.in: a few fixes to ParseStructDeclaration. It still
4554         has problems with nested structs/unions like those which occur in
4555         gtkclist.h and gtktypeutils.h.
4557         * configure.in: removed gtk-doc.spec from AC_OUTPUT, as whoever wrote
4558         this forgot to add gtk-doc.spec.in to CVS.
4559         * Makefile.am: commented out gtk-doc.spec.
4561 Wed Aug 18 03:55:30 1999  Owen Taylor  <otaylor@redhat.com>
4563         * gtkdoc-mktmpl.in: Propagate fix from gtkdoc-mkdb.in.
4564         :-(; need to libraryize, need to libraryize.
4566 Wed Aug 18 03:55:30 1999  Owen Taylor  <otaylor@redhat.com>
4568         * gtkdoc-mkdb.in: Fix bug that was preventing
4569         structure field definitions from being output.
4571 Wed Aug 18 23:25:23 1999  Owen Taylor  <otaylor@redhat.com>
4573         * configure.in: Add /usr/lib/sgml/stylesheet to list
4574         of stylesheet directories. (Found in recent Debian
4575         packages)
4577 1999-08-15  Damon Chaplin  <damon@karuna.freeserve.co.uk>
4579         * gtkdoc-mkdb.in: Output $decl_out as the struct rather than the
4580         original $declaration.
4582 1999-08-12  Damon Chaplin  <damon@karuna.freeserve.co.uk>
4584         * gtkdoc-mkdb.in:
4585         * gtkdoc-mktmpl.in: Added special case in ParseEnumDeclaration to
4586         handle GIOCondition which uses strange macros like this:
4587         typedef enum
4588         {
4589           G_IO_IN       GLIB_SYSDEF_POLLIN,
4590           ...
4591         The GLIB_SYSDEF_POLLIN macro expands to something like '=1'
4593 1999-08-05  Damon Chaplin  <damon@karuna.freeserve.co.uk>
4595         * gtk-doc.dsl.in: output <br clear=all> after sections and at end of
4596         page so that right-aligned images aren't messed up quite as much.
4598 Wed Aug  4 04:04:55 1999  Owen Taylor  <otaylor@redhat.com>
4600         * gtkdoc-mk{db,tmpl}.in (ParseStructDeclaration): Allow
4601         for bit fields.
4603         * gtkdoc-mktmpl.in (ReadObjectHierarchy): Remove
4604         call to MakeXref that slipped in accidentally.
4606 Wed Aug  4 03:30:19 1999  Owen Taylor  <otaylor@redhat.com>
4608         * doc/style-guide.txt: Removed references to creating
4609         tables explicitely in favor of demonstrating new
4610         syntax. Added a short section on /<* public >*/
4611         and /*< private *>/.
4613 Wed Aug  4 03:15:19 1999  Owen Taylor  <otaylor@redhat.com>
4615         * gtkdoc-mktmpl.in gtkdoc-mkhtml.in: Handle Struct and
4616         Enumerations in approximately the same way as we
4617         handle parameters. That is, instead of (as before)
4618         coding in the tables by hand, one uses lines like:
4620         @width: the width of the rectangle in pixels.
4622         To support migration from the older hand-coded
4623         tables, if none of the members of a structure or
4624         enumeration have a description in a @... line, then
4625         we don't generate the table at all.
4627         Also, gtkdoc-mktmpl now loads up the object heirarchy,
4628         because we need to be able to check if structures
4629         are widget structures.
4631         In general, the coding here is pretty clean, though
4632         the style is a little different. (I'm interating
4633         through strings with m/.../msg; instead of
4634         s/^...//; for one thing.) However, there are a some
4635         of FIXME's where I've whimped out on try to handle
4636         real C syntax, and the need to split out and librarize
4637         a bunch of duplicated code is greater than ever.
4639 1999-06-06  Damon Chaplin  <damon@karuna.freeserve.co.uk>
4641         * configure.in: updated version to 0.3.
4643         * doc/style-guide.txt: A couple of minor changes.
4645         * gtkdoc-mkdb.in: Get rid of a couple of messages.
4646         Output an empty <para> if an Arg isn't documented, to keep Jade happy.
4648 1999-05-22  Damon Chaplin  <damon@karuna.freeserve.co.uk>
4650         * gtk-doc.dsl.in: Renamed %shade-verbatim-attr-2% to
4651         $shade-verbatim-attr$ and removed our redefinition of
4652         $verbatim-display$ since the stylesheets version now calls
4653         $shade-verbatim-attr$ as a function which is just what we wanted.
4655         * README: Updated info on stylesheet versions supported - 1.40 is
4656         known to be OK (with this version of gtk-doc), 1.19+ may work.
4658 1999-03-31  Damon Chaplin  <damon@karuna.freeserve.co.uk>
4660         * configure.in: update version to 0.2 for next release.
4662         * gtkdoc-mktmpl.in:
4663         * gtkdoc-mkdb.in: added support for 'See Also' section.
4665         * gtk-doc.dsl.in: changed green background color slightly, and
4666         set background color for enum tables.
4668 1999-03-21  Damon Chaplin  <damon@karuna.freeserve.co.uk>
4670         * gtkdoc-mkhtml.in (gtkdocdir): use '-w no-idref' to suppress all the
4671         warnings about references to non-existent IDs.
4673 1999-03-18  Damon Chaplin  <damon@karuna.freeserve.co.uk>
4675         * gtkdoc-mkdb.in (OutputParamDescriptions): use role="params" for the
4676         table so we can adjust the stylesheet code.
4677         (OutputSGMLFile): Don't output 'one line description goes here'.
4678         (ExpandAbbreviations): allow '-' in #symbol abbreviations, so we can
4679         use #GtkWidget-struct.
4680         (MakeXRef): get rid of special '-struct' suffix, for #GtkWidget-struct.
4682         * gtk-doc.dsl.in: use the "role" attribute on tables to set the
4683         BGCOLOR.
4685         * gtkdoc-scan.in (ScanHeader): fix for scanning functions declared
4686         over multiple lines - was catching things which weren't functions.
4688 1999-03-11  Damon Chaplin  <damon@karuna.freeserve.co.uk>
4690         * examples/gnomeui/Makefile.am (clean-local):
4691         * examples/gnome/Makefile.am (clean-local): added *.args
4693         * gtkdoc-mkdb.in: added support for Args and variables. Also a few
4694         minor changes in the output, e.g. don't show macros > 2 lines long.
4696         * gtkdoc-mktmpl.in:
4697         * gtkdoc-scanobj.in: added support for Args.
4699         * gtkdoc-scan.in: added support for extern'ed variables. Also
4700         accept 'extern' before function declarations.
4702         * gtk-doc.dsl.in: made output prettier. Changed the navigation bars
4703         and the colours used for the various backgrounds.
4705         * doc/style-guide.txt: new file containinf a style guide for writing
4706         the GTK+ documentation.
4708         * doc/README: added description of style-guide.txt
4710         * doc/setting-up.txt: fixed a typo
4712         * README: added a bit about Args.
4714 1999-02-07  Damon Chaplin  <damon@karuna.freeserve.co.uk>
4716         * Makefile.am: Removed all the scripts from EXTRA_DIST, as they are
4717         now generated from the .in files which automatically go in the dist.
4719 1999-02-02  Damon Chaplin  <damon@karuna.freeserve.co.uk>
4721         * doc/setting-up.txt (scan): removed text which incorrectly said that
4722         changing section titles means you have to recreate the main SGML file.
4724 1999-02-03  Sebastian Wilhelmi  <wilhelmi@ira.uka.de>
4726         * configure.in: find perl in $PATH, generate the perl programs
4727         from their *.in counterparts.
4729         * gtkdoc-fixxref, gtkdoc-mkdb, gtkdoc-mktmpl, gtkdoc-scan,
4730         gtkdoc-scanobj: Renamed to *.in and changed /usr/bin/perl to
4731         @PERL@, as determined by configure.
4733         * .cvsignore: Added diverse config* stuff and the new generated
4734         perl programs.
4736 1999-01-28  Damon Chaplin  <damon@karuna.freeserve.co.uk>
4738         * gtk-doc.dsl.in: I forgot to make the new refentry code process the
4739         child elements, so it was only outputting anchors for each page.
4741         * doc/setting-up.txt (scan): added step to create MODULE.types file
4742         for modules which contain widgets (or objects).
4744         * gtkdoc-mkdb (OutputStruct): allow spaces inside the public/private
4745         markers, e.g. "/*  <  public  >  */"
4747 1999-01-27  Damon Chaplin  <damon@karuna.freeserve.co.uk>
4749         * Makefile.am: added scripts to EXTRA_DIST and copied examples, doc
4750         and db2man dirs in dist-hook.
4752         * doc/sections-file.txt: added a couple of examples.
4754         * doc/setting-up.txt: new document describing how to set up a module
4755         to use gtk-doc.
4757         * doc/README: added description of setting-up.txt
4759         * README: added short 'Installation' section describing the
4760         --with-dsssl-dir option.
4762         * gtk-doc.dsl.in: also output links to each RefEntry page in the
4763         index.sgml file, so libgnomeui docs can link to widgets. (The widget
4764         hierarchy links were not working before.)
4766 1999-01-26  Damon Chaplin  <damon@karuna.freeserve.co.uk>
4768         * gtkdoc-scan (ScanHeader): parse function declarations that have the
4769         return type and name on one line, and the '(' and args on the next.
4770         NOTE: functions with the start of the declaration split over 3 lines
4771         will not be parsed (e.g. return type on one line, function name on
4772         next, and '(' and first argument on the third.) I hope there aren't
4773         any.
4775         * gtkdoc-mkdb (OutputStruct): Use a different SGML ID for widget
4776         structs, since the original ID is used for the entire RefEntry.
4777         Also only show parts of widget structs which are marked with a
4778         comment '/*<public>*/'. Use '/*<private>*/' for private fields.
4780         * gtkdoc-mktmpl (UpdateTemplates): We include widget structs now,
4781         so we do want warnings if they aren't used.
4783         * examples/gnomeui/gnomeui-docs.sgml:
4784         * examples/gnomeui/gnomeui-sections.txt:
4785         * examples/gnomeui/gnomeui.types:
4786         * examples/gnome/gnome-docs.sgml:
4787         * examples/gnome/gnome-sections.txt: sync with latest source.
4789         * examples/configure.in: Add --with-gnome-libs-dir option, so it can
4790         be configured easily.
4791         * examples/gnomeui/Makefile.am (DOC_SOURCE_DIR):
4792         * examples/gnome/Makefile.am (DOC_SOURCE_DIR): use the new
4793         GNOME_LIBS_DIR.
4795         * gtkdoc-mkdb (MergeSourceDocumentation): accept parameters names in
4796         the source which use the wrong case, since there are quite a few of
4797         these in Gnome.
4799 1999-01-25  Damon Chaplin  <damon@karuna.freeserve.co.uk>
4801         * gtkdoc-mktmpl: parse G_GNUC_EXTENSION before typedef'ed types.
4803         * gtkdoc-mkdb: added support for specifying include files in the
4804         MODULE-sections.txt file, to be output at the top of the synopsis.
4806         * doc/sections-file.txt: added description of <INCLUDE> tag.
4808         * examples/gnomeui/gnomeui-sections.txt:
4809         * examples/gnome/gnome-sections.txt: added use of <INCLUDE>
4811         * examples/configure.in: changed 'gtk-reference' to
4812         'gnome-libs-reference'.
4814 1999-01-18  Damon Chaplin  <damon@karuna.freeserve.co.uk>
4816         * README: updated my email address & noted that version 1.15+ of the
4817         DocBook modular stylesheets is needed (for $table-width$).
4819         * AUTHORS: updated my email address.
4821 1998-12-20  Jeff Garzik  <jgarzik@pobox.com>
4823         * examples/gnomeui/gnomeui-docs.sgml,
4824           examples/gnomeui/gnomeui-sections.txt,
4825           examples/gnomeui/gnomeui.types:
4826         s/gtkspell/gnome-spell/g
4828 1998-12-16  Damon Chaplin  <DAChaplin@msn.com>
4830         * gtkdoc-mkdb (ExpandAbbreviations): Allow -ve contants, e.g. %-1.
4831         (ScanSourceFile): Try to handle function descriptions that start
4832         with 'Returns'. It was assuming that they were describing the return
4833         value before.
4834         Gets rid of 'Description:' which is sometimes included
4835         at the start of the function description in the source comment blocks.
4836         Makes sure newlines are preserved in the description, as consecutive
4837         newlines are converted to paragraph separators later.
4839 1998-12-15  Damon Chaplin  <DAChaplin@msn.com>
4840         * Major changes to the scripts to merge in comments within source code
4841         * gtk-doc-fixxref added
4842         * examples directory added with an example for setting up modules to
4843         use gtk-doc
4844         * documentation updated
4847 1998-11-28  Damon Chaplin  <DAChaplin@msn.com>
4849         * gtkdoc-scanobj:
4850         * gtkdoc-scan:
4851         * gtkdoc-mktmpl:
4852         * gtkdoc-mkdb: Major changes to make it easy to update the docs
4853         when the API changes. It's pretty much all automatic now.
4854         Also added licenses and function comments, and added 'use strict'.
4855         The Gnome widgets should now be visible in the hierarchy.
4856         Removed a few 'mkdir's which I don't think are necessary now.
4858 Tue Nov 24 16:32:23 1998  Owen Taylor  <otaylor@redhat.com>
4860         * README doc/authors.txt: Updated to describe the
4861         new generic scripts instead of the old ones hard-coded
4862         for GLIB and GTK+.
4864 Tue Nov 24 01:06:17 1998  Owen Taylor  <otaylor@redhat.com>
4866         * .cvsignore: Added .cvsignore
4868 Tue Nov 24 01:03:47 1998  Owen Taylor  <otaylor@redhat.com>
4870         * autogen.sh configure.in: Minor touchups so the newly
4871         imported stuff autogen's correctly.