1 2008-09-24 Stefan Kost <ensonic@users.sf.net>
4 Use full symbol, if it does not belong to the namespace.
6 2008-09-22 Stefan Kost <ensonic@users.sf.net>
8 * tests/gobject/src/gobject.h:
9 Document some odd behaviour.
11 2008-09-22 Stefan Kost <ensonic@users.sf.net>
16 * tests/bugs/docs/tester-sections.txt:
17 * tests/bugs/src/tester.c:
18 * tests/bugs/src/tester.h:
19 Add testcase for bug 552602.
22 * tests/gtk-doc.notmpl.make:
23 Also use new RUN envvar here.
25 2008-09-10 Stefan Kost <ensonic@users.sf.net>
28 Generate unique ids for properties, style and child properties.
31 * gtk-doc.notmpl.make:
34 If we use libtool, run scanner under libtool to use uninstalled
37 2008-09-04 Stefan Kost <ensonic@users.sf.net>
48 * gtkdoc-common.pl.in:
50 * help/manual/C/gtk-doc-manual.xml:
51 * tests/bugs/docs/Makefile.am:
52 * tests/bugs/docs/tester-docs.xml:
53 * tests/gobject/docs-tmpl/Makefile.am:
54 * tests/gobject/docs-tmpl/tester-docs.xml:
55 * tests/gobject/docs/Makefile.am:
56 * tests/gobject/docs/tester-docs.xml:
57 * tests/gobject/src/gobject.h:
58 Switch to docbook 4.3 dtd. Fixes #487727.
59 Add --name-space option to gtkdoc-mkdb for nicer indexes. Start with a
60 fo wrapper for pdf output.
62 2008-09-04 Stefan Kost <ensonic@users.sf.net>
65 * gtk-doc.notmpl.make:
66 Don't install index.sgml twice. Also remove the " || :;" construct
67 that ssems to be there only to eat the return code.
69 2008-07-23 Stefan Kost <ensonic@users.sf.net>
73 * tests/bugs/docs/tester-sections.txt:
74 * tests/bugs/src/tester.h:
75 Accept "char const *" as well. Fixes #544172.
77 2008-07-21 Stefan Kost <ensonic@users.sf.net>
80 * gtk-doc.notmpl.make:
81 Only specify options if gtkdoc-mkhtml can take them. Fixes #543855.
84 Don't use bash specific features. Be more flexible so that we can add
87 2008-07-09 Stefan Kost <ensonic@users.sf.net>
90 Fix struct/enum level parsing which could go one to high and then the
91 main struct would never be closed.
94 2008-06-28 Stefan Kost <ensonic@users.sf.net>
97 Mention why this change is bad.
99 2008-06-28 Stefan Kost <ensonic@users.sf.net>
101 patch by: David Nečas <yeti@physics.muni.cz>
103 * examples/Makefile.am:
105 * gtk-doc.notmpl.make:
107 * tests/gtk-doc.make:
108 * tests/gtk-doc.notmpl.make:
109 Add searchpath to gtkdoc.mkhtml. Fixes #460753
112 2008-06-22 Stefan Kost <ensonic@users.sf.net>
115 To support timj aclocal setup we are shipping gnome-doc-utils.m4
116 and making sure automake picks it up ;)
118 2008-06-22 Stefan Kost <ensonic@users.sf.net>
120 * tools/migratetmpl.pl:
121 We were still removing too many <para>s.
122 Also add andrews trick to escape the c comments.
123 Add a newline to empty param docs.
125 2008-06-22 Stefan Kost <ensonic@users.sf.net>
127 * m4/gnome-doc-utils.m4:
128 Add this to svn, so that bootstrap work where no gnome-doc-utils is
131 2008-06-21 Stefan Kost <ensonic@users.sf.net>
133 * tools/migratetmpl.pl:
134 Factor out multiline formatting and use for deprecated field too.
136 2008-06-21 Stefan Kost <ensonic@users.sf.net>
141 * tools/migratetmpl.pl:
142 Convert character entities back.
144 2008-06-21 Stefan Kost <ensonic@users.sf.net>
147 Start collection info about slowly deprecating crack.
149 * tools/migratetmpl.pl:
152 2008-06-21 Stefan Kost <ensonic@users.sf.net>
154 * tools/migratetmpl.pl:
155 Use $file in section comment not title. Convert only standalone para
158 2008-06-21 Stefan Kost <ensonic@users.sf.net>
160 * tools/migratetmpl.pl:
161 Convert @Varargs: to @...:
163 2008-06-21 Stefan Kost <ensonic@users.sf.net>
165 * tools/migratetmpl.pl:
166 Convert single line c comments to c++ ones. Indent multiline parameter docs.
168 2008-06-16 Stefan Kost <ensonic@users.sf.net>
171 Don't reuse file var, fixes warning context.
174 Also accept *.hh as headers suffix.
176 2008-06-10 Stefan Kost <ensonic@users.sf.net>
179 * gtk-doc.notmpl.make:
180 * tests/gtk-doc.make:
181 * tests/gtk-doc.notmpl.make:
182 Include original CFLAGS / LDFLAGS when building the scanner. Allows to
183 have own FLAGS defined in addition.
185 2008-06-08 Stefan Kost <ensonic@users.sf.net>
190 2008-06-08 Stefan Kost <ensonic@users.sf.net>
195 * gtkdoc-scangobj.in:
197 Merge two fwrite calls.
199 * tests/gobject/examples/gobject.c:
200 * tests/gobject/src/gobject.c:
201 Demostrate how to include source fragments from external files.
203 * tests/gobject/src/giface.h:
204 * tests/gobject/src/gobject.h:
205 Documents two entries.
207 2008-06-07 Sebastian Dröge <slomo@circular-chaos.org>
209 * gtkdoc-scangobj.in:
211 Add "%s" format strings to printf-like functions when printing
212 a string. Fixes #536980.
214 2008-06-05 Stefan Kost <ensonic@users.sf.net>
221 * tools/migratetmpl.pl:
222 Add first version of a tool to support migration from tmpl docs to
223 source code comments.
225 2008-06-04 Stefan Kost <ensonic@users.sf.net>
228 Correct invocation for gnome-doc-prepare.
230 2008-06-04 Stefan Kost <ensonic@users.sf.net>
232 * gtkdoc-common.pl.in:
233 Handle file or line being undefined.
236 Warn about repeated symbols in sections. Also give line of previous
237 occurrance. Also give that info for double file entries. Fixes #473342
238 Give correct error locate for one warning. Fixes #532395 partialy
240 2008-06-04 Stefan Kost <ensonic@users.sf.net>
243 Don't warn about overriden docs comment if its the same text.
245 2008-06-03 Stefan Kost <ensonic@users.sf.net>
251 Warn and skip double file entries in section files.
254 Use the new warning format in this script too.
257 Also use optional parameters here.
259 2008-06-02 Stefan Kost <ensonic@users.sf.net>
261 * tests/gobject/docs-tmpl/tester-docs.xml:
262 * tests/gobject/docs-tmpl/tester-sections.txt:
263 * tests/gobject/docs/tester-docs.xml:
264 * tests/gobject/docs/tester-sections.txt:
265 * tests/gobject/src/giface.c:
266 * tests/gobject/src/gobject.c:
267 * tests/gobject/src/gobject.h:
268 Add some since: tags for the tests too.
270 2008-06-02 Stefan Kost <ensonic@users.sf.net>
273 tody up and add some comments regarding HTML_DIR.
276 HTML_DIR is not neccesarily set.
281 * tests/gobject/docs-tmpl/tester-docs.xml:
282 * tests/gobject/docs/tester-docs.xml:
283 Add more chapter id's and experiment with an index chapter.
285 2008-06-02 Stefan Kost <ensonic@users.sf.net>
288 Improve spacing on indicies and glossaries.
290 2008-06-02 Stefan Kost <ensonic@users.sf.net>
293 * tests/bugs/docs/tester-docs.xml:
294 * tests/gobject/docs/tester-docs.xml:
295 * tests/gobject/docs/tester-sections.txt:
296 * tests/gobject/docs-tmpl/tester-docs.xml:
297 * tests/gobject/docs-tmpl/tester-sections.txt:
298 * tests/gobject/src/gobject.c:
299 * tests/gobject/src/gobject.h:
300 * tests/gtk-doc.make:
301 * tests/gtk-doc.notmpl.make:
302 Add some index lists to the tests. Add a deprecated function.
304 2008-06-02 Stefan Kost <ensonic@users.sf.net>
306 patch by: Felix Riemann <friemann@svn.gnome.org>
310 Produce valid html. Fixes #534627.
312 2008-05-23 Stefan Kost <ensonic@users.sf.net>
315 * tests/gobject/Makefile.am:
316 * tests/gobject/docs-tmpl/Makefile.am:
317 * tests/gobject/docs-tmpl/tester-docs.xml:
318 * tests/gobject/docs-tmpl/tester-sections.txt:
319 * tests/gobject/docs-tmpl/tester.types:
320 * tests/gtk-doc.make:
321 * tests/gtk-doc.notmpl.make:
322 Build same docs once again with old tmpl approach.
324 2008-05-23 Stefan Kost <ensonic@users.sf.net>
326 * tests/bugs/docs/Makefile.am:
327 * tests/gobject/docs/Makefile.am:
328 * tests/gtk-doc.make:
329 * tests/gtk-doc.notmpl.make:
332 2008-05-08 Stefan Kost <ensonic@users.sf.net>
336 Fix a long standing bug that killed spaces in tmpl files.
338 2008-05-05 Stefan Kost <ensonic@users.sf.net>
341 Fix regexps changes from previous commit. When using /e the
342 replacement part has to be a perl snippet.
344 2008-05-05 Stefan Kost <ensonic@users.sf.net>
347 * tests/bugs/docs/tester-sections.txt:
348 * tests/bugs/src/tester.h:
349 Don't expand '#' in ulink tags. Also allow to escape "#%@" with '\'.
350 Add to testsuite. Fixes #530758
352 2008-05-05 Stefan Kost <ensonic@users.sf.net>
355 It is GObject not GtkObject anymore
357 2008-05-05 Stefan Kost <ensonic@users.sf.net>
360 Make note about expanding urls.
362 * help/manual/C/gtk-doc-manual.xml:
363 Document the use of |[ ]| as a shortcut for program listing.
365 * tests/gobject/src/giface.h:
366 * tests/gobject/src/gobject.c:
367 Fix one undocumented symbol and add an exampl of the programlisting
370 2008-04-23 Stefan Kost <ensonic@users.sf.net>
372 reviewed by: <delete if not using a buddy>
373 patch by: <delete if not someone else's patch>
379 2008-04-22 Stefan Kost <ensonic@users.sf.net>
382 We need to update the webpage.
389 Hopefully now unbreak the docbuild, if one has template but not uses
392 2008-04-17 Stefan Kost <ensonic@users.sf.net>
395 Add one more warning. Also trac location of section docs. Merge
396 source symbols once and then on demand (if we read a template).
398 2008-04-11 Stefan Kost <ensonic@users.sf.net>
402 Idea about the tracing. Not that practical as it is.
406 Unify file-error messages. Improve warning detail. Fix undocumented
407 status for template less runs.
409 2008-04-10 Stefan Kost <ensonic@users.sf.net>
414 * gtkdoc-common.pl.in:
415 Add common method for prining (gcc-style) warnings.
418 Use new method. Harmonize the warnings a bit. Remember locations
419 symbols are taken from template files for use in warnings.
421 2008-04-09 Stefan Kost <ensonic@users.sf.net>
427 Print file/line number in warning.
429 * help/manual/C/gtk-doc-manual.xml:
430 Some docs for what the <module>-overrides.txt file is for.
432 2008-03-23 Stefan Kost <ensonic@users.sf.net>
435 Tell automake to not warn us about portabillity issues. Its too late
439 Surgery for the bugnumber.
441 2008-03-21 Marc-Andre Lureau <marcandre.lureau@gmail.com>
443 * .svnignore, Makefile.am, autogen.sh, configure.in,
444 help/manual/.svnignore, help/manual/C/ChangeLog,
445 help/manual/C/Makefile.am, help/manual/C/gtk-doc-manual-C.omf.in,
446 help/manual/C/gtk-doc-manual.xml, help/manual/ChangeLog,
447 help/manual/Makefile.am, help/manual/gtk-doc-manual.omf.in,
448 m4/.svnignore, omf.make, xmldocs.make:
449 GNOME doc-utils migration. Fixes #335239
451 2008-03-22 Stefan Kost <ensonic@users.sf.net>
455 * help/manual/C/gtk-doc-manual.xml:
460 2008-03-19 Stefan Kost <ensonic@users.sf.net>
467 Add fix for footnote positions.
469 2008-02-27 Stefan Kost <ensonic@users.sf.net>
471 patch by: Carlos Garnacho <carlos@imendio.com>
474 Update emacs mode to work with emacs22. Fixes #513318.
476 2008-02-01 Stefan Kost <ensonic@users.sf.net>
478 * gtkdoc-common.pl.in:
481 * tests/bugs/src/tester.h:
482 Improve tmpl parsing and add some more logging. Fixes #512154.
484 2008-01-30 Stefan Kost <ensonic@users.sf.net>
486 * tests/bugs/docs/tester-sections.txt:
487 * tests/bugs/src/tester.h:
488 Add testcase for #512154.
490 2008-01-28 Stefan Kost <ensonic@users.sf.net>
493 Condense all the multiple newlines in the generated xml.
495 * tests/gtk-doc.make:
496 Make sure the testsuite call the uninstalled scripts.
498 2008-01-24 Stefan Kost <ensonic@users.sf.net>
501 Unbreak fixxref. The index.sgml file should not have leading
502 whitespace. These were caused by indenting the xsl, which is dangerous
503 in case of <xsl:text>.
508 2008-01-21 Stefan Kost <ensonic@users.sf.net>
510 * gtkdoc-common.pl.in:
511 Don't warn when parsing enum struct members.
513 2008-01-21 Stefan Kost <ensonic@users.sf.net>
517 Give file and line number when complaining about duplicate
518 definitions. Seems to not have been applied with older commit.
521 * tests/gobject/src/gobject.h:
522 Handle typedef enums.
524 2008-01-17 Stefan Kost <ensonic@users.sf.net>
527 * gtk-doc.notmpl.make:
528 Don't fail in dist when no .types file is present. Fixes #509539.
530 2008-01-16 Stefan Kost <ensonic@users.sf.net>
534 Give file and line number when complaining about duplicate
537 2008-01-14 Stefan Kost <ensonic@users.sf.net>
539 patch by: Joe Marcus Clarke <marcus@freebsd.org>
542 * gtk-doc.notmpl.make:
543 Do not abort the build, if gtk-doc is not installed. Fixes #508897
545 2007-12-20 Mathias Hasselmann <mathias@openismus.com>
548 Lower Python dependency to 2.3 (#503054). Just warn when Python
549 wasn't found. Print a configuration summary before leaving the
552 Do not install gtkdoc-depscan when Python wasn't found.
554 2007-12-20 Mathias Hasselmann <mathias@openismus.com>
557 Use old and/or pattern instead of the new ternary operator.
558 This drops the Python 2.5 dependency for that script.
559 Original patch by Frederic Peters. (#503054)
561 2007-12-17 Mathias Hasselmann <mathias@openismus.com>
564 Use AM_PATH_PYTHON instread of AC_PATH_PROG to find Python.
567 2007-12-17 Stefan Kost <ensonic@users.sf.net>
570 Render accronyms from docbook and glossary in html.
572 2007-12-17 Stefan Kost <ensonic@users.sf.net>
574 * tests/bugs/docs/tester-docs.sgml:
575 * tests/bugs/docs/tester-docs.xml:
576 * tests/gobject/docs/tester-docs.sgml:
577 * tests/gobject/docs/tester-docs.xml:
578 Add the xml instead of the sgml docs.
580 2007-12-12 Stefan Kost <ensonic@users.sf.net>
583 * gtk-doc.notmpl.make:
584 Revert last change and reopen #503119. Needs a different fix.
586 2007-12-12 Stefan Kost <ensonic@users.sf.net>
589 * gtk-doc.notmpl.make:
590 Use content_files as a dependency the sgml-build.stamp.
592 2007-12-11 Mathias Hasselmann <mathias@openismus.com>
595 Use colon as name-version-separator in book names.
597 2007-12-11 Mathias Hasselmann <mathias@openismus.com>
600 Also scan devhelp folders.
602 2007-12-11 Mathias Hasselmann <mathias@openismus.com>
605 Print reasonable error message when passing
606 non-existant files on command line.
608 2007-12-11 Stefan Kost <ensonic@users.sf.net>
610 patch by: Kouhei Sutou <kou@cozmixng.org>
613 Consitently use UTF-8 instead of US-ASCII for output encoding.
616 2007-12-10 Mathias Hasselmann <mathias@openismus.com>
621 Add gtkdoc-depscan, which resolves source code dependencies
622 by scanning devhelp2 books.
624 2007-12-10 Stefan Kost <ensonic@users.sf.net>
629 * gtk-doc.notmpl.make:
630 Remove left-over 'fi'.
632 2007-12-05 Stefan Kost <ensonic@users.sf.net>
635 * gtk-doc.notmpl.make:
636 Better fix for #501066.
638 2007-12-05 Stefan Kost <ensonic@users.sf.net>
641 Add first version of the schema.
644 Unbreak the devhelp2 file generation.
646 * tests/gtkdoctest.sh:
647 Add comment about doing schmea checks once they work.
649 2007-12-04 Stefan Kost <ensonic@users.sf.net>
652 * gtk-doc.notmpl.make:
653 Apply build flags cleanups from #498521. Spotted by
656 2007-12-04 Stefan Kost <ensonic@users.sf.net>
658 * tests/gobject/src/giface.c:
659 * tests/gobject/src/gobject.c:
660 Uhm, unbreak the links in the test docs.
662 2007-12-04 Stefan Kost <ensonic@users.sf.net>
664 * tests/gobject/src/giface.c:
665 * tests/gobject/src/gobject.c:
666 Little test cleanup. The bug was already fixed.
668 2007-12-04 Stefan Kost <ensonic@users.sf.net>
670 * tests/gobject/docs/tester-sections.txt:
671 * tests/gobject/docs/tester.types:
672 * tests/gobject/src/Makefile.am:
673 * tests/gobject/src/giface.c:
674 * tests/gobject/src/giface.h:
675 * tests/gobject/src/gobject.c:
676 * tests/gobject/src/gobject.h:
677 * tests/gobject/src/tester.c:
678 * tests/gobject/src/tester.h:
679 Refactor tests for #489279.
681 2007-12-04 Stefan Kost <ensonic@users.sf.net>
683 * gtkdoc-common.pl.in:
684 * tests/bugs/docs/tester-sections.txt:
685 * tests/bugs/src/tester.h:
686 Add testcase for #501038. Improve struct parsing to correctly finish
687 if the last line in struct declaration was a preprocessor statement.
690 2007-12-04 Stefan Kost <ensonic@users.sf.net>
692 patch by: David Nečas <yeti@physics.muni.cz>
694 * gtkdoc-common.pl.in:
695 * tests/bugs/docs/tester-sections.txt:
696 * tests/bugs/src/tester.c:
697 * tests/bugs/src/tester.h:
698 Handle forward typedef'd enums. Fixes #446648.
700 2007-12-02 Loïc Minier <lool@dooz.org>
703 * gtk-doc.notmpl.make:
704 Add double-quotes around `which gtkdoc-rebase` to prevent "test"
705 from failing with "/bin/sh: line 11: test: !=: unary operator
706 expected ". Fixes #501066.
708 2007-11-11 Stefan Kost <ensonic@users.sf.net>
710 patch by: David Nečas <yeti@physics.muni.cz>
714 Avoid generated node ids. Fixes #365913.
716 2007-11-11 Stefan Kost <ensonic@users.sf.net>
721 Alternative and cleaner footer implementation (unblock #365913).
723 2007-11-11 Stefan Kost <ensonic@users.sf.net>
725 patch by: David Nečas <yeti@physics.muni.cz>
728 * gtkdoc-scangobj.in:
729 Display proper types for pointer properties. Fixes #468278.
731 2007-10-31 Stefan Kost <ensonic@users.sf.net>
734 Only warn about missing deprecation guards for declared symbols.
737 2007-10-31 Stefan Kost <ensonic@users.sf.net>
739 * tests/gtk-doc.make:
740 * tests/gtkdoctest.sh:
741 Run our own check script. Clean the make output a bit.
743 2007-10-31 Stefan Kost <ensonic@users.sf.net>
745 * help/manual/C/gtk-doc-manual.xml:
748 2007-10-31 Stefan Kost <ensonic@users.sf.net>
754 * tests/gtk-doc.make:
755 Cleanup the 'make check' deps configure check.
757 2007-10-01 Stefan Kost <ensonic@users.sf.net>
760 * help/manual/C/gtk-doc-manual.xml:
765 2007-09-30 Stefan Kost <ensonic@users.sf.net>
770 2007-09-27 Stefan Kost <ensonic@users.sf.net>
773 * gtk-doc.notmpl.make:
775 New day, new fix. Remove testing $(DESTDIR) from makefile and use
776 Getopt::Long qw(:config gnu_getopt); in rebase.
778 2007-09-26 Stefan Kost <ensonic@users.sf.net>
781 And actually saving before commiting might greatly help.
783 2007-09-26 Stefan Kost <ensonic@users.sf.net>
786 * gtk-doc.notmpl.make:
787 Another attempt to fix the rules.
789 2007-09-26 Stefan Kost <ensonic@users.sf.net>
792 * gtk-doc.notmpl.make:
793 If there is nothing to install, don't rebase.
795 2007-09-26 Stefan Kost <ensonic@users.sf.net>
798 * gtk-doc.notmpl.make:
799 Unbreak the last change.
801 2007-09-26 Stefan Kost <ensonic@users.sf.net>
804 * gtk-doc.notmpl.make:
805 Handle DESTDIR= case.
807 2007-09-26 Stefan Kost <ensonic@users.sf.net>
810 * gtk-doc.notmpl.make:
812 Fix destdir option name.
814 2007-09-25 Stefan Kost <ensonic@users.sf.net>
816 * tests/gtk-doc.make:
817 Get make distcheck fully working.
819 2007-09-25 Stefan Kost <ensonic@users.sf.net>
824 * tests/gtkdoctest.sh:
825 Try to get make distcheck to run.
827 * tests/gtk-doc.make:
828 Don't dist docs generated during test runs and remove some cruft.
831 2007-09-24 Stefan Kost <ensonic@users.sf.net>
833 patch by: David Nečas <yeti@physics.muni.cz>
836 * tests/bugs/docs/Makefile.am:
837 * tests/gobject/docs/Makefile.am:
838 * tests/gtk-doc.make:
839 Adapt xml/ cleaning from gtk-doc.notmpl.make. Clean log files.
841 2007-09-24 Stefan Kost <ensonic@users.sf.net>
844 Current release notes.
846 2007-09-24 Stefan Kost <ensonic@users.sf.net>
851 * examples/Makefile.am:
853 * gtk-doc.notmpl.make:
854 Process files from DISTCLEANFILES in the dist-hooks.
856 2007-09-24 Stefan Kost <ensonic@users.sf.net>
858 patch by: David Nečas <yeti@physics.muni.cz>
861 Add gtk-doc.notmpl.make to EXTRA_DIST. Fixes #479913.
863 2007-09-20 Stefan Kost <ensonic@users.sf.net>
866 Revert online option for fixxref now that we have a rebase command.
868 2007-09-18 Stefan Kost <ensonic@users.sf.net>
871 Handle function pointers. Fixes #477532.
873 2007-09-18 Stefan Kost <ensonic@users.sf.net>
875 patch by: David Nečas <yeti@physics.muni.cz>
878 Parse reoccuring const. Fixes #471014.
880 * tests/bugs/docs/Makefile.am:
881 * tests/bugs/docs/tester-sections.txt:
882 * tests/bugs/src/tester.c:
883 * tests/bugs/src/tester.h:
884 * tests/gobject/docs/Makefile.am:
885 * tests/gobject/src/tester.c:
886 * tests/gobject/src/tester.h:
887 Add more tests and cleanup the test-code a little.
889 2007-09-17 Stefan Kost <ensonic@users.sf.net>
892 * gtk-doc.notmpl.make:
893 Revert some Makefile improvements, as we can't control the quoting
896 2007-09-11 Stefan Kost <ensonic@users.sf.net>
899 Default master doc should have proper extension. Fixes #467773.
901 2007-09-11 Stefan Kost <ensonic@users.sf.net>
903 patch by: David Nečas <yeti@physics.muni.cz>
906 * gtk-doc.notmpl.make:
907 Makefile improvements.
909 2007-09-03 Stefan Kost <ensonic@users.sf.net>
912 Update MAINTAINER to adhere to rules given on
913 http://live.gnome.org/MaintainersCorner#maintainers
915 2007-08-23 Benjamin Otte <otte@gnome.org>
918 sync with gtkdoc-mkdb completely. Really fixes #419997
920 2007-08-21 Stefan Kost <ensonic@users.sf.net>
924 Add divider and empty space at the bottom. Mostly fixes #448879.
926 2007-08-21 Stefan Kost <ensonic@users.sf.net>
929 * gtk-doc.notmpl.make:
930 Make use of rebase if possible. Fixes #465920
933 Rebase improvements and fixes.
935 2007-08-16 Stefan Kost <ensonic@users.sf.net>
939 * help/manual/.cvsignore:
940 * help/manual/C/.cvsignore:
941 Get rid of cvsignore files.
943 2007-08-14 Stefan Kost <ensonic@users.sf.net>
945 * gtkdoc-common.pl.in:
946 * tests/bugs/docs/tester-sections.txt:
947 * tests/bugs/src/tester.h:
948 Don't die when encountering #if/#endif in enums. Fixes #324535.
950 2007-08-14 Stefan Kost <ensonic@users.sf.net>
952 patch by: Frederic Peters <fpeters@0d.be>
957 2007-08-14 Stefan Kost <ensonic@users.sf.net>
959 * help/manual/C/gtk-doc-manual.xml:
960 Document new features and bump version.
962 2007-08-13 Stefan Kost <ensonic@users.sf.net>
965 Fix the funny side-effect of last 'broken-returns' fix.
967 2007-08-13 Stefan Kost <ensonic@users.sf.net>
970 * tests/bugs/src/tester.h:
973 2007-08-13 Stefan Kost <ensonic@users.sf.net>
976 Now the 'broken' returns seems to work better. Fixes #380824 more.
978 2007-08-13 Stefan Kost <ensonic@users.sf.net>
980 * tests/bugs/docs/tester-sections.txt:
981 * tests/bugs/src/tester.c (bug_379466, bug_380824):
982 * tests/bugs/src/tester.h (test):
984 * tests/gtkdoctest.sh:
987 2007-08-12 Stefan Kost <ensonic@users.sf.net>
989 * tests/bugs/docs/tester-sections.txt:
990 * tests/bugs/src/tester.h:
991 Add another test for a bug we fixed with the changes below.
994 2007-08-12 Stefan Kost <ensonic@users.sf.net>
997 * tests/bugs/docs/tester-sections.txt:
998 * tests/bugs/src/tester.c:
999 * tests/bugs/src/tester.h:
1000 Improved scan logic. Fixes #411739.
1002 2007-08-12 Stefan Kost <ensonic@users.sf.net>
1005 * tests/bugs/src/tester.h:
1006 Handle newline in declarations better. Fixes #379466.
1007 Ensure space in multiline declarations when removing the newline.
1008 Fix missing argument docs in template free build.
1010 2007-08-12 Stefan Kost <ensonic@users.sf.net>
1014 Handle "unsigned long|unsigned short|signed long|signed short".
1017 2007-08-12 Stefan Kost <ensonic@users.sf.net>
1023 Replacing my shell based test script by Davids perl based one. Add
1024 licence, copyright and docs header. Integrate with build.
1026 2007-08-12 Stefan Kost <ensonic@users.sf.net>
1028 patch by: David Nečas <yeti@physics.muni.cz>
1030 * gtkdoc-scangobj.in:
1031 Make introspection of interfaces work in more cases. Fixes #355352.
1033 2007-08-12 Stefan Kost <ensonic@users.sf.net>
1035 patch by: David Nečas <yeti@physics.muni.cz>
1038 Cleanup glib detection for tests.
1040 2007-08-11 Stefan Kost <ensonic@users.sf.net>
1043 Fix modulename check.
1045 2007-08-11 Stefan Kost <ensonic@users.sf.net>
1048 Install new makefile.
1051 Bump version as we're working on 1.9.
1054 Add option to select makefile-flavour.
1056 2007-08-11 Stefan Kost <ensonic@users.sf.net>
1059 Add dummy rule to make first build run through. Fixes #156643
1061 2007-08-11 Stefan Kost <ensonic@users.sf.net>
1064 Hide fixed navigationbar when printing. Fixes #449618
1066 2007-08-11 Stefan Kost <ensonic@users.sf.net>
1068 * gtk-doc.notmpl.make:
1069 Add new makefile for tmpl-less build.
1071 2007-08-11 Stefan Kost <ensonic@users.sf.net>
1073 patch by: David Nečas <yeti@physics.muni.cz>
1076 Accepts automake 1.10 too. Fixes #459225
1078 2007-08-11 Stefan Kost <ensonic@users.sf.net>
1081 Make the tmpl-less build work.
1083 * tests/gtk-doc.make:
1084 Switch again to the tmpl-less build.
1086 2007-08-10 Stefan Kost <ensonic@users.sf.net>
1088 patch by: Rouslan Solomakhin <rouslan@solomakhin.net>
1093 2007-08-10 Stefan Kost <ensonic@users.sf.net>
1096 * tests/gtk-doc.make:
1097 Revert fix for #433338 and reopen bug. Breaks if file is not there,
1098 e.g. if --rebuild-types is used.
1100 2007-08-10 Stefan Kost <ensonic@users.sf.net>
1105 * tests/gtk-doc.make:
1106 Try the tmpl free build here.
1108 2007-08-10 Stefan Kost <ensonic@users.sf.net>
1110 * examples/Makefile.am:
1111 Add commented out TESTS.
1114 Check for location of gtkdoc-check.
1118 Test doc status and print result in check like layout.
1120 2007-08-02 Stefan Kost <ensonic@users.sf.net>
1122 patch by: Sven Herzberg <herzi@gnome-de.org>
1125 * tests/gtk-doc.make:
1126 Rebuild documentation of $(DOC_MODULE).types changed. Fixes #433338
1128 2007-08-02 Stefan Kost <ensonic@users.sf.net>
1130 patch by: David Nečas <yeti@physics.muni.cz>
1135 Allow rebasing cross-references in generated docs. Fixes #434134.
1137 2007-08-02 Stefan Kost <ensonic@users.sf.net>
1140 Add a hack to gtkdoc-mkhtml to run uninstalled too.
1142 2007-08-02 Stefan Kost <ensonic@users.sf.net>
1144 Patch by: David Nečas <yeti@physics.muni.cz>
1147 Generate ONLINE tag in index.sgml.
1149 * gtkdoc-fixxref.in:
1150 Allow to base links against online versions of xreffed docs.
1154 Add releaseinfo to doctemplates.
1156 * tests/bugs/docs/tester-docs.sgml:
1157 * tests/gobject/docs/tester-docs.sgml:
1160 2007-08-02 Stefan Kost <ensonic@users.sf.net>
1162 * tests/bugs/docs/Makefile.am:
1163 * tests/gobject/docs/Makefile.am:
1164 * tests/gtk-doc.make:
1165 Use PERL5LIB envvar to use uninstalled gtkdoc-common.pl for tests.
1166 Use tee to both show and redirect logs.
1167 Build test-docs in check-local instead of all-local.
1170 2007-07-25 Stefan Kost <ensonic@users.sf.net>
1174 Some more debug prints and code cleaning.
1176 2007-07-23 Stefan Kost <ensonic@users.sf.net>
1178 Patch by: Yeti <yeti@physics.muni.cz>
1182 Report undeclared symbols into a file. Fixes #436565.
1184 2007-07-18 Stefan Kost <ensonic@users.sf.net>
1187 Readd two debug prints and remove one obsolete one.
1189 * tests/bugs/Makefile.am:
1190 * tests/gobject/Makefile.am:
1191 Enforce 'make clean' before 'make check'.
1193 2007-07-18 Stefan Kost <ensonic@users.sf.net>
1195 Patch by: Yeti <yeti@physics.muni.cz>
1198 Cleanup broek-return handling and add ignore_broken_returns for
1199 section docs. Fixes #457077
1201 * tests/bugs/docs/Makefile.in:
1202 * tests/gobject/docs/Makefile.in:
1205 * tests/gtk-doc.make:
1206 Use the local tools so that 'make check' works uninstalled.
1209 2007-07-18 Stefan Kost <ensonic@users.sf.net>
1211 * tests/bugs/docs/tester-sections.txt:
1212 * tests/bugs/src/tester.c: (bug_419997):
1213 * tests/bugs/src/tester.h:
1214 * tests/gobject/src/tester.c: (gtkdoc_tester_class_init):
1215 * tests/gobject/src/tester.h:
1216 Add more test cases.
1218 2007-07-17 Stefan Kost <ensonic@users.sf.net>
1220 * tests/bugs/docs/Makefile.in:
1221 * tests/bugs/docs/tester-sections.txt:
1222 * tests/bugs/src/tester.c: (bug_141869_a), (bug_141869_b),
1223 (bug_379466), (bug_445693):
1224 * tests/bugs/src/tester.h:
1225 * tests/gtk-doc.make:
1226 * tests/gtkdoctest.sh:
1229 2007-07-17 Stefan Kost <ensonic@users.sf.net>
1231 Patch by: Yeti <yeti@physics.muni.cz>
1233 * gtkdoc-common.pl.in:
1237 Improve paramenter parsing to allow parameter names that contain
1238 const or restricted. Fixes #419997
1239 Also fix the signed/unsigned more.
1241 2007-07-17 Stefan Kost <ensonic@users.sf.net>
1246 * tests/Makefile.am:
1248 * tests/bugs/Makefile.am:
1249 * tests/bugs/docs/Makefile.am:
1250 * tests/bugs/docs/Makefile.in:
1251 * tests/bugs/docs/tester-docs.sgml:
1252 * tests/bugs/docs/tester-sections.txt:
1253 * tests/bugs/docs/tester.types:
1254 * tests/bugs/src/Makefile.am:
1255 * tests/bugs/src/tester.c: (bug_445693), (bug_141869_a),
1257 * tests/bugs/src/tester.h:
1259 * tests/gobject/Makefile.am:
1260 * tests/gobject/docs/Makefile.am:
1261 * tests/gobject/docs/Makefile.in:
1262 * tests/gobject/docs/tester-docs.sgml:
1263 * tests/gobject/docs/tester-sections.txt:
1264 * tests/gobject/docs/tester.types:
1265 * tests/gobject/src/Makefile.am:
1266 * tests/gobject/src/tester.c: (gtkdoc_tester_new),
1267 (gtkdoc_tester_get_property), (gtkdoc_tester_set_property),
1268 (gtkdoc_tester_class_init), (gtkdoc_tester_get_type):
1269 * tests/gobject/src/tester.h:
1270 * tests/gtk-doc.make:
1271 * tests/gtkdoctest.sh:
1272 Add test-suite. Fixes #457173
1274 2007-07-16 Stefan Kost <ensonic@users.sf.net>
1276 Patch by: Yeti <yeti@physics.muni.cz>
1279 Avoid useless $return_start access.
1281 2007-07-16 Stefan Kost <ensonic@users.sf.net>
1283 Patch by: Petteri Räty <betelgeuse@gentoo.org>
1286 Make gtk-doc.m4 fail when needed gtk-doc is not installed and notify
1287 user. Fixes #323938 and #450338.
1289 2007-07-15 Stefan Kost <ensonic@users.sf.net>
1293 Handle signed/unsigned without int. Fixes #141869.
1295 2007-07-15 Stefan Kost <ensonic@users.sf.net>
1297 Patch by: Yeti <yeti@physics.muni.cz>
1300 Improve handling of legacy "return" statement doc parsing. Warn about
1303 2007-07-15 Stefan Kost <ensonic@users.sf.net>
1306 Fix perl warning about usage of undefined symbol.
1308 2007-07-15 Stefan Kost <ensonic@users.sf.net>
1312 Sync the function decl arg parsing. Fixes #419308.
1314 2007-07-15 Stefan Kost <ensonic@users.sf.net>
1316 * gtkdoc-fixxref.in:
1317 Improve the ---help output a little.
1319 2007-07-15 Stefan Kost <ensonic@users.sf.net>
1321 * gtkdoc-fixxref.in:
1322 Improve detection of absolute/relatives paths. Skip duplicate paths.
1325 2007-06-14 Lo�c Minier <lool@dooz.org>
1328 Cleanup $(DOC_MODULE)-undocumented.txt files in
1329 maintainer-clean-local. Fixes #415388.
1331 2007-06-14 Lo�c Minier <lool@dooz.org>
1334 Fix warnings in m4 macros when running "autoreconf -fi -Wall";
1335 Guillem Jover. Fixes #428596.
1337 2007-06-11 Damon Chaplin <damon@gnome.org>
1339 * gtkdoc-mkdb.in (ExpandAbbreviations): just output "signal" and
1340 "property" as the text for cross-reference links to signals and
1341 properties, rather than something like "Object::signal" which can get
1342 a bit long. Also tidied up the code a little.
1343 (GetArgs): put the " inside the literal element.
1344 (GetSignals): use a literal element for the signal name in the title,
1345 to match the properties.
1347 2007-03-16 Stefan Kost <ensonic@users.sf.net>
1349 * gtkdoc-common.pl.in: handle preprocessor statements in enum and
1350 struct declarations. Fixes #418027.
1352 2007-02-27 Stefan Kost <ensonic@users.sf.net>
1354 * gtk-doc.xsl: create toc for part and reference
1356 * style.css: Fix placement of div.reference
1360 2007-02-16 Damon Chaplin <damon@gnome.org>
1364 2007-02-16 Damon Chaplin <damon@gnome.org>
1366 * gtkdoc-scan.in: only rebuild the .types file automatically on the
1367 very first run (i.e. when there are no sections or types files).
1369 * gtkdoc-scangobj.in: skip gnome_keyring_item_info_get_type if it is
1370 in the .types file as it isn't a real GObject type. This is a hack to
1371 avoid breaking the GNOME build. See bug #386508.
1373 2007-02-11 Stefan Kost <ensonic@users.sf.net>
1375 * gtk-doc.xsl: fix prerequisite section in nav-header
1377 2007-02-07 Stefan Kost <ensonic@users.sf.net>
1379 * style.css: fixing footnote subscripts, make tables look nicer.
1382 2007-02-07 Damon Chaplin <damon@gnome.org>
1384 * gtk-doc.make: make $(DOC_MODULE)-sections.txt and
1385 $(DOC_MODULE)-overrides.txt depend on scan-build.stamp, so that
1386 parallel make works. #404122, Ed Catmur.
1388 2007-02-07 Damon Chaplin <damon@gnome.org>
1390 * gtkdoc-scangobj.in: don't return if !G_TYPE_IS_OBJECT (object_type)
1391 as that means interface properties don't get output. This was broken
1392 by the patch for #348058.
1394 2007-01-21 Damon Chaplin <damon@gnome.org>
1396 * gtkdoc-mkdb.in: added "--default-includes" option to specify the
1397 default "#include"s to place at the top of the synopsis of each
1398 section. Normally this is specified in a <INCLUDE>...</INCLUDE> line
1399 in MODULE-sections.txt, but if you are using the "--rebuild-sections"
1400 option to automatically rebuild the MODULE-sections.txt file you can't
1403 2007-01-21 Damon Chaplin <damon@gnome.org>
1405 * gtkdoc-mktmpl.in (ReadTemplateFile):
1406 * gtkdoc-mkdb.in (ReadTemplateFile): improved param regexp to handle
1407 weird macro vararg names like "format...". #398971.
1409 2007-01-16 Damon Chaplin <damon@gnome.org>
1411 * gtkdoc-mkdb.in: support "Include" setting in section docs in source
1412 code, same as <INCLUDE>...</INCLUDE> setting in sections.txt file.
1415 2007-01-16 Damon Chaplin <damon@gnome.org>
1417 * gtkdoc-mkdb.in (OutputMacro): try to line up multiple lines of
1418 arguments if possible. #384249
1420 2007-01-16 Damon Chaplin <damon@gnome.org>
1422 * gtkdoc-scan.in (ScanHeader): for headers marked private, return
1423 immediately so we don't add anything to the sections file. #395005.
1425 2007-01-16 Damon Chaplin <damon@gnome.org>
1427 * gtkdoc-mkdb.in: a number of changes to help when adding example code
1428 to the docs (#368382):
1430 a) Support CDATA in source code comments. (We don't touch anything in
1432 b) Support |[ ... ]| to include example code. (Just gets converted to
1433 <informalexample><programlisting>)
1434 c) Improve <programlisting> handling, by not inserting <para></para>
1435 and not expanding "()", "@" or "%". (It still expands '#' so people
1436 can use cross-references to any symbols if they want to.).
1437 d) Improve '#' links a bit by skipping symbols that look like C
1438 preprocessor directives (e.g. "#include").
1439 e) Improve '&' handling a bit by converting to '&' if it doesn't
1440 already look like the start of an entity reference.
1441 f) Added special case for "#include <xxxx>" in <programlisting> so the
1442 "<" and ">" get replaced by entities.
1444 * gtkdoc-mktmpl.in (ReadTemplateFile):
1445 * gtkdoc-mkdb.in (ReadTemplateFile): fixed param regexp so it handles
1446 "@...:" for varargs again. It also cleans up messed up template files
1449 2007-01-04 Damon Chaplin <damon@gnome.org>
1451 * gtk-doc.make (dist-hook): abort dist if html docs aren't generated.
1452 #166462, Gustavo Carneiro.
1454 2007-01-03 Damon Chaplin <damon@gnome.org>
1456 * gtkdoc-mkdb.in: improved output a little - made field widths larger,
1457 removed signal prototypes from synopsis, and capitalized all signal
1458 flags (to be consistent with argument capitalization). #384247,
1459 Hans Petter Jansson.
1461 2007-01-03 Damon Chaplin <damon@gnome.org>
1463 * gtkdoc-mktmpl.in (OutputDeclaration):
1464 * gtkdoc-mkdb.in (OutputFunction): fix parsing of "char * const"
1465 arguments, with an extra "\s*". #387681
1467 2007-01-03 Damon Chaplin <damon@gnome.org>
1470 * xmldocs.make: updated to new versions from gnome-common. #363622
1471 Also reverted the changes made for #316508 since they may cause
1472 problems. We'll let the scrollkeeper/gnome-common/autoconf people
1473 sort out that issue.
1475 2006-12-07 Ross Burton <ross@burtonini.com>
1477 * help/manual/C/gtk-doc-manual.xml:
1478 Add examples of how to document structs, properties and signals
1481 2006-12-04 Damon Chaplin <damon@gnome.org>
1483 * gtkdoc-scangobj.in: added a '--query-child-properties' argument to
1484 allow you to specify a function to return a list of child properties
1485 for a class (similar to GtkContainer child properties). #379203
1487 2006-10-16 Damon Chaplin <damon@gnome.org>
1489 * gtkdoc-scangobj.in: remove a shadow declaration to avoid compiler
1492 2006-10-15 Damon Chaplin <damon@gnome.org>
1494 * gtkdoc-scan.in: added a '--rebuild-sections' option that will
1495 automatically recreate the MODULE-sections.txt file each time.
1496 (This only works for projects with very neat header files.) #310494.
1498 2006-10-15 Damon Chaplin <damon@gnome.org>
1500 Bug #338517: Automatically creating/updating .types file:
1502 * gtkdoc-scan.in: added a '--rebuild-types' option which will
1503 automatically update the .types file using all _get_type() functions
1504 found in the headers. (It will also do this if no .types file is found,
1505 i.e. when gtk-doc is first run on a project.)
1507 * gtk-doc.make (scan-build.stamp): run gtkdoc-scan before
1508 gtkdoc-scangobj so we can use the generated .types file.
1510 * gtkdoc-scangobj.in: if the .types file doesn't have any #include
1511 directives, just output "extern GType *get_type();" declarations for
1512 each *_get_type() function.
1514 2006-10-14 Damon Chaplin <damon@gnome.org>
1516 * gtkdoc-mkdb.in (ExpandAbbreviationsExceptCDATA): new function used
1517 to expand abbreviations in extra files, but leaving CDATA sections
1518 as they are. (#360579)
1520 2006-10-14 Damon Chaplin <damon@gnome.org>
1522 * gtkdoc-mkdb.in (OutputSGML): Allow the section id to be set from
1523 within the source code "SECTION:" comment block. (#349855)
1525 2006-10-13 Damon Chaplin <damon@gnome.org>
1527 * style.css: added missing comma from previous fix (#360967).
1529 2006-10-13 Damon Chaplin <damon@gnome.org>
1531 * gtkdoc-mkdb.in (OutputSymbolTraits): new function to output the
1532 "Since" and "Stability Level:" paragraphs, with roles to allow
1533 XSLT styling. (#348046)
1535 2006-10-13 Damon Chaplin <damon@gnome.org>
1537 * gtkdoc-scangobj.in: support interfaces on non-GObject types.
1538 (#348058, Josh Parsons).
1540 2006-10-13 Damon Chaplin <damon@gnome.org>
1542 * gtkdoc-scangobj.in: make sure interfaces are initialized so the
1543 signals query works. (#355352)
1545 2006-10-13 Damon Chaplin <damon@gnome.org>
1547 * style.css: Make sure appendix title isn't obscured by navigation bar
1548 (#360967, Philip Kovacs).
1550 2006-09-09 Matthias Clasen <mclasen@redhat.com>
1552 * gtkdoc-scangobj.in (get_type_name): Don't set is_pointer
1553 to TRUE for enum and flags types. (#354880, Yevgen Muntyan)
1557 2006-07-29 Damon Chaplin <damon@gnome.org>
1561 2006-06-30 Damon Chaplin <damon@gnome.org>
1563 * gtkdoc-mkdb.in (ScanSourceFile): fix regexp to allow section names
1566 * gtk-doc.make (all-local, docs): added separate 'docs' target that can
1567 be used even when the '--disable-gtk-doc' configure option is used.
1569 2006-06-15 Jody Goldberg <jody@gnome.org>
1571 * gtkdoc-mkdb.in (OutputFunction) : finish off #341872
1572 Support 'T const * const *foo' and other more complex types.
1573 Support ptr2ptr2func as a func argument.
1574 'void foo (void (**func) (void))'
1575 * gtkdoc-mktmpl.in : ditto.
1577 (committed by Damon with minor changes to spacing so GTK+ docs are
1580 2006-06-09 Damon Chaplin <damon@gnome.org>
1583 * gtk-doc.xsl: use the 'role' attribute rather than the 'id' attribute
1584 to identify the different sections for the navigation bar, since 'id'
1585 must be unique throughout the entire document. Also fixed a few minor
1586 issues with the output. (#342861, Leonardo Boshell)
1588 2006-05-30 Damon Chaplin <damon@gnome.org>
1590 * gtkdoc-fixxref.in (FixHTMLFile): Use the 's' modifier to the
1591 substitution so we handle links spanning more than one line.
1594 2006-05-22 Damon Chaplin <damon@gnome.org>
1599 * help/manual/Makefile.am: use a separate Makefile.am for each
1600 subdirectory rather than using "SUBDIRS=help/manual/C".
1602 2006-05-21 Jody Goldberg <jody@gnome.org>
1604 * gtkdoc-common.pl.in (ParseStructDeclaration) : Support
1605 'long double foo' and
1606 'T const * const *foo' (#341872)
1607 * gtkdoc-mktmpl.in (OutputDeclaration) : handle ptrs to ptrs to
1608 functions 'void func (void (**ptr2ptr2func)(int a))'
1610 2006-05-21 Damon Chaplin <damon@gnome.org>
1612 * gtkdoc-mkdb.in (ScanSourceFile): don't check basename for '.[hc]'
1613 suffix since we allow other suffixes as well now. (#340199)
1615 * gtkdoc-mktmpl.in (OutputSignalTemplates): check if the parameter
1616 is actually in the source code comment block. If not, use the default
1617 name. Otherwise we were outputting an empty "@:" in the templates.
1618 (ReadTemplateFile): remove empty "@:" lines caused by above bug.
1620 2006-04-15 Damon Chaplin <damon@gnome.org>
1622 * xmldocs.make: use gtkdochelpdir rather than docdir to avoid clash
1623 with autoconf. (#316508)
1625 * tools/gtk-doc.el: Output "Returns:" rather than "Return value:",
1626 and a "C-x4s" binding for inserting a blank section header.
1628 * gtk-doc.make (sgml-build.stamp): added $(DOC_MODULE)-sections.txt
1629 to the dependencies, since although the templates depend on it, they
1630 may not be changed, but the XML should still be rebuilt.
1632 * gtkdoc-mkdb.in (ScanSourceFile): allow whitespace after "SECTION:".
1634 2006-04-13 Damon Chaplin <damon@gnome.org>
1636 * gtkdoc-mkdb.in (ReadArgsFile): When outputting a warning about a
1637 property, use a single colon ':', since that is what is used to
1638 document properties in the source code. (2 colons are used for signals)
1640 * gtk-doc.make (sgml-build.stamp): added $(HFILE_GLOB) here, to
1641 catch any new documentation in the headers.
1643 2006-04-12 Damon Chaplin <damon@gnome.org>
1645 * gtkdoc-mkdb.in (tagify2): strip special "-struct" suffix from
1646 text of links to widget structs.
1648 2006-04-09 Stefan Kost <ensonic@users.sf.net>
1651 fix link after live.gnome.org wiki changes
1655 2006-04-09 Damon Chaplin <damon@gnome.org>
1659 2006-03-29 Stefan Kost <ensonic@users.sf.net>
1661 * gtkdoc-scangobj.in:
1662 missing '*' for arg in signal prototype in docs (#335486)
1664 2006-03-26 Damon Chaplin <damon@gnome.org>
1666 * gtkdoc-mkdb.in (MergeSourceDocumentation): don't output warnings
1667 for overridden titles, since that happens a lot. (#320010)
1669 * configure.in: check for pkg-config >= 0.19.
1671 * Makefile.am (pkgconfigdir): put the .pc file in $(datadir) rather
1672 than $(libdir), since gtk-doc is architecture-independant. (#120950)
1674 * configure.in: removed the hard dependancy on openjade or jade, since
1675 XML is used mostly now rather than SGML. We just output a warning
1676 rather than an error if neither openjade or jade are found.
1678 2006-03-21 Stefan Kost <ensonic@users.sf.net>
1681 add sect1 to pages with top-page offset adjustment (#166363)
1683 2006-03-19 Damon Chaplin <damon@gnome.org>
1685 * gtkdoc-scan.in (ScanHeader): try to handle the start of function
1686 declarations spread over 3 lines. (#321708, Jorn Baayen)
1688 2006-03-19 Damon Chaplin <damon@gnome.org>
1690 (OutputOldParams): don't bother outputting unused parameters if they
1691 don't have any documentation as that is pointless.
1693 2006-03-19 Damon Chaplin <damon@gnome.org>
1695 * gtkdoc-mktmpl.in (ReadTemplateFile): Add a workaround for an old
1696 bug handling macros with arguments spread over several lines. (#318666)
1698 2006-03-19 Damon Chaplin <damon@gnome.org>
1700 * gtkdoc-mkdb.in (MakeIndexterms): Make sure we still output an index
1701 term if there isn't 'deprecated' or 'since' info.
1702 (#334851, Tommi Komulainen).
1704 2006-03-19 Damon Chaplin <damon@gnome.org>
1706 * gtkdoc-scan.in (ScanHeader): added "--ignore-decorators" option to
1707 ignore a list of declarators in function declarations.
1708 (#316512, Bertram Felgenhauer).
1710 2006-03-19 Damon Chaplin <damon@gnome.org>
1712 * gtkdoc-mkdb.in (GetSignals, GetArgs): call MakeIndexTerms() to make
1713 sure that signals appear in the deprecated/new symbol indices.
1714 (#332007, Tommi Komulainen).
1716 2006-03-19 Damon Chaplin <damon@gnome.org>
1718 * gtkdoc-mkdb.in (OutputEnum, ExpandAbbreviations, symbolify):
1719 allow use of '#Object::signal' and '#Object:property' to link to
1720 signals and properties, and add links to enum constant values.
1721 (#332483, Stefan Kost)
1723 2006-03-15 Matthias Clasen <mclasen@redhat.com>
1725 * gtkdoc-mkdb.in (MakeIndexterms): Create separate indexterms
1726 for different roles, since the docbook stylesheets don't handle
1727 multiple roles in one attribute. (#331586, Tommi Komulainen)
1731 2006-03-07 Damon Chaplin <damon@gnome.org>
1735 2006-03-06 Tommi Komulainen <tommi.komulainen@nokia.com>
1737 * gtkdoc-scan.in (ScanHeader): Print object name after <TITLE> in
1738 order to get get object hierarchy, signals and properties
1739 documentation appear automatically (#333380)
1741 2006-01-24 Stefan Kost <ensonic@users.sf.net>
1743 * gtkdoc-mkdb.in: patch from Damon Chaplin to fix signal flag parsing
1745 2006-01-08 Damon Chaplin <damon@gnome.org>
1747 * gtkdoc-mkdb.in: patch from Jonathan Blandford to add support for a
1748 "--source-suffixes" option so you can scan files with any suffixes
1749 you want (e.g. C++ files).
1751 2005-12-19 Matthias Clasen <mclasen@redhat.com>
1753 * gtkdoc-mktmpl.in: Use \w+: instead of \S+: when
1754 matching parameter names, so that @Deprecated:2.10:
1755 works in template files like in source code comments.
1757 * gtkdoc-mkdb.in: Add a missing "and" to the versioned
1760 2005-12-09 Stefan Kost <ensonic@users.sf.net>
1763 try more to downgrade devhelp for old file format
1765 2005-12-09 Stefan Kost <ensonic@users.sf.net>
1770 create a autoregen.sh
1774 generate two separate versions
1776 fix parsing const after type (#322556)
1778 fix parseing multiline macro heads (#320588)
1779 * gtkdoc-scangobj.in:
1780 allow additional root types (#323581)
1782 2005-12-05 Matthias Clasen <mclasen@redhat.com>
1784 * gtkdoc-mktmpl.in (OutputDeclaration):
1785 * gtkdoc-mkdb.in (OutputFunction): Allow parameters to be declared
1786 volatile (this happens in GLib nowadays)
1788 2005-10-11 Stefan Kost <ensonic@users.sf.net>
1791 remove left-over debug-print
1793 2005-10-10 Stefan Kost <ensonic@users.sf.net>
1797 enhance gtkdoc devhelp output (#318129)
1799 2005-10-05 Stefan Kost <ensonic@users.sf.net>
1801 * gtkdoc-common.pl.in:
1802 revert exchanging with  
1804 2005-10-04 Damon Chaplin <damon@gnome.org>
1806 * gtkdoc-scanobj.in: patch from Andrae Steiner to add missing ';'
1809 2005-09-29 Stefan Kost <ensonic@users.sf.net>
1812 additionally point people to the gnome-wiki
1815 don't warn on macros with return docs (#314267)
1817 2005-09-28 Matthias Clasen <mclasen@redhat.com>
1819 Show signal flags: (#316789)
1821 * gtkdoc-scangobj.in: Emit flags for signals
1822 as <FLAGS> element in $MODULE.signals
1824 * gtkdoc-mkdb.in: Emit signal flags similar
1827 * gtkdoc-mktmpl.in: Handle <FLAGS> here, too.
1829 2005-09-20 Stefan Kost <ensonic@users.sf.net>
1834 * doc/sections-file.txt:
1835 * doc/setting-up.txt:
1836 * doc/style-guide.txt:
1837 * gtkdoc-common.pl.in:
1838 adding a note about where the new docs are
1840 2005-09-15 Damon Chaplin <damon@gnome.org>
1842 * gtkdoc-scan.in (ScanHeader):
1843 * gtkdoc-mktmpl.in (OutputDeclaration):
1844 * gtkdoc-mkdb.in (OutputFunction): patch from dodji seketeli to handle
1845 functions returning explicit enums. (#303337)
1847 Patch from Stepan Kasal:
1849 * gtkdoc-mkhtml.in, gtkdoc-mkman.in, gtkdocize.in: Add datarootdir
1850 variable, for compatibility with future Autoconf releases.
1852 * configure.in (PACKAGE_DATA_DIR): Simplify the computation;
1853 use a local macro AC_DEFINE_DIR, based on a macro from Autoconf
1854 macro archive. (#313876)
1856 2005-09-15 Damon Chaplin <damon@gnome.org>
1858 * gtkdoc-scangobj.in: Patch from Stepan Kasal to avoid some gcc
1861 * gtkdoc-scanobj.in:
1862 * gtkdoc-scangobj.in: Use brackets around open() arguments to avoid
1863 precedence problems. (#314838)
1865 * gtkdoc-scanobj.in:
1866 * gtkdoc-scangobj.in: Output more messages about compilation, linking
1867 and running of scanner, to try to help track down any problems.
1868 Also use "sh -c" to run the scanner (#167688)
1870 * gtkdoc-scanobj.in:
1871 * gtkdoc-scangobj.in: patch from Stefan Kost to improve error messages,
1872 though I changed it slightly so it doesn't output errno.
1874 2005-09-09 Damon Chaplin <damon@gnome.org>
1878 * gtk-doc.xsl: Use a fixed navigation bar at the top of the page.
1879 Patch from Stefan Kost with minor changes by me. (#313569)
1881 2005-08-18 Damon Chaplin <damon@gnome.org>
1883 * gtkdoc-scangobj.in: added "const" in a few places to avoid lots
1884 of warnings if all gcc warnings are on. (#312985)
1886 2005-08-15 Stefan Kost <ensonic@users.sf.net>
1893 adding the infrastructure for installation of gtkdoc manual
1895 2005-08-12 Stefan Kost <ensonic@users.sf.net>
1898 fix warning about uninitialized var EXPAND_CONTENT_FILES
1900 Tue Aug 9 12:01:27 2005 tjlocal <timj@imendio.com>
1902 * autogen.sh: bail out with exit $? for failing programs.
1904 2005-07-26 Damon Chaplin <damon@gnome.org>
1906 * gtk-doc.make: Pass DOC_MAIN_SGML_FILE as the main filename to
1907 gtkdoc-mkdb. Avoids creating spurious foo.sgml files in an XML build.
1908 Patch from Malcolm Tredinnick. (#311344)
1910 Prefix build messages with "gtk-doc: " rather than surrounding them
1911 with "***" which looks like an error. (#170008)
1913 2005-07-26 Damon Chaplin <damon@gnome.org>
1915 * README: removed comment about not being able to add section
1916 documentation to source code files, which is not true any more.
1920 2005-07-03 Damon Chaplin <damon@gnome.org>
1924 2005-06-20 Matthias Clasen <mclasen@redhat.com>
1926 * gtkdoc-mkdb.in: Fix typos in warnings.
1928 2005-06-17 Mikael Hallendal <micke@imendio.com>
1930 * README: Updated Devhelp web address.
1932 2005-05-16 Matthias Clasen <mclasen@redhat.com>
1934 * gtkdoc-mkdb.in: Add "expand-content-files:s" to the GetOptions() call.
1936 2005-05-10 Owen Taylor <otaylor@redhat.com>
1938 * gtkdoc-mkdb.in: Add an --expand-content-files option
1939 to specify extra files to expand abbreviations in and
1940 copy into the output directory.
1942 * gtk-doc.make examples/Makefile.am: Add expand_content_files
1945 * gtkdoc-mktmpl.in (OutputTemplateFile): Add an
1946 --only-section-tmpl flag so that projects that keep everything
1947 but section descriptions inline can avoid cvs conflicts.
1949 * gtk-doc.make examples/Makefile.am: Add support for
1952 * configure.in: Up version to 1.4.
1954 2005-05-02 Matthias Clasen <mclasen@redhat.com>
1956 * gtkdoc-mkdb.in: Accept C comments between struct name
1957 and struct definition. GObject has an instance of this.
1959 2005-03-21 Matthias Clasen <mclasen@redhat.com>
1961 * gtk-doc.dcl: Allow ':' in names. (#169087)
1963 2005-03-21 James Henstridge <james@jamesh.id.au>
1965 * gtk-doc.xsl (encoding): output US-ASCII instead of ISO-8859-1.
1966 This ensures that the output will be display correctly when served
1967 as either ISO-8859-1 or UTF-8.
1969 2005-02-26 Sven Neumann <sven@gimp.org>
1971 * gtkdoc-mkdb.in (MakeIndexterms): allow space in Since: keywords,
1972 only strip leading and trailing whitespace (bug #168384).
1974 2005-02-16 Damon Chaplin <damon@gnome.org>
1976 * gtkdoc-mkdb.in (ScanSourceFile): add support for "@stability:"
1977 in the inline section docs (Brian Cameron).
1979 2005-02-07 Damon Chaplin <damon@gnome.org>
1981 * gtkdoc-mkdb.in (MergeSourceDocumentation): allow use of "@...:" in
1982 the source code as well as "@Varargs:". Patch from Benjamin Otte.
1985 2005-02-04 Damon Chaplin <damon@gnome.org>
1987 * gtkdoc-mkdb.in (ParseStabilityLevel): don't reset $stability if it
1988 isn't Stable/Unstable/Private (Brian Cameron).
1989 (ScanSourceFile): skip whitespace after "SECTION:".
1991 2005-02-01 Damon Chaplin <damon@gnome.org>
1993 * gtkdoc-mkdb.in (ScanSourceFile, MergeSourceDocumentation): patch
1994 from Stefan Kost to support section documentation within the source
1995 code (long description, short description, see also and title).
1998 * gtkdoc-mktmpl.in: patch from Brian Cameron to support stability
2001 * gtkdoc-mkdb.in (OutputFunction):
2002 * gtkdoc-mktmpl.in (OutputDeclaration):
2003 * gtkdoc-common.pl.in (ParseStructDeclaration): patch from Roger Leigh
2004 to add support for the "restrict" keyword.
2006 * gtkdoc-scan.in (ScanHeader): patch from Roger Leigh to add support
2007 for "unsigned" to one of the regexps.
2009 2005-01-31 Damon Chaplin <damon@gnome.org>
2011 * gtk-doc.make (scan-build.stamp): added "2>&1" to grep command to
2014 * gtkdoc-mkdb.in: patch from Stefan Kost to not add '<' '>' around
2015 include files that already have '"' '"' around them, and to try to
2016 gather more information about undocumented symbols. #164462.
2018 2005-01-28 Damon Chaplin <damon@gnome.org>
2020 * gtk-doc.make: use dist-hook rather than EXTRA_DIST to copy the
2021 $(DOC_MODULE).types file over, so we can skip this if it doesn't exist.
2024 2005-01-12 Damon Chaplin <damon@gnome.org>
2026 * README: patch from Stefan Kost to mention GObject classes
2027 and describe the transformation process to XML/SGML and HTML,
2028 and to mention Devhelp.
2032 2005-01-09 Damon Chaplin <damon@gnome.org>
2036 2005-01-09 Damon Chaplin <damon@gnome.org>
2038 * gtkdoc-mkdb.in (MergeSourceDocumentation): output better warnings
2039 using the type information. Patch from Stefan Kost. #161979
2041 * gtkdoc-scan.in (ScanHeader): support "typedef struct a *b;". Fixes
2042 last part of #156318.
2044 * gtkdoc-common.pl.in (ParseStructDeclaration): return an empty array
2045 for forward struct declarations. Part of #156318.
2048 * gtkdoc-mkdb.in: updated a few of the warnings to make them a bit
2049 easier to understand.
2051 2004-11-22 James Henstridge <james@jamesh.id.au>
2053 * acconfig.h: remove file, since we don't have a config.h
2055 * configure.in: make sure $ACLOCAL_FLAGS is passed to aclocal on a
2058 * autogen.sh: use Automake-1.9 if available, and call aclocal,
2059 autoconf, automake, etc in the same order as autoreconf does.
2061 * gtkdocize.in: if the AC_CONFIG_MACRO_DIR option is used in the
2062 configure script, copy gtk-doc.m4 to that directory in the source
2065 2004-11-16 Damon Chaplin <damon@gnome.org>
2067 * gtkdoc-mkdb.in (OutputFunction): output "const" rather than
2068 "G_CONST_RETURN". #157674.
2070 * gtkdoc-mktmpl.in (OutputDeclaration): skip "void" return types but
2071 not if it has modifiers e.g. "void *". #156963.
2073 * gtkdoc-scan.in (ScanHeader): handle __attribute__. Patch from
2074 Simon Josefsson. #156962.
2076 2004-10-31 Damon Chaplin <damon@gnome.org>
2078 * gtkdoc-mkdb.in (OutputStruct): handle opaque/forward struct
2079 declarations. #156318 again. Tiny fix to avoid warnings.
2081 2004-10-28 Damon Chaplin <damon@gnome.org>
2083 * gtkdoc-mktmpl.in (ReadDeclarationsFile):
2084 * gtkdoc-mkdb.in (ReadDeclarationsFile):
2085 * gtkdoc-scan.in (ScanHeader): handle opaque/forward struct
2086 declarations. #156318.
2088 2004-10-25 Damon Chaplin <damon@gnome.org>
2090 * gtkdoc-mkdb.in (OutputParamDescriptions): use a after Returns:
2091 so it doesn't break before the colon.
2093 2004-10-24 Damon Chaplin <damon@gnome.org>
2095 * gtkdoc-common.pl (ParseEnumDeclaration): handle "typedef enum XXX {"
2096 #156297. Patch from Simon Josefsson.
2098 2004-10-20 Damon Chaplin <damon@gnome.org>
2100 * gtkdoc-mkdb.in (ReadDeclarationsFile): set a flag to indicate a
2101 struct has a typedef declaration.
2102 (OutputStruct): better output for structs with typedefs. #83269.
2104 * gtkdoc-scan.in (ScanHeader): leave the struct declaration as it is.
2105 Don't strip out 'typedef'. Also allow simple "struct foo {".
2107 2004-10-19 Damon Chaplin <damon@gnome.org>
2109 * gtkdoc-fixxref.in: use pkg-config to find where GLib is installed
2110 and scan that directory for index files. Also scan $GNOME2_PATH.
2111 These are only used as a last resort. If they are used we have to
2112 output links as absolute URLs, rather than the default relative ones.
2114 2004-10-18 Damon Chaplin <damon@gnome.org>
2116 * gtkdoc-common.pl.in (ParseStructDeclaration): support function
2117 pointers that return "foo const *" #141870.
2119 * gtkdoc-scan.in (ScanHeader):
2120 * gtkdoc-mkdb.in (OutputFunction):
2121 * gtkdoc-mktmpl.in (OutputDeclaration): handle functions with const
2122 or struct return types. #141870 and #148507.
2124 2004-10-15 Damon Chaplin <damon@gnome.org>
2126 * gtkdoc-common.pl.in (ParseStructDeclaration)
2127 (ParseEnumDeclaration): moved these here, rather than have 2 copies
2128 in gtkdoc-mkdb.in and gtkdoc-mktmpl.in.
2130 * gtkdoc-common.pl.in (ParseStructDeclaration): handle struct fields
2131 better. We can now handle things like *foo, ***bar, *baz[12][23],
2132 foo : 25 all on one line. Fixes part of #151219.
2133 Also support the 'short' modifier to fix #90565.
2134 And use $nbsp; rather than spaces to try to avoid splitting
2135 declarations in the output.
2136 Also take an extra arg specifying whether to include parameters in
2137 the function pointer fields.
2139 * gtkdoc-scan.in (ScanHeader): Deal with array types in typedefs.
2140 (Eg, "typedef unsigned char MD5Digest[16];") From Dan Winship.
2141 Last bit of #151219.
2143 2004-10-14 Damon Chaplin <damon@gnome.org>
2145 * gtkdoc-mkdb.in (CreateValidSGMLID): use ":CAPS" rather than
2146 "-CAPS" to distinguish all-caps identifiers, to avoid clashing with
2147 identifiers ending in _caps! Bug #113120.
2149 * gtkdoc-mkdb.in (MergeSourceDocumentation): if it looks like a
2150 parameter has been described, but not in the right place, output
2151 a better error message. Bug #141871.
2153 * gtkdoc-mkdb.in (OutputMacro, OutputFunction, GetSignals): allow
2154 the author to use <!--PARAMETERS--> to specify the position of the
2155 parameter table if they want. Hopefully good enough for bug #99567.
2156 (MergeSourceDocumentation): end the paragraph before <!--PARAMETERS-->
2157 and start a new one after it.
2159 * doc/authors.txt: document <!--PARAMETERS-->.
2161 * style.css: don't underline links normally, as we output lots of
2162 them and it makes it very cluttered. Only underline links when the
2163 mouse hovers over them, and change the color. Fixes #108037.
2165 * gtk-doc.make (scan-build.stamp): depend on $(CFILE_GLOB) as well,
2166 since changes in properties need to be picked up by gtkdoc-scangobj.
2169 * gtkdoc-mkdb.in: (ParseStructDeclaration): for fields that are
2170 function pointers, only return the function name, as otherwise the
2171 output gets really messy. Fixes #66618.
2176 * gtkdoc-scanobj.in:
2177 * gtkdoc-scangobj.in: use '@PACKAGE_DATA_DIR@' instead of
2178 "@PACKAGE_DATA_DIR@" so that it isn't interpolated. It failed when
2179 $prefix was /software/@sys/usr. Fixes #113456.
2181 2004-10-13 Damon Chaplin <damon@gnome.org>
2183 * gtkdoc-scanobj.in:
2184 * gtkdoc-scangobj.in: patch from Olexiy Avramchenko to add 3 new
2187 * gtkdoc-scanobj.in:
2188 * gtkdoc-scangobj.in: patch from Benjamin Otte to get rid of
2189 -Wsign-compare warnings. Bug #137013.
2191 Fri Sep 17 01:13:24 2004 Matthias Clasen <maclas@gmx.de>
2193 * gtk-doc.xsl: Add the images from the gallery on top
2194 of the refentry they point to.
2196 * style.css: Move the css bits of the gallery implementation
2199 Fri Sep 17 00:30:16 2004 Matthias Clasen <maclas@gmx.de>
2201 * gtk-doc.xsl: Don't generate <link rel="refentry">
2202 links, since e.g. the GTK+ docs contain MANY refentries.
2204 2004-09-10 Damon Chaplin <damon@gnome.org>
2206 * autogen.sh: support automake 1.8. (part of #151219).
2208 * examples/Makefile.am: require automake 1.6.
2210 * gtkdoc-scan.in: create an empty MODULE-overrides.txt file if it
2211 doesn't exist. gtkdoc.make expects one to exist.
2213 * doc/setting-up.txt: updated to document new procedure using
2216 * examples/Makefile.am: updated to use gtkdoc.make.
2218 * examples/configure.in: removed this. gtkdoc.make is used instead
2221 * examples/README: updated.
2223 * Makefile.am (EXTRA_DIST): removed examples/configure.in.
2225 Wed Sep 8 01:12:25 2004 Matthias Clasen <maclas@gmx.de>
2227 * gtkdoc-scan.in (ScanHeader):
2228 * gtkdoc-mktmpl.in (OutputDeclaration):
2229 * gtkdoc-mkdb.in (OutputFunction): Accept mixtures of *
2230 and const in return types.
2232 Wed Sep 01 05:58:08 2004 Matthias Clasen <maclas@gmx.de>
2234 * gtkdoc-mkdb.in: Remove a debug printf
2236 Tue Aug 24 02:30:08 2004 Matthias Clasen <maclas@gmx.de>
2238 * gtk-doc.xsl: Add support for a gallery of widget images.
2240 Wed Jul 28 13:00:54 2004 Jonathan Blandford <jrb@gnome.org>
2242 * gtk-doc.xsl: remove the examples from the toc.
2244 2004-07-28 Damon Chaplin <damon@gnome.org>
2246 * doc/sections-file.txt: mention use of '#' for comments.
2248 * gtkdoc-mkdb.in: removed HEADER_FILE stuff, since it isn't used now.
2250 2004-07-23 Damon Chaplin <damon@gnome.org>
2252 * examples/Makefile.am (all-local): add empty all-local target for
2253 when ENABLE_GTK_DOC is false. (#148209, Martin Quinson)
2255 Fri Jul 23 13:21:34 2004 Matthias Clasen <maclas@gmx.de>
2257 * gtkdoc-mkdb.in (ScanSourceFile): Fix regexps for matching
2258 ignored files. (#148211, Martin Quinson)
2260 2004-07-03 Matthias Clasen <mclasen@redhat.com>
2262 * style.css: Add a missing '}' and align arguments to the
2263 top of their descriptions. (#145363, #145364, Mariano
2266 2004-05-18 Matthias Clasen <mclasen@redhat.com>
2268 * gtk-doc.xsl: Let the docbook stylesheets generate
2269 extra <link rel=...> elements. (#140221, Geert Stappers)
2271 2004-05-10 Geert Stappers <stappers@stappers.nl>
2273 * TODO: new file, basicly a reference to bugzilla.
2275 * examples/README: tell about gtk-doc.make.
2277 2004-05-06 Geert Stappers <stappers@stappers.nl>
2279 * MAINTAINERS: Add myself.
2281 2004-05-05 Matthias Clasen <mclasen@redhat.com>
2283 * gtk-doc.xsl: Correct the docbook stylesheet version
2284 in which filtered index support will appear to 1.66.
2286 2004-04-27 Geert Stappers <stappers@stappers.nl>
2288 * README: Updated the information on Debian packages.
2289 Removed old author and time stamp line.
2291 2004-04-21 Matthias Clasen <mclasen@redhat.com>
2293 * doc/sections-file.txt: Add hint about private types.
2297 * MAINTAINERS: Add myself.
2299 * gtkdoc-mkdb.in (ReadKnownSymbols): New function which
2300 extracts information about public and private symbols from
2301 the $MODULE-sections.txt file.
2302 (ReadObjectHierarchy): Prune the tree, based on the information
2303 collected by ReadKnownSymbols.
2304 (ReadInterfaces): Also filter out private interfaces here
2305 (ReadPrerequisites): ...and here.
2307 2004-04-19 Matthias Clasen <mclasen@redhat.com>
2309 * Makefile.am: Add version-greater-or-equal.xsl.
2311 * version-greater-or-equal.xsl: New file, implementing
2312 the version-greater-or-equal template for comparing version
2315 * gtk-doc.xsl: Import version-greater-or-equal.xsl and
2316 use the version-greater-or-equal template to a) check that
2317 the xsl stylesheets are not too old and b) to avoid creating
2318 multiple indices if the xsl stylesheets don't support filtered
2321 * gtkdoc-mkdb.in (MakeIndexterms): Emit role attributes
2322 on indexterms which can be used to create filtered indices
2323 with sufficiently new xsl stylesheets. The required functionality
2324 will appear in version 1.62 of the xsl stylesheets. (#115530)
2326 2004-04-16 Matthias Clasen <mclasen@redhat.com>
2328 * style.css: Style information in a separate stylesheet.
2330 * gtkdoc-mkhtml.in: Copy css files.
2332 * Makefile.am (gtkdocdata_DATA): Add style.css
2334 * gtk-doc.xsl: Use a stylesheet instead of hardwiring
2335 styles. (#134683, Vincent Torri)
2337 * gtkdoc-mkdb.in (GetSignals): Organize the properties
2338 descriptions to fit better with the other sections, and
2339 also display information about allowed and default values.
2341 2004-04-15 Matthias Clasen <mclasen@redhat.com>
2343 * gtkdoc-scangobj.in: Use introspection more fully to emit
2344 allowed ranges for integral types and default values.
2346 * gtkdoc-mkdb.in (GetSignals): Handle missing signal parameter
2349 2004-03-04 Damon Chaplin <damon@gnome.org>
2351 * autogen.sh: fixed URLs to download autoconf/automake/libtool.
2352 Patch from Frederic L. W. Meunier.
2354 2004-02-16 Damon Chaplin <damon@gnome.org>
2356 * .cvsignore: added gtk-doc.cat and gtkdocize.
2360 2004-02-16 Damon Chaplin <damon@gnome.org>
2364 2004-02-16 Damon Chaplin <damon@gnome.org>
2366 * gtk-doc.cat.in: removed public ID for gtk-doc.dtd, since we don't
2369 Sat Feb 14 02:14:27 2004 Matthias Clasen <maclas@gmx.de>
2371 * gtk-doc.m4: Avoid unnecessary checks if gtk-doc is
2372 disabled. (#134221, Julio M. Merino Vidal)
2374 Sat Feb 14 02:03:01 2004 Matthias Clasen <maclas@gmx.de>
2376 * gtk-doc.make: Don't create unneeded empty
2377 directories. (#134319, Julio M. Merino Vidal)
2379 Sat Feb 14 01:37:38 2004 Matthias Clasen <maclas@gmx.de>
2381 * gtk-doc.make: Add an empty all-local target to make it work
2382 with non-GNU make. (#134343, Julio M. Merino Vidal)
2384 Wed Jan 28 00:52:00 2004 Matthias Clasen <maclas@gmx.de>
2386 * gtkdoc-mkdb.in (OutputObjectList): Avoid emitting invalid
2387 docbook markup if there are no objects. Partial fix for #132661.
2389 Sun Jan 25 22:01:15 2004 Matthias Clasen <maclas@gmx.de>
2391 * gtkdoc-mkdb.in: Accept both the old and the new XInclude
2392 namespace. (#131675, Edd Dumbill)
2394 2004-01-23 Thomas Vander Stichele <thomas at apestaart dot org>
2396 * gtkdoc-mkhtml.in: exit when tools return non-zero so errors can
2399 Thu Jan 15 23:06:10 2004 Matthias Clasen <maclas@gmx.de>
2401 * gtk-doc.xsl: Set the chunk.fast parameter, to gain some
2404 Thu Jan 15 23:05:23 2004 Matthias Clasen <maclas@gmx.de>
2406 * gtkdoc-fixxref.in: Make it work again without explicit
2409 Sat Dec 27 01:36:08 2003 Matthias Clasen <maclas@gmx.de>
2411 * gtkdoc-scangobj.in:
2414 * gtkdoc-fixxref.in: Add --help. (#126915)
2416 Sat Dec 27 00:43:42 2003 Matthias Clasen <maclas@gmx.de>
2418 * gtkdoc-mkdb.in (ParseEnumDeclaration):
2419 * gtkdoc-mktmpl.in (ParseEnumDeclaration): Support a trailing ,
2420 in enum declarations. These are a GNU C extension, but also
2421 blessed by C99. (#129949, Thomas Vander Stichele)
2423 Sun Nov 16 00:29:03 2003 Matthias Clasen <maclas@gmx.de>
2425 * gtkdoc-scangobj.in: Don't use g_strdown(). (#127028,
2428 Sun Nov 16 00:26:05 2003 Matthias Clasen <maclas@gmx.de>
2430 * gtkdoc-scangobj.in: If compiled against GLib >= 2.3.0, look
2431 for properties on interfaces. (#127068, James M. Cape)
2433 2003-11-03 Dan Winship <danw@ximian.com>
2435 * gtkdoc-scangobj.in: Clean up $MODULE-scan.o even when using
2438 * gtkdoc-scanobj.in: Likewise
2440 * gtk-doc.make (CLEANFILES): Remove $(MODULE)-scan.o from here
2441 (clean-local): rm -rf .libs
2443 Wed Oct 8 01:21:54 2003 Matthias Clasen <maclas@gmx.de>
2445 * gtkdoc-scan.in (ScanHeader): Make gtkdoc-scan grok
2446 typedef struct { } foo; in addition to the more baroque
2447 typedef struct _foo foo; struct _foo { };
2448 (#116807, Malcolm Tredinnick)
2450 Wed Oct 8 01:21:35 2003 Matthias Clasen <maclas@gmx.de>
2452 * gtkdoc-mkdb.in (OutputParamDescriptions): Remove a pointless
2455 2003-10-01 Matthias Clasen <maclas@gmx.de>
2457 Make signals and properties end up in the right template
2458 file (#116569, Owen Taylor):
2460 * gtkdoc-mktmpl.in (OutputSignalTemplates):
2461 (OutputArgTemplates): Return a string rather than directly
2463 (OutputTemplateFile): Don't interpret $title as the name of
2464 the object to print signal and property templates for.
2465 (UpdateTemplates): Collect signal and property templates for all
2466 objects contained in the section.
2468 2003-08-10 James Henstridge <james@daa.com.au>
2470 * acinclude.m4 (JH_PATH_XML_CATALOG): allow caller to specify
2471 actions if found or not found.
2472 (JH_CHECK_XML_CATALOG): when requiring JH_PATH_XML_CATALOG, don't
2473 error out if it is not found.
2475 2003-08-03 Matthias Clasen <maclas@gmx.de>
2477 * doc/gnome.txt: Add some hints regarding markup of examples.
2479 2003-07-22 Matthias Clasen <maclas@gmx.de>
2482 * gtk-doc.cat: Fix a problem with the previous commit.
2484 2003-07-21 Matthias Clasen <maclas@gmx.de>
2486 Applied patches from Sebastian Rittau to add maintainer mode and an SGML catalog. (#117955, #117956)
2488 * gtk-doc.cat.in: New catalog file.
2489 * configure.in: Added gtk-doc.catalog to output files.
2490 * Makefile.am: Install gtk-doc.catalog.
2492 * configure.in: Added AM_MAINTAINER_MODE.
2493 * autogen.sh: Added --enable-maintainer-mode to configure options.
2495 2003-07-09 Matthias Clasen <maclas@gmx.de>
2497 * gtkdoc-mktmpl.in (ParseStructDeclaration):
2498 * gtkdoc-mkdb.in (ParseStructDeclaration): Accept volatile struct members, which have just
2499 made their appearance in glib.
2501 2003-06-29 Matthias Clasen <maclas@gmx.de>
2503 * gtkdoc-mkdb.in (ExpandAbbreviations): When expanding @param, catch the common @param->field
2504 and @param.field, to reduce the need for littering the C sources with <literal>foo->bar</literal>.
2506 2003-06-25 Matthias Clasen <maclas@gmx.de>
2508 Changes for #115528:
2510 * gtkdoc-mkdb.in (OutputSGML): Collect hierarchy, interfaces, implementations, prerequisites
2511 and derived interfaces separately.
2512 (OutputSGMLFile): Take two more arguments: implementations and derived interfaces.
2513 (GetHierarchy): Also put immediate children in the local tree.
2514 (GetInterfaces): Split into GetInterfaces and GetImplementations.
2515 (GetImplementations): New function to get the implementations of an interface.
2516 (GetDerived): New function to get the known derived interfaces of an interface.
2518 * gtkdoc-mkdb.in (MakeXRef): Accept a second, optional parameter for the
2520 (ExpandAbbreviations): Add semantic markup inside the links, so that
2521 non-crossreferenced symbols come out properly formatted after link
2524 2003-06-15 Matthias Clasen <maclas@gmx.de>
2526 Support for a flat index of all symbols. (#92861)
2527 To use, put an empty <index/> element in your driver document.
2529 * gtkdoc-mkdb.in (MakeIndexterms): New function, emits an indexterm.
2530 (OutputMacro, OutputTypedef, OutputStruct, OutputEnum,
2531 OutputUnion, OutputVariable, OutputFunction): Use MakeIndexterms.
2532 to emit indexterms for symbols.
2534 * gtkdoc-mkdb.in (GetSignals):
2535 (GetArgs): Emit Since: information for signals and properties.
2537 Thu Jun 12 15:55:57 2003 Owen Taylor <otaylor@redhat.com>
2539 * gtkdoc-mkhtml.in (declaration): Replace head -1 with -n 1.
2540 (Merge change by Elliot Lee from Red Hat package)
2542 2003-06-11 Matthias Clasen <maclas@gmx.de>
2544 * doc/gnome.txt: Updates to the documentation of inline comments.
2546 2003-06-03 Matthias Clasen <maclas@gmx.de>
2548 * gtk-doc.spec.in: Add a missing Provides: and include the .pc file.
2549 (#106568, Joe Pranevich)
2551 2003-05-27 Matthias Clasen <maclas@gmx.de>
2553 * gtkdoc-mkdb.in (GetSignals):
2554 (GetArgs): Add signals and properties to the statistics.
2555 (OutputMissingDocumentation): Emit undocumented signals and
2556 properties. (#113645)
2558 2003-04-21 Matthias Clasen <maclas@gmx.de>
2560 * tools/docpercentages.pl: Fix autolinkification for undocumented
2563 * doc/style-guide.txt: Typo fix.
2567 2003-04-18 James Henstridge <james@daa.com.au>
2571 2003-04-18 James Henstridge <james@daa.com.au>
2573 * NEWS: add news items.
2575 * configure.in: increment version number.
2577 2003-03-14 Matthias Clasen <maclas@gmx.de>
2579 * gtkdoc-mkdb.in (OutputBook): Fix the public identifier for
2580 DocBook V3.0: Davenport, not DavenPort.
2581 (#108343, Mariano Suarez-Alvarez)
2583 2003-03-10 James Henstridge <james@daa.com.au>
2585 * configure.in: associate the chmod commands with the files they
2586 are chmod'ing. This way config.status will always run the correct
2589 2003-03-04 James Henstridge <james@daa.com.au>
2591 * configure.in: look up the docbook DTD by public id rather than
2594 2003-02-26 Matthias Clasen <maclas@gmx.de>
2596 * gtkdoc-mkdb.in (GetArgs): Prefer template or comment docs over
2597 blurbs only if they're nonempty, otherwise the empty docs from the
2598 templates override all the blurbs.
2600 2003-02-26 James Henstridge <james@daa.com.au>
2602 * autogen.sh (THEDIR): set up so that it will choose automake 1.7
2603 or 1.6 in preference to 1.4. Passes distcheck okay.
2605 * configure.in: update configure.in script to match
2606 recommendations of newer autoconf's, and add an AC_PREREQ()
2607 statement, since the xml catalog checks are using new autoconf
2610 * gtk-doc.make (xml-build.stamp): since other bits of the makefile
2611 were assuming xml, may as well hard code --output-format=xml.
2613 2003-02-19 James Henstridge <james@daa.com.au>
2615 * Makefile.am: get rid of the dist-hook, and just include the
2616 given files in EXTRA_DIST instead.
2618 * configure.in: provide meaningful names for the commands.
2620 * acinclude.m4 (JH_CHECK_XML_CATALOG): add some extra arguments: a
2621 friendly name for the catalog entry, and actions to run if the
2622 entry was found or not. Also include a bit more information in
2623 the config.log file if an error occurs.
2625 2003-02-18 Matthias Clasen <maclas@gmx.de>
2627 * gtkdoc-mkhtml.in (declaration): Avoid the unportable grep
2628 option -q. (#105311)
2630 2003-02-19 James Henstridge <james@daa.com.au>
2632 * devhelp.xsl: put chapters that aren't at the top level into the
2633 toc tree (to make gtk's .devhelp tree look better).
2635 * gtk-doc.spec.in (Requires): make the requires lines match
2636 current requirements ...
2638 * gtkdoc-mkhtml.in (XSLTPROC): pass --nonet to xsltproc, so we
2639 don't try to download DTDs and XSLT over the net. The configure
2640 checks should catch people who don't have the correct files in
2643 2003-02-17 James Henstridge <james@daa.com.au>
2645 * gtkdocize.in (--version): add --version argument.
2647 2003-02-14 James Henstridge <james@daa.com.au>
2649 * gtkdoc-mkdb.in (GetOptions): actually accept --tmpl-dir as a
2650 command line option. Based on a patch from Simon Josefsson
2653 * gtk-doc.xsl: remove the xmlns declaration. Not really needed
2654 for html output anyway ...
2656 2003-02-13 James Henstridge <james@daa.com.au>
2658 * devhelp.xsl: remove refsect1's and refsect2's from book tree, as
2659 suggested by Hallski.
2661 * gtk-doc.make (install-data-local): the change to install images
2662 was superfluous, so I have removed it.
2663 (CLEANFILES): move some more stuff to CLEANFILES from the
2664 distclean-local rule.
2666 2003-02-12 James Henstridge <james@daa.com.au>
2668 * gtk-doc.make: add some chmod calls to work arround distcheck on
2670 (install-data-local): copy the images as well as the html files
2672 (uninstall-local): add an uninstall rule to remove the docs.
2673 (CLEANFILES): add $(DOC_MODULE)-scan.o to the list of files to be
2676 2003-02-09 James Henstridge <james@daa.com.au>
2678 * gtkdocize.in: script used to copy gtk-doc.make into another
2681 * gtk-doc.make: automake makefile fragment to handle gtk-doc
2682 support in other modules.
2684 * configure.in: check to make sure DocBook XML DTD and XSLT
2685 stylesheets are present in the XML catalog.
2687 * acinclude.m4 (JH_CHECK_XML_CATALOG): new macro to check for
2688 entries in the XML catalog.
2690 2003-02-04 James Henstridge <james@daa.com.au>
2692 * gtk-doc.m4: a macro to check for gtk-doc.
2694 * Makefile.am (gtkdocdata_DATA): don't bother installing xml.dcl.
2695 It isn't used anymore (since switching xml mode to xsltproc).
2697 * gtkdoc-mkhtml.in (gtkdocdir): and here.
2699 * Makefile.am (gtkdocdatadir): change dir.
2701 * configure.in: put data files in $(datadir)/gtk-doc/data, so that
2702 they don't all get mixed up with the html docs installed by other
2707 2003-01-20 Damon Chaplin <damon@gnome.org>
2711 2003-01-20 Damon Chaplin <damon@gnome.org>
2713 * configure.in: bumped version to 1.0, and added SGML_OUTPUT_TYPE
2714 variable, which we set to 'sgml-raw' if we have openjade, or 'sgml'
2715 if we have jade. Added gtk-doc.pc to AC_OUTPUT.
2717 * gtkdoc-mkhtml.in: used SGML_OUTPUT_TYPE variable to set the output
2718 type of jade/openjade.
2720 * gtk-doc.pc.in: new pkg-config file, which apps can use to reliably
2721 check the gtk-doc version in future.
2723 * Makefile.am (pkgconfigdir): install .pc file, and add it to
2726 * examples/configure.in: updated example to use pkg-config for the
2729 2003-01-18 James Henstridge <james@daa.com.au>
2731 * gtkdoc-mkhtml.in (declaration): switch the output type from
2732 "sgml" to "sgml-raw" when using Jade to process docs. This gets
2733 rid of the line breaks inside the tags, which were confusing Lynx.
2735 2003-01-15 Matthias Clasen <maclas@gmx.de>
2737 * gtkdoc-scan.in (ScanHeader): Remove special cases for Pango and
2739 * gtkdoc-mkdb.in (OutputDeclaration):
2740 * gtkdoc-mktmpl.in (OutputDeclaration): Remove special cases for
2741 structs named BlablaClass. (#95398)
2743 * gtkdoc-mkdb.in (GetInterfaces): Fix an off-by-one error.
2744 (#103466, Josh Parsons)
2746 2002-12-28 Chema Celorio <chema@celorio.com>
2748 * gtkdoc-scan[g]obj.in: add "void" to functions with no parameters,
2749 avoids warning with -Wmissing-prototypes when compiling
2752 2002-12-16 James Henstridge <james@daa.com.au>
2754 * gtk-doc.spec.in: require perl >= 5.6.0
2756 * configure.in: require Perl >= 5.6.0
2758 * gtkdoc-fixxref.in: add "use bytes;" to fix malformed UTF-8
2759 character errors when run with a UTF-8 locale.
2761 2002-12-16 Matthias Clasen <maclas@gmx.de>
2763 * gtkdoc-mkdb.in (OutputSGMLFile): Don't emit the additional
2764 anchors in the title which breaks the generated html (the title
2765 text is copied around). Instead, put the anchors before the
2766 synopsis. This isn't perfect, but the best we can achieve without
2769 2002-12-13 Matthias Clasen <maclas@gmx.de>
2771 * gtkdoc-mkdb.in: Add an --ignore-files option which can be used
2772 to omit files or directories from scanning.
2773 (OutputSGMLFile): Emit anchors for all objects contained in the
2774 file to avoid dangling links.
2775 (OutputMissingDocumentation): Emit deprecated symbols after
2778 2002-12-12 Matthias Clasen <maclas@gmx.de>
2780 * gtkdoc-scan.in (ScanHeader): Also recognize "positive" guards
2781 like #ifdef GTK_ENABLE_BROKEN.
2783 2002-12-11 Matthias Clasen <maclas@gmx.de>
2785 * gtk-doc.xsl: Change XPath path to "//anchor|//refentry" for the
2786 generation of index.sgml. The previous path "//anchor|refentry"
2787 was not matching any refentrys.
2789 2002-12-09 Matthias Clasen <maclas@gmx.de>
2791 * gtkdoc-mktmpl.in (UpdateTemplates): Emit unused class structs
2792 to $MODULE-unused.txt.
2794 2002-12-08 Matthias Clasen <maclas@gmx.de>
2796 * gtkdoc-mkdb.in (OutputStruct): Don't emit private parts
2797 of class structs to parameter lists in docs. Remove leftover
2800 * gtkdoc-mktmpl.in (OutputDeclaration): Don't emit private parts
2801 of class structs to parameter lists in templates.
2803 2002-12-06 Matthias Clasen <maclas@gmx.de>
2805 Improved /*< private >*/ handling: (#95398)
2807 * gtkdoc-mkdb.in (OutputStruct): Handle /*< public >*/ and
2808 /*< private >*/ for all structs. Default to private for object and
2809 class structs, to public for all other structs.
2811 * gtkdoc-scan.in (ScanHeader): Emit declarations for class structs
2812 to $MODULE-decl.txt.
2814 2002-12-05 Matthias Clasen <maclas@gmx.de>
2816 * gtkdoc-mktmpl.in (OutputDeclaration):
2817 * gtkdoc-mkdb.in (ReadTemplateFile): Support @Since: and
2818 @Deprecated: as a way to specify since and deprecated information
2819 in template files. This works for all kinds of symbols, even those
2820 which normally don't have parameter lists.
2822 2002-12-02 Matthias Clasen <maclas@gmx.de>
2824 * gtkdoc-mkdb.in (MakeDeprecationNote): Support multi-paragraph
2827 2002-11-29 James Henstridge <james@daa.com.au>
2829 * gtkdoc-mkhtml.in: copy the navigation images for both XML and
2832 * gtk-doc.dsl.in: update DSSSL stylesheets to match layout of XSL
2835 2002-11-29 Matthias Clasen <maclas@gmx.de>
2837 * gtkdoc-scan.in (ScanHeader): Make deprecation guards work with
2839 #ifndef DEPRECATION_GUARD
2840 #if !defined(DEPRECATION_GUARD) || defined(FOO_COMPILATION)
2841 The second form is used in GDK and GTK+ to include selected
2842 deprecated symbols when compiling the library itself.
2844 2002-11-27 Matthias Clasen <maclas@gmx.de>
2846 * gtkdoc-mkdb.in: Parse to new tags in inline doc comments,
2847 Since: and Deprecated:, which can be placed after the Returns:
2848 tag. Emit the Since: information (which is expected to be just a
2849 version number) after the parameters and the Deprecated:
2850 information (which is expected to be one or more full sentences)
2851 inside the deprecation warning.
2852 Warn if a Deprecated: tag is found on a symbol which is not
2853 guarded by a deprecation guard in the header.
2855 2002-11-26 James Henstridge <james@daa.com.au>
2857 * gtkdoc-mkhtml.in: set gtkdoc-bookname and gtkdoc-version
2858 parameters in sgml mode, and don't bother with the sed run after
2859 processing with jade.
2860 In XML mode, pass the version number in as a parameter too.
2862 * gtk-doc.dsl.in ($user-html-header$): add <meta> tag if
2863 gtkdoc-version is set.
2864 (generate-index-mode): if gtkdoc-bookname is set, add it to the
2865 hrefs in the index file, like the XSLT sheets do.
2867 * gtk-doc.xsl: add gtkdoc.version parameter, and use it to add a
2868 <meta> tag with the gtk-doc version number.
2870 === release 0.10 ===
2872 2002-11-16 Damon Chaplin <damon@gnome.org>
2876 2002-11-16 Damon Chaplin <damon@gnome.org>
2878 * configure.in: bumped version to 0.10.
2880 * Makefile.am (EXTRA_DIST): added MAINTAINERS.
2882 * README: updated requirements info, mainly to add XML stuff.
2884 * NEWS: added news for 0.10
2887 * AUTHORS: updated my email address.
2889 2002-11-16 James Henstridge <james@daa.com.au>
2891 * gtk-doc.xsl: output HTML in ISO-8859-1 (latin1), as using UTF-8
2892 can trigger misinterpretation of web pages when the web server
2893 asserts that the document is encoded in latin1 in the mime type.
2895 2002-11-15 James Henstridge <james@daa.com.au>
2897 * gtk-doc.xsl: small changes to make the output closer to valid
2900 * gtkdoc-fixxref.in (MakeXRef): when substituting in cross
2901 references, use lower case element and attribute names, and quote
2902 the attribute value.
2904 2002-11-12 James Henstridge <james@daa.com.au>
2906 * gtkdoc-mkdb.in: put content of parameter descriptions in
2907 <simpara> elements instead of <para>'s. This makes the generated
2908 HTML more compact, as it will omit the <p> tag inside the list
2911 * gtk-doc.xsl: adjust stylesheet a little.
2913 2002-11-10 James Henstridge <james@daa.com.au>
2915 * gtk-doc.xsl: change style for documentation.
2917 * gtkdoc-mkhtml.in (declaration): copy PNG files to the html
2920 2002-11-10 Matthias Clasen <maclas@gmx.de>
2922 * gtkdoc-mkdb.in (GetArgs): Expand abbreviations in source doc
2925 2002-11-09 Matthias Clasen <maclas@gmx.de>
2927 * gtkdoc-mktmpl.in (OutputSignalTemplates): Don't replace template
2928 param names with meaningless argn names generated by gtkdoc-scangobj.
2930 * gtkdoc-mkdb.in (GetSignals): Use argument names from source doc
2931 comments, if available.
2932 (GetArgs): Use source doc comments instead of blurb, if available.
2933 (ScanSourceFile): Also accept object::signal and object:property
2935 (MergeSourceDocumentation): For signals only, prefer source doc
2936 param names over template param names.
2938 Fri Nov 8 15:10:57 2002 Owen Taylor <otaylor@redhat.com>
2940 * gtkdoc-mkdb.in (GetPrerequisites): Add missing <para>
2943 Mon Nov 4 17:17:40 2002 Owen Taylor <otaylor@redhat.com>
2945 * gtkdoc-mkdb.in (MergeSourceDocumentation): Warn
2946 when overriding docs in template file by inline comments.
2948 * gtkdoc-mkdb.in (GetInterfaces): Add missing <para> in
2949 "Implemented interfaces" output.
2951 2002-10-29 Damon Chaplin <damon@ximian.com>
2953 * gtkdoc-scangobj.in: in get_type_name() set is_pointer to TRUE for
2954 subtypes of G_TYPE_BOXED and G_TYPE_POINTER. This means we get things
2955 like "GtkTreeIter *iter" rather than "GtkTreeIter iter" which was
2956 incorrect. Also return 'GParamSpec*' for G_TYPE_PARAM.
2957 in lookup_signal_arg_names() changed GtkNotebook::switch-page
2958 page argument to guint. And fixed a few other entries.
2959 Also fixed argument numbering, so we don't get 2 "widget" arguments.
2961 * gtkdoc-scanobj.in: add ';' after unlink command to avoid warning.
2963 2002-10-20 Matthias Clasen <maclas@gmx.de>
2965 * examples/Makefile.am (SCANOBJ_FILES): Add $(DOC_MODULE).prerequisites.
2967 * gtkdoc-mkdb.in: Read $MODULE.prerequisites and put list of
2968 prerequisites below the object hierarchy for interfaces.
2970 * gtkdoc-scangobj.in: Write information about interface
2971 prerequisites to $MODULE.prerequisites.
2973 2002-10-15 Matthias Clasen <maclas@gmx.de>
2975 * gtkdoc-scangobj.in: Sort paramspec arrays for
2976 greater stability and less random tmpl file diffs.
2978 2002-10-14 Matthias Clasen <maclas@gmx.de>
2980 * examples/Makefile.am (SCANOBJ_FILES): Add $(DOC_MODULE).interfaces.
2982 * gtkdoc-mkdb.in: Read $MODULE.interfaces and put lists of
2983 implemented interfaces/known implementations below the object
2984 hierarchy for classes/interfaces.
2986 * gtkdoc-scangobj.in: Write interface information to
2989 2002-10-12 Matthias Clasen <maclas@gmx.de>
2991 * gtkdoc-scangobj.in: Make interface appear in the object hierarchy.
2993 2002-10-11 Matthias Clasen <maclas@gmx.de>
2995 * gtk-doc.xsl: use 'UTF-8', not UTF-8 for default.encoding, to
2996 make the encoding actually appear in the resulting HTML.
2998 2002-10-09 James Henstridge <james@daa.com.au>
3000 * gtkdoc-mkdb.in: set $doctype_header to "" for the SGML case, as
3001 we don't add a doctype to the beginning of SGML fragments.
3003 Tue Sep 17 01:07:51 2002 Jonathan Blandford <jrb@gnome.org>
3005 * gtk-doc.xsl: output the chunks in UTF-8 so other tools can use
3008 2002-09-03 James Henstridge <james@daa.com.au>
3010 * gtk-doc.xsl: turn on rendering of variablelists as tables, and
3011 set CSS rules to style .variablelist instead of .informaltable.
3013 * gtk-doc.dsl.in (variablelist): override the variablelist handler
3014 instead of the tgroups.
3016 * gtkdoc-mkdb.in (OutputStruct): use a <variablelist> for listing
3017 the field descriptions.
3018 (OutputEnum): same here.
3019 (OutputParamDescriptions): and here.
3021 2002-08-12 James Henstridge <james@daa.com.au>
3023 * gtk-doc.xsl: include devhelp.xsl, and call generate.devhelp when
3024 processing the docbook/xml input.
3026 * devhelp.xsl: new file, implements .devhelp file output.
3028 2002-08-18 Havoc Pennington <hp@pobox.com>
3030 * autogen.sh: hardcode aclocal-1.4/automake-1.4 so that users with
3031 both automake 1.6 and 1.4 installed get the right automake. Means
3032 compilation from CVS will now require the latest automake 1.4
3033 release, or manually creating symlinks called "automake-1.4" and
3036 2002-08-08 Matthias Clasen <maclas@gmx.de>
3038 * gtkdoc-scangobj.in: Make sure blurbs end with a '.'
3040 2002-08-08 James Henstridge <james@daa.com.au>
3042 * gtk-doc.xsl: add a gtkdoc.bookname param, and include it in the
3043 index.sgml output (if not empty).
3045 * gtkdoc-mkhtml.in: only perform the sed operation if we are using
3046 Jade, and pass the module name as a parameter when using xsltproc.
3048 2002-08-04 Matthias Clasen <maclas@gmx.de>
3050 * gtkdoc-scangobj.in: Don't try to list signals on types which
3051 don't support signals, e.g. boxed types.
3053 2002-06-14 jacob berkman <jacob@ximian.com>
3055 * gtkdoc-mkdb.in: do the version check before help, so --version
3056 doesn't output --help (should fix recent build bustage)
3058 2002-06-12 Matthias Clasen <maclas@gmx.de>
3060 * gtkdoc-mkdb.in: Make header-grabbing work without an explicit
3061 --main-sgml-file argument.
3063 * gtkdoc-mkdb.in: Emit the object hierarchy as a <screen> rather
3064 than a <literallayout>, since the Docbook XSL stylesheets don't
3065 handle <link>s inside <literallayout>.
3067 * gtkdoc-mkdb.in: Decide wether to generate standalone documents
3068 for XIncluding or entities based on the presence of the XInclude
3069 namespace declaration on the document element.
3071 2002-06-09 James Henstridge <james@daa.com.au>
3073 * gtkdoc-mkdb.in: try to grab the header off the top of the main
3076 2002-05-31 James Henstridge <james@daa.com.au>
3078 * gtkdoc-mkdb.in (OutputSGML): put XIncludes in the $book_bottom
3080 (OutputBook): add the XInclude namespace declaration to the book
3083 * gtkdoc-mkhtml.in (declaration): if the document looks like XML,
3084 process it with xsltproc.
3086 * configure.in: check for xsltproc.
3088 * gtk-doc.xsl: start of XSLT template for converting docbook/xml
3091 2002-06-03 Matthias Clasen <maclas@gmx.de>
3093 * gtkdoc-mkdb.in (ConvertSGMLChars): Don't use Posix character
3094 classes. Perl < 5.6 doesn't have them; and the API doc autobuilder
3095 on widget.gnome.org has an old Perl.
3097 2002-05-29 Matthias Clasen <maclas@gmx.de>
3101 * gtkdoc-mkdb.in (OutputSGML): Call GetSignals, GetArgs and
3102 GetHierarchy for each symbol here and accumulate.
3103 (OutputSGMLFile): Get signal, argument and hierarchy information
3105 (GetSignals, GetArgs, GetHierarchy): Don't wrap the return value
3106 in a refsect1, so that the results of multiple calls can be accumulated.
3108 2002-05-28 Matthias Clasen <maclas@gmx.de>
3110 * gtkdoc-mkdb.in (ConvertSGMLChars): Make this work correctly
3111 for empty elements and XML comments in doc comments.
3113 2002-05-27 Matthias Clasen <maclas@gmx.de>
3115 * gtkdoc-mkdb.in (ReadTemplateFile, OutputSGMLFile):
3116 Use only the basename of the template file in the key for the
3117 symbol table, in order to decouple the file extensions of the
3118 template files and the generated entities (we want to generate
3119 .xml entities from .sgml template files when emitting XML).
3121 2002-05-25 Matthias Clasen <maclas@gmx.de>
3123 * gtkdoc-mkdb.in (ConvertSGMLChars): New function which tries to
3124 be a bit more clever when escaping SGML syntax characters.
3125 (ScanSourceFile): Use ConvertSGMLChars instead of CreateValidSGML.
3126 This reduces the work needed to make gtk-doc emit XML (where <, &
3127 and friends must always be escaped).
3129 2002-05-18 Matthias Clasen <maclas@gmx.de>
3131 * gtkdoc-mkhtml.in: Detect whether we're processing SGML or XML.
3133 * gtkdoc-mkdb.in: New option --output-format to switch between
3134 SGML and XML output.
3136 * Makefile.am (EXTRA_DIST): Add xml.dcl
3138 * xml.dcl: The XML declaration.
3140 2002-05-06 jacob berkman <jacob@ximian.com>
3142 * gtkdoc-scangobj.in: add an include for the GTK_CHECK_VERSION
3145 2002-05-05 Matthias Clasen <maclas@gmx.de>
3147 * gtkdoc-scangobj.in: Output style properties. (#80659)
3149 * gtkdoc-mkdb.in (GetArgs): Return separate sections for
3150 properties, child properties and style properties. (#80659)
3152 2002-05-03 Matthias Clasen <maclas@gmx.de>
3154 * gtkdoc-scangobj.in: Fix for segfault in scangobj-generated C
3155 program on Solaris. (#80606, Jacob Berkman)
3157 2002-05-01 Matthias Clasen <maclas@gmx.de>
3159 * tools/docpercentages.pl: Add the script which Owen uses for the
3160 d.g.o online API docs. Its easier to keep in sync here.
3162 * gtkdoc-mkdb.in (OutputMissingDocumentation): Fix
3163 $MODULE-undocumented.txt for d.g.o online API docs.
3165 * gtkdoc-mkdb.in (GetArgs): Use blurbs for property documentation.
3167 * gtkdoc-scangobj.in: Output child properties. Output nicks and
3168 blurbs for properties.
3170 2002-04-28 Matthias Clasen <maclas@gmx.de>
3172 * gtkdoc-mkdb.in (ScanSourceFile): Don't scan for return value
3173 descriptions unnecessarily. (#65997)
3175 2002-03-11 Matthias Clasen <maclas@gmx.de>
3177 * gtkdoc-scangobj.in, gtkdoc-mkdb.in: Create docs for signals on interfaces.
3179 2002-02-01 Damon Chaplin <damon@ximian.com>
3181 * configure.in: check for openjade or jade. Patch from Stefan Kost
3182 <kost@imn.htwk-leipzig.de>.
3184 * gtkdoc-mkhtml.in: use @JADE@ so the correct version of jade is used.
3186 * autogen.sh: commented out autoheader since we don't have a config.h.
3190 2002-01-18 Damon Chaplin <damon@ximian.com>
3194 2002-02-01 Damon Chaplin <damon@ximian.com>
3196 * examples/Makefile.am: added SCANOBJ_OPTIONS in case the module needs
3197 to pass options to gtkdoc-scanobj or gtkdoc-scangobj.
3199 2002-01-24 Damon Chaplin <damon@ximian.com>
3201 * tools/gtk-doc.el: added Zucchi's emacs lisp for automatically adding
3202 skeleton comment blocks above functions. Very handy!
3204 2002-01-23 Damon Chaplin <damon@ximian.com>
3206 * configure.in: bumped the version to 0.9, so GTK+ can depend on this
3209 * gtkdoc-scangobj.in: we now default to calling g_type_init() to
3210 initialize the type system, rather than gtk_init(). This means you
3211 don't need an X connection to build the docs any more. Hurrah!
3212 Also added a '--type-init-func' argument so you can change the
3213 function to be called. GTK+ uses --type-init-func="gtk_type_init(0)".
3215 * gtkdoc-scan.in (ScanHeader): removed 'Found object' debug message.
3219 2002-01-18 Damon Chaplin <damon@ximian.com>
3223 2002-01-18 Damon Chaplin <damon@ximian.com>
3225 * Makefile.am (EXTRA_DIST): added gtk-doc.dcl to EXTRA_DIST.
3227 2002-01-18 Damon Chaplin <damon@ximian.com>
3229 * gtkdoc-scangobj.in: Reverted jacob's patch for this release, since
3230 it breaks GTK+ and possibly other packages. I'll re-apply it after
3231 the release, so we can fix everything in CVS.
3233 2002-01-18 jacob berkman <jacob@ximian.com>
3235 * gtkdoc-scangobj.in: default to calling g_type_init(), remove
3236 --nogtkinit argument and replace with a more flexible
3239 2002-01-18 Damon Chaplin <damon@ximian.com>
3241 * gtkdoc-mkdb.in (ScanSourceFile): patch from Matthias Clasen
3242 <matthiasc@poet.de> to only strip first space after '*' in source
3243 code comment blocks, so example code can be indented as desired.
3246 Wed Nov 21 16:50:35 2001 Owen Taylor <otaylor@redhat.com>
3248 * gtkdoc-mkdb,tmpl.in: Add some extra quoting to
3249 error messages to make it clearer what is going on
3250 with trailing commas on enumeration declarations.
3252 Wed Nov 21 16:00:45 2001 Owen Taylor <otaylor@redhat.com>
3254 * Applied patch from Matthias Clasen to use a modified
3255 .dcl file with the 44 character name length limit removed.
3258 2001-10-17 Damon Chaplin <damon@ximian.com>
3260 * gtkdoc-mkdb.in: applied patch from Matthias Clasen
3261 <matthiasc@poet.de> to take a --sgml-mode argument which means
3262 all comment blocks in the source code are assumed to be DocBook
3263 (i.e. we don't convert '<', '>' and '&' to '<' etc.
3265 2001-10-09 Damon Chaplin <damon@ximian.com>
3267 * gtkdoc-mkdb.in (OutputMissingDocumentation): changed %.2f to %.0f
3268 so hopefully the automated reports on developer.gnome.org will work
3271 2001-10-02 Damon Chaplin <damon@ximian.com>
3273 * gtkdoc-mktmpl.in (OutputDeclaration):
3274 * gtkdoc-mkdb.in (OutputFunction): applied patch from
3275 matthiasc@poet.de (Matthias Clasen) to handle G_CONST_RETURN in a
3276 parameter list. Bug #61341.
3278 2001-10-02 Damon Chaplin <damon@ximian.com>
3280 * gtkdoc-mkdb.in (OutputMissingDocumentation): applied patch from
3281 matthiasc@poet.de (Matthias Clasen) to output percentages better.
3283 Also set percent to 100 if total is 0, avoiding divide-by-zero.
3285 2001-10-02 Damon Chaplin <damon@ximian.com>
3287 * examples/Makefile.am (DOC_OVERRIDES): define as an empty string,
3290 2001-09-13 Damon Chaplin <damon@ximian.com>
3292 * gtkdoc-mkdb.in (OutputMissingDocumentation): initialize buffer to "".
3293 Fix for SGI from David Kaelbling <drk@sgi.com>.
3295 Sat Sep 8 14:08:51 2001 Jonathan Blandford <jrb@webwynk.net>
3297 * gtkdoc-scan.in (ScanHeader): recognize GET_IFACE macros
3299 2001-09-08 Havoc Pennington <hp@pobox.com>
3301 * gtkdoc-mkdb.in (GetArgs): Title the section on object properties
3302 "Properties" instead of "Args"
3304 2001-08-14 Laszlo Peter <laca@ireland.sun.com>
3306 * gtkdoc-scanobj.in:
3307 * gtkdoc-scangobj.in: change \n's to \\n's in perl scripts
3310 2001-08-12 Jens Finke <jens@gnome.org>
3312 * Updated gtk-doc.spec.in file to match gpp standard.
3316 2001-08-04 Damon Chaplin <damon@ximian.com>
3320 2001-08-04 Damon Chaplin <damon@ximian.com>
3322 * gtkdoc-mkdb.in (OutputFunction):
3323 * gtkdoc-mktmpl.in (OutputDeclaration): patch from Lowell Johnson
3324 <ldjohn@usgs.gov> to accept things like "long long", "short int",
3325 "char test[][CLEN]" as function parameters.
3327 2001-07-20 Anders Carlsson <andersca@gnome.org>
3329 * gtkdoc-scangobj.in: Remove argument to g_type_init ();
3331 2001-07-09 Damon Chaplin <damon@ximian.com>
3333 * gtkdoc-mkdb.in (ParseStructDeclaration): accept G_CONST_RETURN
3334 modifier for function return values. gtkdoc-mktmpl.in already had this.
3336 Thu Jun 21 11:57:16 2001 Owen Taylor <otaylor@redhat.com>
3338 * gtkdoc-scangobj.in: Conform to changes in GObject API
3339 for property retrieval.
3341 2001-05-25 Peter Williams <peterw@ximian.com>
3343 * gtkdoc-mkdb.in (ScanSourceFile): Skip single-line comments --
3344 prevents barfing on ORBit-generated files.
3346 2001-05-20 Damon Chaplin <damon@ximian.com>
3348 * examples/Makefile.am (sgml-build.stamp): replaced use of wildcard
3349 (which isn't portable) with original *.sgml. I think this just means
3350 that the first time you try to build the docs it will fail, but if
3351 you run make again it will work.
3353 * doc/setting-up.txt: explained that make may fail the first time.
3355 2001-05-19 Damon Chaplin <damon@ximian.com>
3359 * doc/setting-up.txt:
3360 * doc/sections-file.txt:
3361 * doc/authors.txt: updated docs to cover simpler setup procedure.
3363 * doc/gtk_button.txt:
3366 * doc/notes.txt: removed out-of date stuff.
3368 * Makefile.am (dist-hook): updated so it doesn't try to remove old
3369 examples subdirectory stuff.
3371 2001-05-19 Damon Chaplin <damon@ximian.com>
3374 * examples/gnomeui/*: removed out-of-date example files.
3376 * examples/configure.in:
3377 * examples/Makefile.am: new example setup mostly copied from GTK+.
3379 * examples/README: describe the example configure.in/Makefile.am.
3381 2001-05-19 Damon Chaplin <damon@ximian.com>
3383 * gtkdoc-mkdb.in: added --help option and changed output slightly to
3384 make more compatable with XML. Patch from Toshio Kuratomi
3385 <badger@prtr-13.ucsc.edu>
3387 2001-05-19 Damon Chaplin <damon@ximian.com>
3389 * gtkdoc-mktmpl.in (OutputDeclaration):
3390 * gtkdoc-mkdb.in (OutputFunction): changed a '?' to a '*' so we accept
3391 multi-dimensional array function parameters. Patch from Paolo Casarini
3392 <casarini@CS.UniBO.IT>
3394 2001-05-12 Damon Chaplin <damon@ximian.com>
3396 * gtkdoc-scangobj.in:
3397 * gtkdoc-scanobj.in: used "*pos = 0" to avoid problems with backslashes
3400 * configure.in: removed dsssl dirs stuff, since we use public entities
3403 * gtkdoc-mkdb.in (OutputBook): if there is no main SGML file we create
3404 it here. Also added a --main-sgml-file option so we know where to put
3407 * gtkdoc-scan.in: if there is no MODULE-sections.txt file, we copy
3408 the MODULE-decl-list.txt file to it. The user can tweak it later.
3410 2001-05-11 Damon Chaplin <damon@ximian.com>
3412 * gtk-doc.spec.in: applied patch from Toshio Kuratomi
3413 <badger@prtr-13.ucsc.edu>.
3415 2001-05-07 Joakim Ziegler <joakim@ximian.com>
3417 * gtkdoc-mkdb.in: Added option --outputallsymbols to create a symbol list
3418 in the module doc dir.
3420 * gtkdoc-mkdb.in: Added functionality to output a list of undocumented
3421 symbols in a module, most of is is in OutputMissingDocumentation.
3423 * gtkdoc-scan.in: Small scanning fixes to facilitate the doc coverage
3424 output mentioned above.
3426 2001-04-25 Federico Mena Quintero <federico@ximian.com>
3428 * gtkdoc-scanobj.in: Added missing output-dir in the call to
3431 2001-04-24 Damon Chaplin <damon@ximian.com>
3433 * gtkdoc-scanobj.in: copied --outputdir option from gtkdoc-scangobj.in.
3435 Fri Apr 13 15:25:44 2001 Owen Taylor <otaylor@redhat.com>
3437 * gtkdoc-mkdb.in: Restore call to OutputBook that was accidentally
3440 Thu Apr 12 17:57:12 2001 Owen Taylor <otaylor@redhat.com>
3442 * gtkdoc-scangobj.in: Add a --outputdir option (sort of hacky.
3443 Need this because $CC, $LD can include relative paths if they
3444 are based on $LIBTOOL)
3446 2001-03-26 Damon Chaplin <damon@ximian.com>
3448 * gtkdoc-mkdb.in (ReadSourceDocumentation): scan .h files as well,
3449 so macros can be documented there if desired. Patch from
3450 Yoann Vandoorselaere <yoann@mandrakesoft.com>
3452 * gtkdoc-mkhtml.in (gtkdocdir): use 'test -f' rather than 'test -e'
3453 which is GNU-specific.
3455 Thu Mar 8 17:26:29 2001 Tim Janik <timj@gtk.org>
3457 * gtkdoc-scangobj.in: fix signal param type handling.
3459 Tue Mar 6 23:21:46 2001 Jonathan Blandford <jrb@redhat.com>
3461 * gtkdoc-scanobj.in: Add gobject support. Now works on files that
3462 don't link against GTK.
3464 Sat Mar 3 17:43:42 2001 Owen Taylor <otaylor@redhat.com>
3466 * gtkdoc-{scan,mktmpl,mkdb}.in: Add support for G_CONST_RETURN.
3467 (Right now, it will appear as G_CONST_RETURN in the output -
3468 I'm not sure that's right - perhaps it should be converted
3471 2001-02-20 Michael Meeks <michael@ximian.com>
3473 * gtkdoc-mktmpl.in: s/TRUE/1/
3475 2001-02-19 Damon Chaplin <damon@ximian.com>
3477 * gtkdoc-mktmpl.in (UpdateTemplates): fixed bug handling the $changed
3480 2001-02-17 Damon Chaplin <damon@ximian.com>
3482 * gtkdoc-scan.in (ScanHeaders):
3483 (ScanHeader): patch from Johannes Stezenbach <js@convergence.de>
3484 so we don't use '\b' in the regexp to match files/dirs to ignore.
3485 '\b' can match '_' so we matched things we shouldn't have.
3487 Mon Feb 12 12:50:57 2001 Owen Taylor <otaylor@redhat.com>
3489 * configure.in: Up version.
3491 Sun Feb 11 18:35:07 2001 Owen Taylor <otaylor@redhat.com>
3493 * gtkdoc-mktmpl.in: Add a timestamp file for the
3494 templates like sgml.stamp
3496 * gtkdoc-mktmpl.in (OutputUnusedTemplates): Write the
3497 symbols out in sorted order instead of hash table
3498 order to reduce conflicts.
3500 Mon Feb 5 16:48:51 2001 Owen Taylor <otaylor@redhat.com>
3502 * configure.in gtk-doc.dsl.in: Remove checks for DSSSL - use a
3503 public entity instead.
3505 * gtkdoc-scangobj.in: Fix to work with libtool better.
3507 2001-01-30 Havoc Pennington <hp@pobox.com>
3509 * gtkdoc-fixxref.in, gtkdoc-mkdb.in, gtkdoc-mktmpl.in,
3510 gtkdoc-scan.in, gtkdoc-scangobj.in, gtkdoc-scanobj.in:
3511 Added -*- cperl -*- magic, and --deprecated-guards
3514 2001-01-23 Damon Chaplin <damon@helixcode.com>
3516 * gtkdoc-scangobj.in:
3517 * gtkdoc-scanobj.in:
3520 * gtkdoc-mktmpl.in: changed so that they only update files when
3521 necessary (they write new versions of the files out, then use 'cmp'
3522 to compare with the existing versions to see if they have changed.)
3523 This should make it easier to do proper dependency rules in Makefiles,
3524 and it may cut down on CVS traffic.
3526 * gtkdoc-mkhtml.in: update a timestamp file (html.stamp) after running.
3527 * gtkdoc-mkdb.in: update a timestamp file (sgml.stamp) if any of the
3528 DocBook SGML files have been changed. So hopefully you can now use
3529 rules like this to avoid unnecessary regeneration of the HTML:
3537 html.stamp: sgml.stamp $(EXTRA_SGML_FILES)
3540 (I've tried this with the old GTK+ reference API docs and it seems to
3543 * gtkdoc-scangobj.in:
3544 * gtkdoc-scanobj.in:
3550 * gtkdoc-fixxref.in:
3551 Added '--version' command-line arg to all shell & perl scripts, so
3552 you can check for version 0.5 if you want to use the above rules.
3553 (If 0.4 is used make will probably complain about not knowing how to
3554 to build sgml.stamp.)
3556 * gtkdoc-common.pl.in: new file to contain shared routines.
3557 For now it just contains the UpdateFileIfChanged routine for the above.
3558 We can move the duplicated routines here in future, though the use of
3559 global variables makes this a bit awkward.
3561 * configure.in (PACKAGE_DATA_DIR): calculates the data dir and
3562 substitutes it so that the scripts know where gtkdoc-common.pl
3563 is installed. Also added gtkdoc-common.pl to AC_OUTPUT.
3565 * Makefile.am: added gtkdoc-common.pl to gtkdocdata_DATA.
3567 * gtkdoc-mkhtml.in: deleted the old index.sgml file, since it causes
3568 problems if it is owned by root (e.g. after you run 'make install' as
3569 root. jade prompts you about overwriting it, which is annoying.
3571 2001-01-10 Havoc Pennington <hp@redhat.com>
3573 * gtkdoc-mktmpl.in: Only move old file to backup if the old file
3574 exists, and have better error messages when doing the backups
3576 Mon Jan 8 14:57:29 2001 Owen Taylor <otaylor@redhat.com>
3578 * gtkdoc-mktmpl.in: Canonicalize signal and argument
3581 * gtkdoc-scangobj.in: Fix up for GParamSpec.
3583 2001-01-04 Fr�d�ric Gobry <frederic.gobry@smartdata.ch>
3585 * gtkdoc-scan.in: fixed matching of < private_header > directive
3587 2000-12-19 Damon Chaplin <damon@helixcode.com>
3589 * gtkdoc-scanobj.in:
3590 * gtkdoc-scangobj.in: added default cases to get_type_name().
3592 2000-12-10 Arturo Tena <arturo@directmail.org>
3594 * gtkdoc-scanobj.in (get_type_name):
3595 * gtkdoc-scangobj.in (get_type_name): fixed syntax error: forgotten
3596 to close a switch statement.
3598 2000-12-10 Damon Chaplin <damon@helixcode.com>
3600 * gtk-doc.spec.in: added spec.in file from John Gotts
3601 <jgotts@linuxsavvy.com>.
3603 * configure.in (AC_OUTPUT): added spec file.
3605 * Makefile.am: uncommented spec file stuff, now that we have one.
3607 * gtkdoc-scanobj.in (get_type_name):
3608 * gtkdoc-scangobj.in (get_type_name): updated to use the type numbers
3609 rather than the type names, which were changed in GTK+ 1.2. This
3610 should fix a problem where GTK_TYPE_STRING arguments were output as
3611 'GtkString *arg' instead of 'gchar *arg'.
3613 I'm still not sure what to output for the structured types such as
3614 GTK_TYPE_SIGNAL/ARGS/FOREIGN/CALLBACK/C_CALLBACK. Should these be
3615 expanded to several arguments to the signal handler?
3617 2000-11-25 Dan Mueth <d-mueth@uchicago.edu>
3619 * help/manual/C/: created this path
3620 * gtk-doc-manual.sgml: Put part of the outline into SGML.
3621 Chris plans to put rest of outline in here and start
3623 * fdl-appendix.sgml: The FDL in SGML. We will probably post
3624 these on the web as a single document (book) so we will
3625 need the FDL to be included as an appendix.
3627 Fri Nov 3 07:21:34 2000 Tim Janik <timj@gtk.org>
3630 (ParseStructDeclaration):
3633 (ParseStructDeclaration):
3634 support /*<protected>*/ equivalently to /*<private>*/
3636 Fri Nov 3 07:15:58 2000 Tim Janik <timj@gtk.org>
3640 (ReadTemplateFile): only eat up the first space (if at all
3641 present) after "@param:" to preserve indentation for multiline
3642 parameter descriptions.
3644 2000-10-30 Raja R Harinath <harinath@cs.umn.edu>
3646 * gtkdoc-mkdb.in (ParseStructDeclaration):
3647 Stop scanning at '}' only when it starts a line.
3648 * gtkdoc-mktmpl.in (ParseStructDeclaration): Likewise.
3650 Mon Oct 30 02:59:54 2000 Tim Janik <timj@gtk.org>
3652 * gtkdoc-scangobj.in: use g_signal_list_ids().
3654 Sun Oct 29 02:54:51 2000 Owen Taylor <otaylor@redhat.com>
3656 * gtkdoc-scangobj.in: Sort signal types arrays for
3657 greater stability and less random tmpl file diffs.
3659 Sun Oct 29 01:02:35 2000 Owen Taylor <otaylor@redhat.com>
3661 * gtkdoc-scangobj.in: Work properly with GSignal
3665 2000-10-21 Damon Chaplin <damon@helixcode.com>
3669 2000-10-14 Damon Chaplin <damon@helixcode.com>
3672 * MAINTAINERS: changed my email address.
3674 * Makefile.am (dist-hook): remove the CVS dirs from the dist.
3676 * doc/setting-up.txt: typo.
3678 Fri Oct 6 17:51:50 2000 <otaylor@redhat.com>
3680 * gtkdoc-scan.in gtkdoc-mkdb.in: Allow multiple
3681 --source-dir options.
3683 Thu Sep 7 11:41:12 2000 Owen Taylor <otaylor@redhat.com>
3685 * gtkdoc-mkdb.in: Ignore all . files when scanning directories.
3687 * gtkdoc-scan.in: Add support for GLIB_VAR, GDKVAR,
3688 etc when looking for variable declarations.
3690 * gtkdoc-scan.in: Recognize GET_CLASS macros.
3692 * gtkdoc-scangobj.in: Support .lo intermediate files
3695 Wed Sep 6 17:57:33 2000 Owen Taylor <otaylor@redhat.com>
3697 * gtkdoc-scangobj.in: Add gtkdoc-scangobj scanner for
3698 GObject type system.
3700 * gtkdoc-scanobj.in: Allow setting $LD to allow separating
3701 compilation and linking and thus to allow using libtool.
3703 * gtkdoc-fixxref.in (ScanIndices): Allow HTMLDIR
3704 not to be present yet.
3706 Tue Sep 5 23:37:53 2000 Owen Taylor <otaylor@redhat.com>
3708 * gtkdoc-fixxref.in: Add a --extra-dir option to
3709 allow scanning of additional uninstalled HTML
3712 * gtkdoc-scan.in (ScanHeaders): Honor subdirectories
3713 appearing in --ignore-headers.
3715 * gtkdoc-mkdb.in: Append -CAPS to all all-caps identifiers
3716 to prevent an infinite expansion of special cases.
3718 * gtkdoc-fixxref.in: Add a --module-dir option to
3719 allow fixing references in an uninstalled tree.
3721 * gtkdoc-mkdb.in gtkdoc-mkhtml.in: Simple handling
3722 for macros with embedded commas in enumeration
3725 Mon Aug 28 18:18:53 2000 Owen Taylor <otaylor@redhat.com>
3727 * configure.in (DSSSL_DIR): Remove check for AM_PATH_GTK
3728 since the dependency is only run-time not install-time,
3729 and to avoid dependency loops.
3731 2000-06-21 Damon Chaplin <damon@helixcode.com>
3733 * gtkdoc-mkdb.in: fixed <INCLUDES> bug, I think.
3735 Wed Feb 9 11:29:25 2000 Owen Taylor <otaylor@redhat.com>
3737 * gtkdoc-scan.in: Hack to avoid misidentifying structures
3738 as GtkObjects within Pango.
3740 1999-12-15 Raja R Harinath <harinath@cs.umn.edu>
3742 * gtk-doc.dsl.in ($generate-chapter-toc$): Add missing close
3745 1999-11-23 Raja R Harinath <harinath@cs.umn.edu>
3747 * gtk-doc.dsl.in: Use the (define (foo) ...) syntax rather than
3748 the uglier (define foo (lambda () ...)) syntax.
3749 ($generate-chapter-toc$): Simplify.
3750 ($shade-verbatim-attr$): Simplify. Use ($table-width$) instead of
3751 "100%" for width (See docs. of NWalsh Docbook DSSSL Stylesheets
3752 for an explanation).
3754 1999-09-20 Damon Chaplin <damon@karuna.freeserve.co.uk>
3756 * gtk-doc.dsl.in: If a Chapter has role="no-toc" we don't generate a
3757 table of contents. This is useful if a better contents page has been
3758 added manually, e.g. for the GTK+ Widgets & Objects page. (But it is
3761 * gtkdoc-scanobj.in: added --nogtkinit flag which will make it call
3762 gtk_type_init() rather than gtk_init(). This is useful when it is
3763 run automatically to update the docs by a cron job or similar and a
3764 connection to an X server is not desirable. However, if any widgets
3765 need a connection to X in their class init function then this can't
3766 be used (e.g. GtkFontSelection at present).
3768 Mon Sep 20 09:09:12 1999 Owen Taylor <otaylor@redhat.com>
3770 * gtkdoc-mkdb.in gtkdoc-mktmpl.in: (ParseStructDeclaration):
3771 Fixed up the code to do /*< private >*/ ... stripping.
3773 1999-09-10 Martin Baulig <martin@home-of-linux.org>
3775 * gtkdoc.dsl.in ($generate-chapter-toc$): Return #t, not #f.
3777 1999-09-09 Martin Baulig <martin@home-of-linux.org>
3779 * gtkdoc-scan.in (ScanHeader): Don't force typedefs and other
3780 things to start in column 0; allow some spaces in front of them.
3781 Output `typedef struct { ... } name' structs as typedef, not as
3784 1999-09-08 Martin Baulig <martin@home-of-linux.org>
3786 * gtkdoc-mkdb.in (CreateValidSGMLID): `s/::/-/g;' for CORBA objects.
3788 1999-08-22 Erik Walthinsen <omega@cse.ogi.edu>
3790 * gtkdoc-scan.in: modified so it will find any Class, not just Gtk
3791 and Gnome classes. Introduces the possibility of extraneous Class
3792 definitions (verified), which should be pruned somehow (haven't
3793 analyzed the false positive yet).
3795 1999-08-22 Damon Chaplin <damon@karuna.freeserve.co.uk>
3798 * gtkdoc-mkdb.in: a few fixes to ParseStructDeclaration. It still
3799 has problems with nested structs/unions like those which occur in
3800 gtkclist.h and gtktypeutils.h.
3802 * configure.in: removed gtk-doc.spec from AC_OUTPUT, as whoever wrote
3803 this forgot to add gtk-doc.spec.in to CVS.
3804 * Makefile.am: commented out gtk-doc.spec.
3806 Wed Aug 18 03:55:30 1999 Owen Taylor <otaylor@redhat.com>
3808 * gtkdoc-mktmpl.in: Propagate fix from gtkdoc-mkdb.in.
3809 :-(; need to libraryize, need to libraryize.
3811 Wed Aug 18 03:55:30 1999 Owen Taylor <otaylor@redhat.com>
3813 * gtkdoc-mkdb.in: Fix bug that was preventing
3814 structure field definitions from being output.
3816 Wed Aug 18 23:25:23 1999 Owen Taylor <otaylor@redhat.com>
3818 * configure.in: Add /usr/lib/sgml/stylesheet to list
3819 of stylesheet directories. (Found in recent Debian
3822 1999-08-15 Damon Chaplin <damon@karuna.freeserve.co.uk>
3824 * gtkdoc-mkdb.in: Output $decl_out as the struct rather than the
3825 original $declaration.
3827 1999-08-12 Damon Chaplin <damon@karuna.freeserve.co.uk>
3830 * gtkdoc-mktmpl.in: Added special case in ParseEnumDeclaration to
3831 handle GIOCondition which uses strange macros like this:
3834 G_IO_IN GLIB_SYSDEF_POLLIN,
3836 The GLIB_SYSDEF_POLLIN macro expands to something like '=1'
3838 1999-08-05 Damon Chaplin <damon@karuna.freeserve.co.uk>
3840 * gtk-doc.dsl.in: output <br clear=all> after sections and at end of
3841 page so that right-aligned images aren't messed up quite as much.
3843 Wed Aug 4 04:04:55 1999 Owen Taylor <otaylor@redhat.com>
3845 * gtkdoc-mk{db,tmpl}.in (ParseStructDeclaration): Allow
3848 * gtkdoc-mktmpl.in (ReadObjectHierarchy): Remove
3849 call to MakeXref that slipped in accidentally.
3851 Wed Aug 4 03:30:19 1999 Owen Taylor <otaylor@redhat.com>
3853 * doc/style-guide.txt: Removed references to creating
3854 tables explicitely in favor of demonstrating new
3855 syntax. Added a short section on /<* public >*/
3856 and /*< private *>/.
3858 Wed Aug 4 03:15:19 1999 Owen Taylor <otaylor@redhat.com>
3860 * gtkdoc-mktmpl.in gtkdoc-mkhtml.in: Handle Struct and
3861 Enumerations in approximately the same way as we
3862 handle parameters. That is, instead of (as before)
3863 coding in the tables by hand, one uses lines like:
3865 @width: the width of the rectangle in pixels.
3867 To support migration from the older hand-coded
3868 tables, if none of the members of a structure or
3869 enumeration have a description in a @... line, then
3870 we don't generate the table at all.
3872 Also, gtkdoc-mktmpl now loads up the object heirarchy,
3873 because we need to be able to check if structures
3874 are widget structures.
3876 In general, the coding here is pretty clean, though
3877 the style is a little different. (I'm interating
3878 through strings with m/.../msg; instead of
3879 s/^...//; for one thing.) However, there are a some
3880 of FIXME's where I've whimped out on try to handle
3881 real C syntax, and the need to split out and librarize
3882 a bunch of duplicated code is greater than ever.
3884 1999-06-06 Damon Chaplin <damon@karuna.freeserve.co.uk>
3886 * configure.in: updated version to 0.3.
3888 * doc/style-guide.txt: A couple of minor changes.
3890 * gtkdoc-mkdb.in: Get rid of a couple of messages.
3891 Output an empty <para> if an Arg isn't documented, to keep Jade happy.
3893 1999-05-22 Damon Chaplin <damon@karuna.freeserve.co.uk>
3895 * gtk-doc.dsl.in: Renamed %shade-verbatim-attr-2% to
3896 $shade-verbatim-attr$ and removed our redefinition of
3897 $verbatim-display$ since the stylesheets version now calls
3898 $shade-verbatim-attr$ as a function which is just what we wanted.
3900 * README: Updated info on stylesheet versions supported - 1.40 is
3901 known to be OK (with this version of gtk-doc), 1.19+ may work.
3903 1999-03-31 Damon Chaplin <damon@karuna.freeserve.co.uk>
3905 * configure.in: update version to 0.2 for next release.
3908 * gtkdoc-mkdb.in: added support for 'See Also' section.
3910 * gtk-doc.dsl.in: changed green background color slightly, and
3911 set background color for enum tables.
3913 1999-03-21 Damon Chaplin <damon@karuna.freeserve.co.uk>
3915 * gtkdoc-mkhtml.in (gtkdocdir): use '-w no-idref' to suppress all the
3916 warnings about references to non-existent IDs.
3918 1999-03-18 Damon Chaplin <damon@karuna.freeserve.co.uk>
3920 * gtkdoc-mkdb.in (OutputParamDescriptions): use role="params" for the
3921 table so we can adjust the stylesheet code.
3922 (OutputSGMLFile): Don't output 'one line description goes here'.
3923 (ExpandAbbreviations): allow '-' in #symbol abbreviations, so we can
3924 use #GtkWidget-struct.
3925 (MakeXRef): get rid of special '-struct' suffix, for #GtkWidget-struct.
3927 * gtk-doc.dsl.in: use the "role" attribute on tables to set the
3930 * gtkdoc-scan.in (ScanHeader): fix for scanning functions declared
3931 over multiple lines - was catching things which weren't functions.
3933 1999-03-11 Damon Chaplin <damon@karuna.freeserve.co.uk>
3935 * examples/gnomeui/Makefile.am (clean-local):
3936 * examples/gnome/Makefile.am (clean-local): added *.args
3938 * gtkdoc-mkdb.in: added support for Args and variables. Also a few
3939 minor changes in the output, e.g. don't show macros > 2 lines long.
3942 * gtkdoc-scanobj.in: added support for Args.
3944 * gtkdoc-scan.in: added support for extern'ed variables. Also
3945 accept 'extern' before function declarations.
3947 * gtk-doc.dsl.in: made output prettier. Changed the navigation bars
3948 and the colours used for the various backgrounds.
3950 * doc/style-guide.txt: new file containinf a style guide for writing
3951 the GTK+ documentation.
3953 * doc/README: added description of style-guide.txt
3955 * doc/setting-up.txt: fixed a typo
3957 * README: added a bit about Args.
3959 1999-02-07 Damon Chaplin <damon@karuna.freeserve.co.uk>
3961 * Makefile.am: Removed all the scripts from EXTRA_DIST, as they are
3962 now generated from the .in files which automatically go in the dist.
3964 1999-02-02 Damon Chaplin <damon@karuna.freeserve.co.uk>
3966 * doc/setting-up.txt (scan): removed text which incorrectly said that
3967 changing section titles means you have to recreate the main SGML file.
3969 1999-02-03 Sebastian Wilhelmi <wilhelmi@ira.uka.de>
3971 * configure.in: find perl in $PATH, generate the perl programs
3972 from their *.in counterparts.
3974 * gtkdoc-fixxref, gtkdoc-mkdb, gtkdoc-mktmpl, gtkdoc-scan,
3975 gtkdoc-scanobj: Renamed to *.in and changed /usr/bin/perl to
3976 @PERL@, as determined by configure.
3978 * .cvsignore: Added diverse config* stuff and the new generated
3981 1999-01-28 Damon Chaplin <damon@karuna.freeserve.co.uk>
3983 * gtk-doc.dsl.in: I forgot to make the new refentry code process the
3984 child elements, so it was only outputting anchors for each page.
3986 * doc/setting-up.txt (scan): added step to create MODULE.types file
3987 for modules which contain widgets (or objects).
3989 * gtkdoc-mkdb (OutputStruct): allow spaces inside the public/private
3990 markers, e.g. "/* < public > */"
3992 1999-01-27 Damon Chaplin <damon@karuna.freeserve.co.uk>
3994 * Makefile.am: added scripts to EXTRA_DIST and copied examples, doc
3995 and db2man dirs in dist-hook.
3997 * doc/sections-file.txt: added a couple of examples.
3999 * doc/setting-up.txt: new document describing how to set up a module
4002 * doc/README: added description of setting-up.txt
4004 * README: added short 'Installation' section describing the
4005 --with-dsssl-dir option.
4007 * gtk-doc.dsl.in: also output links to each RefEntry page in the
4008 index.sgml file, so libgnomeui docs can link to widgets. (The widget
4009 hierarchy links were not working before.)
4011 1999-01-26 Damon Chaplin <damon@karuna.freeserve.co.uk>
4013 * gtkdoc-scan (ScanHeader): parse function declarations that have the
4014 return type and name on one line, and the '(' and args on the next.
4015 NOTE: functions with the start of the declaration split over 3 lines
4016 will not be parsed (e.g. return type on one line, function name on
4017 next, and '(' and first argument on the third.) I hope there aren't
4020 * gtkdoc-mkdb (OutputStruct): Use a different SGML ID for widget
4021 structs, since the original ID is used for the entire RefEntry.
4022 Also only show parts of widget structs which are marked with a
4023 comment '/*<public>*/'. Use '/*<private>*/' for private fields.
4025 * gtkdoc-mktmpl (UpdateTemplates): We include widget structs now,
4026 so we do want warnings if they aren't used.
4028 * examples/gnomeui/gnomeui-docs.sgml:
4029 * examples/gnomeui/gnomeui-sections.txt:
4030 * examples/gnomeui/gnomeui.types:
4031 * examples/gnome/gnome-docs.sgml:
4032 * examples/gnome/gnome-sections.txt: sync with latest source.
4034 * examples/configure.in: Add --with-gnome-libs-dir option, so it can
4035 be configured easily.
4036 * examples/gnomeui/Makefile.am (DOC_SOURCE_DIR):
4037 * examples/gnome/Makefile.am (DOC_SOURCE_DIR): use the new
4040 * gtkdoc-mkdb (MergeSourceDocumentation): accept parameters names in
4041 the source which use the wrong case, since there are quite a few of
4044 1999-01-25 Damon Chaplin <damon@karuna.freeserve.co.uk>
4046 * gtkdoc-mktmpl: parse G_GNUC_EXTENSION before typedef'ed types.
4048 * gtkdoc-mkdb: added support for specifying include files in the
4049 MODULE-sections.txt file, to be output at the top of the synopsis.
4051 * doc/sections-file.txt: added description of <INCLUDE> tag.
4053 * examples/gnomeui/gnomeui-sections.txt:
4054 * examples/gnome/gnome-sections.txt: added use of <INCLUDE>
4056 * examples/configure.in: changed 'gtk-reference' to
4057 'gnome-libs-reference'.
4059 1999-01-18 Damon Chaplin <damon@karuna.freeserve.co.uk>
4061 * README: updated my email address & noted that version 1.15+ of the
4062 DocBook modular stylesheets is needed (for $table-width$).
4064 * AUTHORS: updated my email address.
4066 1998-12-20 Jeff Garzik <jgarzik@pobox.com>
4068 * examples/gnomeui/gnomeui-docs.sgml,
4069 examples/gnomeui/gnomeui-sections.txt,
4070 examples/gnomeui/gnomeui.types:
4071 s/gtkspell/gnome-spell/g
4073 1998-12-16 Damon Chaplin <DAChaplin@msn.com>
4075 * gtkdoc-mkdb (ExpandAbbreviations): Allow -ve contants, e.g. %-1.
4076 (ScanSourceFile): Try to handle function descriptions that start
4077 with 'Returns'. It was assuming that they were describing the return
4079 Gets rid of 'Description:' which is sometimes included
4080 at the start of the function description in the source comment blocks.
4081 Makes sure newlines are preserved in the description, as consecutive
4082 newlines are converted to paragraph separators later.
4084 1998-12-15 Damon Chaplin <DAChaplin@msn.com>
4085 * Major changes to the scripts to merge in comments within source code
4086 * gtk-doc-fixxref added
4087 * examples directory added with an example for setting up modules to
4089 * documentation updated
4092 1998-11-28 Damon Chaplin <DAChaplin@msn.com>
4097 * gtkdoc-mkdb: Major changes to make it easy to update the docs
4098 when the API changes. It's pretty much all automatic now.
4099 Also added licenses and function comments, and added 'use strict'.
4100 The Gnome widgets should now be visible in the hierarchy.
4101 Removed a few 'mkdir's which I don't think are necessary now.
4103 Tue Nov 24 16:32:23 1998 Owen Taylor <otaylor@redhat.com>
4105 * README doc/authors.txt: Updated to describe the
4106 new generic scripts instead of the old ones hard-coded
4109 Tue Nov 24 01:06:17 1998 Owen Taylor <otaylor@redhat.com>
4111 * .cvsignore: Added .cvsignore
4113 Tue Nov 24 01:03:47 1998 Owen Taylor <otaylor@redhat.com>
4115 * autogen.sh configure.in: Minor touchups so the newly
4116 imported stuff autogen's correctly.