1 2009-04-15 Stefan Kost <ensonic@users.sf.net>
5 Tentative patch to allow building without scrollkeeper and
6 gnome-doc-utils. Fixes #577059.
8 2009-04-05 Stefan Kost <ensonic@users.sf.net>
10 * examples/Makefile.am:
11 Only run the tests if gtk-doc is enabled. Fixes #577774.
13 2009-03-18 Stefan Kost <ensonic@users.sf.net>
15 patch by: David Nečas <yeti@physics.muni.cz>
18 Fix <table> element mismatch in highlighted code. Fixes #575711.
20 2009-03-17 Stefan Kost <ensonic@users.sf.net>
23 Turn pdf off if there is no gtkdoc-mkpdf installed.
25 2009-03-17 Stefan Kost <ensonic@users.sf.net>
27 patch by: Tobias Mueller <gnome-bugs@auftrags-killer.org>
31 * gtkdoc-common.pl.in:
39 * help/manual/C/fdl-appendix.xml:
41 Update FSF address. Fixes #575623.
43 2009-03-17 Stefan Kost <ensonic@users.sf.net>
46 Don't run fop for now, its way to broken.
48 * tests/bugs/src/tester.h:
51 2009-03-17 Stefan Kost <ensonic@users.sf.net>
53 patch by: Vincent Untz <vuntz@nome.org>
55 * gtkdoc-common.pl.in:
56 Be more friendly for files with a space in their name. Fixes #575574.
58 2009-03-12 Stefan Kost <ensonic@users.sf.net>
61 Do not overwrite declaration variable with sgml-ified variant to not confuse
64 2009-03-10 Stefan Kost <ensonic@users.sf.net>
66 patch by: Nicola Fontana <ntd@entidi.it>
69 * tests/bugs/docs/Makefile.am:
70 * tests/bugs/src/tester.h:
71 Improve the test and fix handling trailing decorators. Fixes #574654
73 2009-03-10 Stefan Kost <ensonic@users.sf.net>
75 * tests/bugs/docs/Makefile.am:
76 * tests/bugs/docs/tester-sections.txt:
77 * tests/bugs/src/tester.c:
78 * tests/bugs/src/tester.h:
79 Adding a test for #574654.
81 2009-03-10 Stefan Kost <ensonic@users.sf.net>
84 Don't expect $MODULE to be defined (e.g. if someone does not update
87 2009-03-09 Stefan Kost <ensonic@users.sf.net>
90 Fix ChangeLog format so that we pick up the bug number for release
93 2009-03-09 Stefan Kost <ensonic@users.sf.net>
95 patch by: David Nečas <yeti@physics.muni.cz>
99 Add vim support for syntax highlighting. Lets close the ticket.
102 2009-03-09 Stefan Kost <ensonic@users.sf.net>
104 * gtkdoc-scangobj.in:
105 Don't confuse -1 with G_MAXULONG on 64bit. Fixes #572612.
107 2009-02-26 Stefan Kost <ensonic@users.sf.net>
110 Improve. scan only checks headers, while mkdb scans sources and
113 * examples/Makefile.am:
114 Document more variables.
116 2009-02-26 Stefan Kost <ensonic@users.sf.net>
118 * gtkdoc-scangobj.in:
120 There is some gtk specific stuff there, which we probably want to kick
121 out. No one else gets such a treatment.
123 2009-02-26 Stefan Kost <ensonic@users.sf.net>
128 Fix annotation more. Refactor the extra-link feature. Still disabled
129 by default. Needs configure stuff next.
131 2009-02-24 Stefan Kost <ensonic@users.sf.net>
133 patch by: Paolo Borelli <pborelli@katamail.com>
135 * gtkdoc-scangobj.in:
137 Use g_strerror. Fixes #572967.
139 2009-02-23 Sven Herzberg <herzi@gnome-de.org>
141 * gtkdoc-scangobj.in: keep a reference on the GObjectClass while
142 peeking in interfaces' properties. Fixes #571820
144 2009-02-23 Stefan Kost <ensonic@users.sf.net>
147 Don't use named entities.
149 2009-02-23 Stefan Kost <ensonic@users.sf.net>
151 * gtk-doc-single.xsl:
152 Starting point for generating single page html. Needs refactoring with
153 gtk-doc.xsl (common stuff into gtk-doc-html.xsl).
155 2009-02-23 Stefan Kost <ensonic@users.sf.net>
158 With fop-0.94 it works actually, while 0.95 seesm to have the
164 2009-02-22 Stefan Kost <ensonic@users.sf.net>
170 2009-02-22 Stefan Kost <ensonic@users.sf.net>
179 Remove some crack left from copy'n'paste.
181 2009-02-22 Stefan Kost <ensonic@users.sf.net>
189 * gtk-doc.notmpl.make:
191 * tests/gtk-doc.make:
192 * tests/gtk-doc.notmpl.make:
193 * gtkdoc-mkpdf.in (added):
194 Clean up Makefile rules (be less verbose). Added options to configure to
195 allow selecting the desired output formats. Added initial pdf support (very
196 imature yet, due to several shortcommings of fop - bugs files).
198 2009-02-21 Stefan Kost <ensonic@users.sf.net>
204 Update annotations and fix matching to support parameters.
206 * tests/annotations/docs/tester-sections.txt:
207 * tests/annotations/src/tester.c:
208 * tests/annotations/src/tester.h:
209 Update annotation example and add one more.
211 2009-02-21 Stefan Kost <ensonic@users.sf.net>
214 * help/manual/C/gtk-doc-manual.xml:
215 * tests/gobject/src/gobject.c:
216 Allow linking to struct members. Update docs. Fixes #565126.
218 2009-02-21 Stefan Kost <ensonic@users.sf.net>
222 Fix params and running of 'highlight'.
224 2009-02-21 Stefan Kost <ensonic@users.sf.net>
227 Require the line to ends after the double-colon (sans whitespace),
229 2009-02-20 Stefan Kost <ensonic@users.sf.net>
231 patch by: Damien Lespiau <damien.lespiau@gmail.com>
234 * gtk-doc.notmpl.make:
235 * tests/gtk-doc.make:
236 * tests/gtk-doc.notmpl.make:
237 Add --tag=CC to libtool invocations. Fixes #572396.
239 2009-02-18 Stefan Kost <ensonic@users.sf.net>
241 * examples/Makefile.am:
242 Fix example to show to to make it work even with make distcheck.
244 2009-02-16 Stefan Kost <ensonic@users.sf.net>
247 * tests/gobject/src/gobject.c:
248 Also style <note> tags.
250 2009-02-10 Stefan Kost <ensonic@users.sf.net>
253 Fix the spelling of my name.
255 2009-02-05 Stefan Kost <ensonic@users.sf.net>
261 Single tabs are rendered inconsistently in browsers. Replace them with
264 2009-01-31 Stefan Kost <ensonic@users.sf.net>
266 * tests/gobject/src/gobject.c:
267 Try to link to struct members as a test for Bug #565126.
269 2009-01-30 Stefan Kost <ensonic@users.sf.net>
272 Expanding urls is not a good idea yet. Need to figure out.
274 2009-01-29 Stefan Kost <ensonic@users.sf.net>
277 Remove, this is generated.
279 2009-01-29 Stefan Kost <ensonic@users.sf.net>
282 Automatically creating ulinks for urls.
284 * tests/gobject/src/gobject.c:
285 Add a link for testing.
287 2009-01-28 Stefan Kost <ensonic@users.sf.net>
291 * tests/gobject/docs/tester-docs.xml:
292 * tests/gobject/src/gobject.c:
293 Major CSS cleanup. This is hopefully an end of layout issues related
294 to the fixed navigation bar.
296 2009-01-28 Stefan Kost <ensonic@users.sf.net>
298 patch by: David Nečas <yeti@physics.muni.cz>
301 * tests/gobject/src/giface.c:
302 * tests/gobject/src/gobject.c:
303 Abbreviation where not expanded at the start of text. Fixes #569339.
305 2009-01-28 Stefan Kost <ensonic@users.sf.net>
308 * tests/gobject/examples/gobject.c:
309 Expand urls in comments of examples.
311 2009-01-27 Stefan Kost <ensonic@users.sf.net>
315 Use tables like described in #536928.
318 Comment on why we do the tool check like this.
323 * tests/gobject/docs/tester-docs.xml:
326 2009-01-26 Stefan Kost <ensonic@users.sf.net>
329 * tests/bugs/src/tester.h:
331 * tests/fail/docs/tester-docs.xml:
332 * tests/fail/docs/tester-sections.txt:
333 * tests/fail/src/tester.c:
334 Add public symbols from section file when doing the -undocumented.txt
335 report. Also add the special symbols for the section docs when reading
336 the section-file. Extend test suite to check for it. Fixes #568732
338 2009-01-26 Stefan Kost <ensonic@users.sf.net>
341 * tests/bugs/docs/tester-sections.txt:
342 * tests/bugs/src/tester.c:
343 * tests/bugs/src/tester.h:
344 Handle inline functions in headers. Fixes #532395.
346 2009-01-26 Stefan Kost <ensonic@users.sf.net>
349 Mention onine site for regexp testing.
352 Small output cleanups.
355 Indenting and use LogWarning once more.
357 2009-01-23 Stefan Kost <ensonic@users.sf.net>
360 Recomment out debug log the accidentialy went in.
366 * tests/tools.sh.in (added):
367 Add a check that tests that all scripts are runnable.
369 2009-01-23 Stefan Kost <ensonic@users.sf.net>
372 No need to format a '\n' into a formatstring.
375 Add FIXMEs for Bug 568711.
383 * tests/fail/Makefile.am:
384 * tests/fail/docs/Makefile.am:
385 * tests/fail/docs/tester-docs.xml:
386 * tests/fail/docs/tester-sections.txt:
387 * tests/fail/src/Makefile.am:
388 * tests/fail/src/tester.c:
389 * tests/fail/src/tester.h:
390 Add a test suite for failure checks.
392 2009-01-23 Stefan Kost <ensonic@users.sf.net>
394 patch by: David Nečas <yeti@physics.muni.cz>
397 Don't scan files twice. The patch was slightly changed to name the
398 hash lowercase (uppercase is used for configureation options) and
399 add a comment. Fixes #568708.
401 2009-01-23 Stefan Kost <ensonic@users.sf.net>
403 patch by: David Nečas <yeti@physics.muni.cz>
406 Don't add empty <para></para> tags to the docs to avoid breaking the
407 detection of undocumented things. Fixes #568732.
409 2009-01-23 Stefan Kost <ensonic@users.sf.net>
411 patch by: David Nečas <yeti@physics.muni.cz>
414 Change nonsense error message to tell that gtk-doc is needed to build
415 a given package and not gtk-doc. Fixes #568734.
417 2009-01-23 Stefan Kost <ensonic@users.sf.net>
421 Treat iface/interface like class in other places too.
423 2009-01-23 Stefan Kost <ensonic@users.sf.net>
425 patch by: David Nečas <yeti@physics.muni.cz>
428 Use CamelCase id for interfaces. Fixes #568706.
430 2009-01-23 Stefan Kost <ensonic@users.sf.net>
432 patch by: David Nečas <yeti@physics.muni.cz>
436 * tests/gtk-doc.make:
437 * tests/gtk-doc.notmpl.make:
438 Less quirky way of knowing that we run uninstalled, which is only
439 needed for the tests anyway. In addition to the patch, make same
440 changes in mkman, add a shift to arg parsing to not loop and change
441 the makefiles for the tests. Fixes #568702.
443 2009-01-22 Stefan Kost <ensonic@users.sf.net>
446 Only run the syntax highligher if we have one. Fixes #568714.
448 2009-01-22 Stefan Kost <ensonic@users.sf.net>
451 Point to the right docs.
457 Remove one commented out item.
459 2009-01-21 Stefan Kost <ensonic@users.sf.net>
465 Match css of highlight with source-highlight. Handle line numbering by
466 our-selfs. Still stupid browsers copy '#' chars for each line number.
468 2009-01-21 Stefan Kost <ensonic@users.sf.net>
471 Try to xref first word in 'normal' span.
473 2009-01-20 Stefan Kost <ensonic@users.sf.net>
477 * tests/gobject/src/gobject.c:
478 We could add the language as a comment, it is not shown in the final output.
480 2009-01-20 Stefan Kost <ensonic@users.sf.net>
486 Really fix double extension of entities.
489 Fix link color of xrefs symbols.
491 2009-01-20 Stefan Kost <ensonic@users.sf.net>
497 Fix end of string handling.
500 Use one tango colors one more time.
502 2009-01-20 Stefan Kost <ensonic@users.sf.net>
505 * tests/annotations/docs/Makefile.am:
506 * tests/bugs/docs/Makefile.am:
507 * tests/bugs/docs/tester-docs.xml:
508 * tests/gobject/docs-tmpl/Makefile.am:
509 * tests/gobject/docs/Makefile.am:
510 Detect namespace prefix if not given.
512 2009-01-20 Stefan Kost <ensonic@users.sf.net>
516 Fix gap, caused by double index divs produces by index generated with
517 the docbook stylesheets.
519 2009-01-20 Stefan Kost <ensonic@users.sf.net>
525 Make sure indexdiv and glossarydiv elements have anchors.
529 Fix spacing for navbar in index/glossary pages.
531 * tests/annotations/docs/tester-docs.xml:
532 * tests/gobject/docs/tester-docs.xml:
535 2009-01-19 Stefan Kost <ensonic@users.sf.net>
541 Experiment with navigation for index and glossaries.
545 Fix index entries and copy doc along with the method.
548 also do the extra spacing for the index/glossary environments now.
550 * tests/gobject/docs/tester-docs.xml:
551 Experiment with a more complete doc structure.
553 2009-01-12 Stefan Kost <ensonic@users.sf.net>
556 Make highligher post processing conditional.
558 2009-01-10 Stefan Kost <ensonic@users.sf.net>
561 Erm, not having a highlighter is not fatal.
563 2009-01-10 Stefan Kost <ensonic@users.sf.net>
569 Look for source-highlight and highlight. Not perfect yet, highlight uses
570 different classes in the css :/.
572 * tests/gobject/docs/tester-docs.xml:
573 More header data in the examples.
575 2009-01-09 Stefan Kost <ensonic@users.sf.net>
577 patch by: David Nečas <yeti@physics.muni.cz>
580 Treat FOO_GET_INTERFACE as standard. Fixes #567132.
582 2009-01-09 Stefan Kost <ensonic@users.sf.net>
586 * gtk-doc.notmpl.make:
590 * tests/gobject/examples/gobject.c:
591 * tests/gtk-doc.make:
592 * tests/gtk-doc.notmpl.make:
593 Initial go at implementing syntax highlighting for sources using
594 gnu source-highlight. Needs testing and modularisation.
596 2009-01-08 Stefan Kost <ensonic@users.sf.net>
599 Comment out echo for debugging.
601 2009-01-08 Stefan Kost <ensonic@users.sf.net>
605 * tests/gobject/docs-tmpl/Makefile.am:
606 * tests/gobject/docs/Makefile.am:
607 * tests/gtk-doc.make:
608 * tests/gtk-doc.notmpl.make:
609 Finally, make distcheck works.
611 2009-01-08 Stefan Kost <ensonic@users.sf.net>
622 * gtkdoc-scangobj.in:
625 Add support for --help and --version to remaining tools. Also show a
626 short info on --help and format more consistently. Fixes #566911
628 2009-01-07 Stefan Kost <ensonic@users.sf.net>
632 * gtk-doc.notmpl.make:
633 Detect gtkdoc-rebase in gtk-doc.m4. Based on idea of Sven Herzberg.
636 2009-01-07 Stefan Kost <ensonic@users.sf.net>
642 More thinking about the documentation structure.
645 Add automake support for more distcheck. Use a real sourcefile for the
646 srcdir (something that we wont remove one day).
648 * tests/annotations/docs/Makefile.am:
649 * tests/annotations/src/Makefile.am:
650 * tests/bugs/docs/Makefile.am:
651 * tests/bugs/src/Makefile.am:
652 * tests/gobject/docs-tmpl/Makefile.am:
653 * tests/gobject/docs/Makefile.am:
654 * tests/gobject/src/Makefile.am:
655 Add missing file to fix make distcheck. Use srcdir and not builddir to
658 2009-01-07 Stefan Kost <ensonic@users.sf.net>
661 Ideas about syntax highlighing.
667 Use tango colors. Simplify css.
669 * tests/gobject/src/gobject.c:
670 Tell what language this is.
672 2009-01-04 Stefan Kost <ensonic@users.sf.net>
674 * tests/bugs/src/tester.c:
675 Fix inconsistency of prototype and docs.
677 2009-01-04 Stefan Kost <ensonic@users.sf.net>
679 * tests/gtk-doc.make:
680 * tests/gtk-doc.notmpl.make:
683 2009-01-04 Stefan Kost <ensonic@users.sf.net>
687 * tests/gtk-doc.make:
688 * tests/gtk-doc.notmpl.make:
689 * tests/gtkdoctest.sh:
690 Fix running tests, if no gtk-doc is installed yet.
692 2008-12-29 Stefan Kost <ensonic@users.sf.net>
694 patch by: Bruce van der Kooij <brucevdkooij@gmail.com>
696 * help/manual/C/gtk-doc-manual.xml:
697 Fixed three spelling errors (recommanded, conatins, alibrary).
700 2008-12-29 Stefan Kost <ensonic@users.sf.net>
703 Documentation structure ideas.
705 2008-12-05 Stefan Kost <ensonic@users.sf.net>
708 Hightlight deprecation warnings.
710 2008-12-04 Stefan Kost <ensonic@users.sf.net>
715 2008-12-02 Stefan Kost <ensonic@users.sf.net>
721 * gtk-doc.notmpl.make:
722 Remove the sh -c here now that its back in scanobj.
724 * tests/annotations/docs/tester-docs.xml:
725 * tests/bugs/docs/tester-docs.xml:
726 * tests/gobject/docs-tmpl/tester-docs.xml:
727 * tests/gobject/docs/tester-docs.xml:
728 Cosmetic template update.
730 2008-12-02 Stefan Kost <ensonic@users.sf.net>
733 Don't touch doctype header in expand-content-files.
735 2008-12-01 Stefan Kost <ensonic@users.sf.net>
738 Add deprecation warnings for signals and properties. Also reuse code
739 for since and stability levels there. Fixes #562655.
741 * tests/gobject/src/gobject.c:
742 Add testcase for #562655.
744 2008-12-01 Stefan Kost <ensonic@users.sf.net>
746 * gtkdoc-scangobj.in:
748 Reintroduce "sh -c" and comment why its used. Add real libtool support
749 to old scanobj tool as well.
751 2008-12-01 Stefan Kost <ensonic@users.sf.net>
753 patch by: Matthias Clasen <mclasen@redhat.com>
756 Fix index-id generation for child and style properties. Fixes #562064.
758 2008-11-16 Stefan Kost <ensonic@users.sf.net>
762 * help/manual/C/gtk-doc-manual.xml:
767 2008-11-16 Stefan Kost <ensonic@users.sf.net>
774 * tests/gtk-doc.make:
775 * tests/gtk-doc.notmpl.make:
776 * tests/gtkdoctest.sh:
779 2008-11-06 Stefan Kost <ensonic@users.sf.net>
781 * tests/gtk-doc.make:
782 * tests/gtk-doc.notmpl.make:
783 No install rules for test.
785 2008-11-06 Stefan Kost <ensonic@users.sf.net>
788 Get rid of german variable name. Generate glossary xml for
789 annotations. Improve initial master document.
791 * tests/annotations/docs/tester-docs.xml:
792 Update example to include anotation glossary.
794 2008-11-05 Stefan Kost <ensonic@users.sf.net>
796 patch by: Peter Kjellerstedt <pkj@axis.com>
799 * gtk-doc.notmpl.make:
800 * tests/gtk-doc.make:
801 * tests/gtk-doc.notmpl.make:
802 Correct check for existance of gtkdoc-rebase (better fix than the
803 previous one #508897). Fixes #559281.
805 2008-10-27 Stefan Kost <ensonic@users.sf.net>
807 patch by: Christian Persch <chpe@gnome.org>
809 * gtkdoc-scangobj.in:
810 Fix doc build when using GTK_DISABLE_SINGLE_INCLUDES. Fixes #558082.
812 2008-10-20 Stefan Kost <ensonic@users.sf.net>
816 More docs and planning.
818 2008-10-20 Stefan Kost <ensonic@users.sf.net>
820 * tests/annotations/docs/tester-docs.xml:
821 * tests/annotations/src/tester.c:
822 * tests/gobject/docs/tester-docs.xml:
823 Update annotations. Glossary enhancements.
825 2008-10-19 Stefan Kost <ensonic@users.sf.net>
828 Update and document format.
830 2008-10-17 Stefan Kost <ensonic@users.sf.net>
834 Add new language attribute and use "c" here.
836 2008-10-16 Stefan Kost <ensonic@users.sf.net>
840 Small comment cleanup and loud thinking in TODO :)
842 2008-10-15 Stefan Kost <ensonic@users.sf.net>
844 patch by: Jeffrey Stedfast <fejj@novell.com>
846 * examples/Makefile.am:
848 * gtk-doc.notmpl.make:
849 Allow versioned TARGET_DIR. Fixes #554718.
851 2008-10-13 Stefan Kost <ensonic@users.sf.net>
859 Add support for enums/flags in devhelp index.
862 Support annotations. Fix missing roles.
864 * tests/annotations/docs/tester-docs.xml:
865 * tests/annotations/src/tester.c:
866 * tests/annotations/src/tester.h:
867 * tests/bugs/docs/tester-sections.txt:
868 * tests/gobject/docs/tester-docs.xml:
871 2008-10-11 Stefan Kost <ensonic@users.sf.net>
875 * tests/annotations.sh:
876 * tests/annotations/Makefile.am:
877 * tests/annotations/docs/Makefile.am:
878 * tests/annotations/docs/tester-docs.xml:
879 * tests/annotations/docs/tester-sections.txt:
880 * tests/annotations/src/Makefile.am:
881 * tests/annotations/src/tester.c:
882 * tests/annotations/src/tester.h:
883 Add testcases for gir annotation.
885 2008-10-03 Stefan Kost <ensonic@users.sf.net>
887 patch by: Matthew Barnes <mbarnes@redhat.com>
890 * tests/bugs/docs/tester-sections.txt:
891 * tests/bugs/src/tester.h:
892 Be more careful with "struct _<struct_name>". Fixes #554833.
894 2008-10-03 Stefan Kost <ensonic@users.sf.net>
896 patch by: Behdad Esfahbod <behdad@gnome.org>
899 * gtk-doc.notmpl.make:
900 * tests/gtk-doc.make:
901 * tests/gtk-doc.notmpl.make:
902 Add rules to create $(REPORT_FILES). Fixes #552822.
904 2008-10-03 Stefan Kost <ensonic@users.sf.net>
906 patch by: Simon Josefsson <simon@josefsson.org>
908 * examples/Makefile.am:
909 * tests/bugs/docs/Makefile.am:
910 * tests/gobject/docs-tmpl/Makefile.am:
911 * tests/gobject/docs/Makefile.am:
912 Use GTKDOC_CFLAGS instead of INCLUDES in Makefile.am. Fixes #553407.
914 2008-09-24 Stefan Kost <ensonic@users.sf.net>
917 Use full symbol, if it does not belong to the namespace.
919 2008-09-22 Stefan Kost <ensonic@users.sf.net>
921 * tests/gobject/src/gobject.h:
922 Document some odd behaviour.
924 2008-09-22 Stefan Kost <ensonic@users.sf.net>
929 * tests/bugs/docs/tester-sections.txt:
930 * tests/bugs/src/tester.c:
931 * tests/bugs/src/tester.h:
932 Add testcase for bug 552602.
934 * tests/gtk-doc.make:
935 * tests/gtk-doc.notmpl.make:
936 Also use new RUN envvar here.
938 2008-09-10 Stefan Kost <ensonic@users.sf.net>
941 Generate unique ids for properties, style and child properties.
944 * gtk-doc.notmpl.make:
946 * gtkdoc-scangobj.in:
947 If we use libtool, run scanner under libtool to use uninstalled
950 2008-09-04 Stefan Kost <ensonic@users.sf.net>
961 * gtkdoc-common.pl.in:
963 * help/manual/C/gtk-doc-manual.xml:
964 * tests/bugs/docs/Makefile.am:
965 * tests/bugs/docs/tester-docs.xml:
966 * tests/gobject/docs-tmpl/Makefile.am:
967 * tests/gobject/docs-tmpl/tester-docs.xml:
968 * tests/gobject/docs/Makefile.am:
969 * tests/gobject/docs/tester-docs.xml:
970 * tests/gobject/src/gobject.h:
971 Switch to docbook 4.3 dtd. Fixes #487727.
972 Add --name-space option to gtkdoc-mkdb for nicer indexes. Start with a
973 fo wrapper for pdf output.
975 2008-09-04 Stefan Kost <ensonic@users.sf.net>
978 * gtk-doc.notmpl.make:
979 Don't install index.sgml twice. Also remove the " || :;" construct
980 that ssems to be there only to eat the return code.
982 2008-07-23 Stefan Kost <ensonic@users.sf.net>
986 * tests/bugs/docs/tester-sections.txt:
987 * tests/bugs/src/tester.h:
988 Accept "char const *" as well. Fixes #544172.
990 2008-07-21 Stefan Kost <ensonic@users.sf.net>
993 * gtk-doc.notmpl.make:
994 Only specify options if gtkdoc-mkhtml can take them. Fixes #543855.
997 Don't use bash specific features. Be more flexible so that we can add
1000 2008-07-09 Stefan Kost <ensonic@users.sf.net>
1003 Fix struct/enum level parsing which could go one to high and then the
1004 main struct would never be closed.
1007 2008-06-28 Stefan Kost <ensonic@users.sf.net>
1010 Mention why this change is bad.
1012 2008-06-28 Stefan Kost <ensonic@users.sf.net>
1014 patch by: David Nečas <yeti@physics.muni.cz>
1016 * examples/Makefile.am:
1018 * gtk-doc.notmpl.make:
1020 * tests/gtk-doc.make:
1021 * tests/gtk-doc.notmpl.make:
1022 Add searchpath to gtkdoc.mkhtml. Fixes #460753
1024 2008-06-22 Stefan Kost <ensonic@users.sf.net>
1027 To support timj aclocal setup we are shipping gnome-doc-utils.m4
1028 and making sure automake picks it up ;)
1030 2008-06-22 Stefan Kost <ensonic@users.sf.net>
1032 * tools/migratetmpl.pl:
1033 We were still removing too many <para>s.
1034 Also add andrews trick to escape the c comments.
1035 Add a newline to empty param docs.
1037 2008-06-22 Stefan Kost <ensonic@users.sf.net>
1039 * m4/gnome-doc-utils.m4:
1040 Add this to svn, so that bootstrap work where no gnome-doc-utils is
1043 2008-06-21 Stefan Kost <ensonic@users.sf.net>
1045 * tools/migratetmpl.pl:
1046 Factor out multiline formatting and use for deprecated field too.
1048 2008-06-21 Stefan Kost <ensonic@users.sf.net>
1053 * tools/migratetmpl.pl:
1054 Convert character entities back.
1056 2008-06-21 Stefan Kost <ensonic@users.sf.net>
1059 Start collection info about slowly deprecating crack.
1061 * tools/migratetmpl.pl:
1064 2008-06-21 Stefan Kost <ensonic@users.sf.net>
1066 * tools/migratetmpl.pl:
1067 Use $file in section comment not title. Convert only standalone para
1070 2008-06-21 Stefan Kost <ensonic@users.sf.net>
1072 * tools/migratetmpl.pl:
1073 Convert @Varargs: to @...:
1075 2008-06-21 Stefan Kost <ensonic@users.sf.net>
1077 * tools/migratetmpl.pl:
1078 Convert single line c comments to c++ ones. Indent multiline parameter docs.
1080 2008-06-16 Stefan Kost <ensonic@users.sf.net>
1083 Don't reuse file var, fixes warning context.
1086 Also accept *.hh as headers suffix.
1088 2008-06-10 Stefan Kost <ensonic@users.sf.net>
1091 * gtk-doc.notmpl.make:
1092 * tests/gtk-doc.make:
1093 * tests/gtk-doc.notmpl.make:
1094 Include original CFLAGS / LDFLAGS when building the scanner. Allows to
1095 have own FLAGS defined in addition.
1097 2008-06-08 Stefan Kost <ensonic@users.sf.net>
1102 2008-06-08 Stefan Kost <ensonic@users.sf.net>
1107 * gtkdoc-scangobj.in:
1108 * gtkdoc-scanobj.in:
1109 Merge two fwrite calls.
1111 * tests/gobject/examples/gobject.c:
1112 * tests/gobject/src/gobject.c:
1113 Demostrate how to include source fragments from external files.
1115 * tests/gobject/src/giface.h:
1116 * tests/gobject/src/gobject.h:
1117 Documents two entries.
1119 2008-06-07 Sebastian Dröge <slomo@circular-chaos.org>
1121 * gtkdoc-scangobj.in:
1122 * gtkdoc-scanobj.in:
1123 Add "%s" format strings to printf-like functions when printing
1124 a string. Fixes #536980.
1126 2008-06-05 Stefan Kost <ensonic@users.sf.net>
1128 * gtkdoc-fixxref.in:
1133 * tools/migratetmpl.pl:
1134 Add first version of a tool to support migration from tmpl docs to
1135 source code comments.
1137 2008-06-04 Stefan Kost <ensonic@users.sf.net>
1140 Correct invocation for gnome-doc-prepare.
1142 2008-06-04 Stefan Kost <ensonic@users.sf.net>
1144 * gtkdoc-common.pl.in:
1145 Handle file or line being undefined.
1148 Warn about repeated symbols in sections. Also give line of previous
1149 occurrance. Also give that info for double file entries. Fixes #473342
1150 Give correct error locate for one warning. Fixes #532395 partialy
1152 2008-06-04 Stefan Kost <ensonic@users.sf.net>
1155 Don't warn about overriden docs comment if its the same text.
1157 2008-06-03 Stefan Kost <ensonic@users.sf.net>
1163 Warn and skip double file entries in section files.
1166 Use the new warning format in this script too.
1169 Also use optional parameters here.
1171 2008-06-02 Stefan Kost <ensonic@users.sf.net>
1173 * tests/gobject/docs-tmpl/tester-docs.xml:
1174 * tests/gobject/docs-tmpl/tester-sections.txt:
1175 * tests/gobject/docs/tester-docs.xml:
1176 * tests/gobject/docs/tester-sections.txt:
1177 * tests/gobject/src/giface.c:
1178 * tests/gobject/src/gobject.c:
1179 * tests/gobject/src/gobject.h:
1180 Add some since: tags for the tests too.
1182 2008-06-02 Stefan Kost <ensonic@users.sf.net>
1185 tody up and add some comments regarding HTML_DIR.
1187 * gtkdoc-fixxref.in:
1188 HTML_DIR is not neccesarily set.
1193 * tests/gobject/docs-tmpl/tester-docs.xml:
1194 * tests/gobject/docs/tester-docs.xml:
1195 Add more chapter id's and experiment with an index chapter.
1197 2008-06-02 Stefan Kost <ensonic@users.sf.net>
1200 Improve spacing on indicies and glossaries.
1202 2008-06-02 Stefan Kost <ensonic@users.sf.net>
1205 * tests/bugs/docs/tester-docs.xml:
1206 * tests/gobject/docs/tester-docs.xml:
1207 * tests/gobject/docs/tester-sections.txt:
1208 * tests/gobject/docs-tmpl/tester-docs.xml:
1209 * tests/gobject/docs-tmpl/tester-sections.txt:
1210 * tests/gobject/src/gobject.c:
1211 * tests/gobject/src/gobject.h:
1212 * tests/gtk-doc.make:
1213 * tests/gtk-doc.notmpl.make:
1214 Add some index lists to the tests. Add a deprecated function.
1216 2008-06-02 Stefan Kost <ensonic@users.sf.net>
1218 patch by: Felix Riemann <friemann@svn.gnome.org>
1222 Produce valid html. Fixes #534627.
1224 2008-05-23 Stefan Kost <ensonic@users.sf.net>
1227 * tests/gobject/Makefile.am:
1228 * tests/gobject/docs-tmpl/Makefile.am:
1229 * tests/gobject/docs-tmpl/tester-docs.xml:
1230 * tests/gobject/docs-tmpl/tester-sections.txt:
1231 * tests/gobject/docs-tmpl/tester.types:
1232 * tests/gtk-doc.make:
1233 * tests/gtk-doc.notmpl.make:
1234 Build same docs once again with old tmpl approach.
1236 2008-05-23 Stefan Kost <ensonic@users.sf.net>
1238 * tests/bugs/docs/Makefile.am:
1239 * tests/gobject/docs/Makefile.am:
1240 * tests/gtk-doc.make:
1241 * tests/gtk-doc.notmpl.make:
1244 2008-05-08 Stefan Kost <ensonic@users.sf.net>
1248 Fix a long standing bug that killed spaces in tmpl files.
1250 2008-05-05 Stefan Kost <ensonic@users.sf.net>
1253 Fix regexps changes from previous commit. When using /e the
1254 replacement part has to be a perl snippet.
1256 2008-05-05 Stefan Kost <ensonic@users.sf.net>
1259 * tests/bugs/docs/tester-sections.txt:
1260 * tests/bugs/src/tester.h:
1261 Don't expand '#' in ulink tags. Also allow to escape "#%@" with '\'.
1262 Add to testsuite. Fixes #530758
1264 2008-05-05 Stefan Kost <ensonic@users.sf.net>
1267 It is GObject not GtkObject anymore
1269 2008-05-05 Stefan Kost <ensonic@users.sf.net>
1272 Make note about expanding urls.
1274 * help/manual/C/gtk-doc-manual.xml:
1275 Document the use of |[ ]| as a shortcut for program listing.
1277 * tests/gobject/src/giface.h:
1278 * tests/gobject/src/gobject.c:
1279 Fix one undocumented symbol and add an exampl of the programlisting
1282 2008-04-22 Stefan Kost <ensonic@users.sf.net>
1285 We need to update the webpage.
1292 Hopefully now unbreak the docbuild, if one has template but not uses
1295 2008-04-17 Stefan Kost <ensonic@users.sf.net>
1298 Add one more warning. Also trac location of section docs. Merge
1299 source symbols once and then on demand (if we read a template).
1301 2008-04-11 Stefan Kost <ensonic@users.sf.net>
1305 Idea about the tracing. Not that practical as it is.
1309 Unify file-error messages. Improve warning detail. Fix undocumented
1310 status for template less runs.
1312 2008-04-10 Stefan Kost <ensonic@users.sf.net>
1317 * gtkdoc-common.pl.in:
1318 Add common method for prining (gcc-style) warnings.
1321 Use new method. Harmonize the warnings a bit. Remember locations
1322 symbols are taken from template files for use in warnings.
1324 2008-04-09 Stefan Kost <ensonic@users.sf.net>
1327 Some releasing info.
1330 Print file/line number in warning.
1332 * help/manual/C/gtk-doc-manual.xml:
1333 Some docs for what the <module>-overrides.txt file is for.
1335 2008-03-23 Stefan Kost <ensonic@users.sf.net>
1338 Tell automake to not warn us about portabillity issues. Its too late
1342 Surgery for the bugnumber.
1344 2008-03-21 Marc-Andre Lureau <marcandre.lureau@gmail.com>
1346 * .svnignore, Makefile.am, autogen.sh, configure.in,
1347 help/manual/.svnignore, help/manual/C/ChangeLog,
1348 help/manual/C/Makefile.am, help/manual/C/gtk-doc-manual-C.omf.in,
1349 help/manual/C/gtk-doc-manual.xml, help/manual/ChangeLog,
1350 help/manual/Makefile.am, help/manual/gtk-doc-manual.omf.in,
1351 m4/.svnignore, omf.make, xmldocs.make:
1352 GNOME doc-utils migration. Fixes #335239
1354 2008-03-22 Stefan Kost <ensonic@users.sf.net>
1358 * help/manual/C/gtk-doc-manual.xml:
1359 Back to development.
1361 === Release 1.10 ===
1363 2008-03-19 Stefan Kost <ensonic@users.sf.net>
1367 Prepare for release.
1370 Add fix for footnote positions.
1372 2008-02-27 Stefan Kost <ensonic@users.sf.net>
1374 patch by: Carlos Garnacho <carlos@imendio.com>
1377 Update emacs mode to work with emacs22. Fixes #513318.
1379 2008-02-01 Stefan Kost <ensonic@users.sf.net>
1381 * gtkdoc-common.pl.in:
1384 * tests/bugs/src/tester.h:
1385 Improve tmpl parsing and add some more logging. Fixes #512154.
1387 2008-01-30 Stefan Kost <ensonic@users.sf.net>
1389 * tests/bugs/docs/tester-sections.txt:
1390 * tests/bugs/src/tester.h:
1391 Add testcase for #512154.
1393 2008-01-28 Stefan Kost <ensonic@users.sf.net>
1396 Condense all the multiple newlines in the generated xml.
1398 * tests/gtk-doc.make:
1399 Make sure the testsuite call the uninstalled scripts.
1401 2008-01-24 Stefan Kost <ensonic@users.sf.net>
1404 Unbreak fixxref. The index.sgml file should not have leading
1405 whitespace. These were caused by indenting the xsl, which is dangerous
1406 in case of <xsl:text>.
1408 * gtkdoc-fixxref.in:
1411 2008-01-21 Stefan Kost <ensonic@users.sf.net>
1413 * gtkdoc-common.pl.in:
1414 Don't warn when parsing enum struct members.
1416 2008-01-21 Stefan Kost <ensonic@users.sf.net>
1420 Give file and line number when complaining about duplicate
1421 definitions. Seems to not have been applied with older commit.
1424 * tests/gobject/src/gobject.h:
1425 Handle typedef enums.
1427 2008-01-17 Stefan Kost <ensonic@users.sf.net>
1430 * gtk-doc.notmpl.make:
1431 Don't fail in dist when no .types file is present. Fixes #509539.
1433 2008-01-16 Stefan Kost <ensonic@users.sf.net>
1437 Give file and line number when complaining about duplicate
1440 2008-01-14 Stefan Kost <ensonic@users.sf.net>
1442 patch by: Joe Marcus Clarke <marcus@freebsd.org>
1445 * gtk-doc.notmpl.make:
1446 Do not abort the build, if gtk-doc is not installed. Fixes #508897
1448 2007-12-20 Mathias Hasselmann <mathias@openismus.com>
1451 Lower Python dependency to 2.3 (#503054). Just warn when Python
1452 wasn't found. Print a configuration summary before leaving the
1455 Do not install gtkdoc-depscan when Python wasn't found.
1457 2007-12-20 Mathias Hasselmann <mathias@openismus.com>
1459 * gtkdoc-depscan.in:
1460 Use old and/or pattern instead of the new ternary operator.
1461 This drops the Python 2.5 dependency for that script.
1462 Original patch by Frederic Peters. (#503054)
1464 2007-12-17 Mathias Hasselmann <mathias@openismus.com>
1467 Use AM_PATH_PYTHON instread of AC_PATH_PROG to find Python.
1470 2007-12-17 Stefan Kost <ensonic@users.sf.net>
1473 Render accronyms from docbook and glossary in html.
1475 2007-12-17 Stefan Kost <ensonic@users.sf.net>
1477 * tests/bugs/docs/tester-docs.sgml:
1478 * tests/bugs/docs/tester-docs.xml:
1479 * tests/gobject/docs/tester-docs.sgml:
1480 * tests/gobject/docs/tester-docs.xml:
1481 Add the xml instead of the sgml docs.
1483 2007-12-12 Stefan Kost <ensonic@users.sf.net>
1486 * gtk-doc.notmpl.make:
1487 Revert last change and reopen #503119. Needs a different fix.
1489 2007-12-12 Stefan Kost <ensonic@users.sf.net>
1492 * gtk-doc.notmpl.make:
1493 Use content_files as a dependency the sgml-build.stamp.
1495 2007-12-11 Mathias Hasselmann <mathias@openismus.com>
1497 * gtkdoc-depscan.in:
1498 Use colon as name-version-separator in book names.
1500 2007-12-11 Mathias Hasselmann <mathias@openismus.com>
1502 * gtkdoc-depscan.in:
1503 Also scan devhelp folders.
1505 2007-12-11 Mathias Hasselmann <mathias@openismus.com>
1507 * gtkdoc-depscan.in:
1508 Print reasonable error message when passing
1509 non-existant files on command line.
1511 2007-12-11 Stefan Kost <ensonic@users.sf.net>
1513 patch by: Kouhei Sutou <kou@cozmixng.org>
1516 Consitently use UTF-8 instead of US-ASCII for output encoding.
1519 2007-12-10 Mathias Hasselmann <mathias@openismus.com>
1522 * gtkdoc-depscan.in:
1524 Add gtkdoc-depscan, which resolves source code dependencies
1525 by scanning devhelp2 books.
1527 2007-12-10 Stefan Kost <ensonic@users.sf.net>
1532 * gtk-doc.notmpl.make:
1533 Remove left-over 'fi'.
1535 2007-12-05 Stefan Kost <ensonic@users.sf.net>
1538 * gtk-doc.notmpl.make:
1539 Better fix for #501066.
1541 2007-12-05 Stefan Kost <ensonic@users.sf.net>
1544 Add first version of the schema.
1547 Unbreak the devhelp2 file generation.
1549 * tests/gtkdoctest.sh:
1550 Add comment about doing schmea checks once they work.
1552 2007-12-04 Stefan Kost <ensonic@users.sf.net>
1555 * gtk-doc.notmpl.make:
1556 Apply build flags cleanups from #498521. Spotted by
1557 dmacks@netspace.org.
1559 2007-12-04 Stefan Kost <ensonic@users.sf.net>
1561 * tests/gobject/src/giface.c:
1562 * tests/gobject/src/gobject.c:
1563 Uhm, unbreak the links in the test docs.
1565 2007-12-04 Stefan Kost <ensonic@users.sf.net>
1567 * tests/gobject/src/giface.c:
1568 * tests/gobject/src/gobject.c:
1569 Little test cleanup. The bug was already fixed.
1571 2007-12-04 Stefan Kost <ensonic@users.sf.net>
1573 * tests/gobject/docs/tester-sections.txt:
1574 * tests/gobject/docs/tester.types:
1575 * tests/gobject/src/Makefile.am:
1576 * tests/gobject/src/giface.c:
1577 * tests/gobject/src/giface.h:
1578 * tests/gobject/src/gobject.c:
1579 * tests/gobject/src/gobject.h:
1580 * tests/gobject/src/tester.c:
1581 * tests/gobject/src/tester.h:
1582 Refactor tests for #489279.
1584 2007-12-04 Stefan Kost <ensonic@users.sf.net>
1586 * gtkdoc-common.pl.in:
1587 * tests/bugs/docs/tester-sections.txt:
1588 * tests/bugs/src/tester.h:
1589 Add testcase for #501038. Improve struct parsing to correctly finish
1590 if the last line in struct declaration was a preprocessor statement.
1593 2007-12-04 Stefan Kost <ensonic@users.sf.net>
1595 patch by: David Nečas <yeti@physics.muni.cz>
1597 * gtkdoc-common.pl.in:
1598 * tests/bugs/docs/tester-sections.txt:
1599 * tests/bugs/src/tester.c:
1600 * tests/bugs/src/tester.h:
1601 Handle forward typedef'd enums. Fixes #446648.
1603 2007-12-02 Loïc Minier <lool@dooz.org>
1606 * gtk-doc.notmpl.make:
1607 Add double-quotes around `which gtkdoc-rebase` to prevent "test"
1608 from failing with "/bin/sh: line 11: test: !=: unary operator
1609 expected ". Fixes #501066.
1611 2007-11-11 Stefan Kost <ensonic@users.sf.net>
1613 patch by: David Nečas <yeti@physics.muni.cz>
1617 Avoid generated node ids. Fixes #365913.
1619 2007-11-11 Stefan Kost <ensonic@users.sf.net>
1624 Alternative and cleaner footer implementation (unblock #365913).
1626 2007-11-11 Stefan Kost <ensonic@users.sf.net>
1628 patch by: David Nečas <yeti@physics.muni.cz>
1631 * gtkdoc-scangobj.in:
1632 Display proper types for pointer properties. Fixes #468278.
1634 2007-10-31 Stefan Kost <ensonic@users.sf.net>
1637 Only warn about missing deprecation guards for declared symbols.
1640 2007-10-31 Stefan Kost <ensonic@users.sf.net>
1642 * tests/gtk-doc.make:
1643 * tests/gtkdoctest.sh:
1644 Run our own check script. Clean the make output a bit.
1646 2007-10-31 Stefan Kost <ensonic@users.sf.net>
1648 * help/manual/C/gtk-doc-manual.xml:
1651 2007-10-31 Stefan Kost <ensonic@users.sf.net>
1657 * tests/gtk-doc.make:
1658 Cleanup the 'make check' deps configure check.
1660 2007-10-01 Stefan Kost <ensonic@users.sf.net>
1663 * help/manual/C/gtk-doc-manual.xml:
1664 Back to development.
1668 2007-09-30 Stefan Kost <ensonic@users.sf.net>
1673 2007-09-27 Stefan Kost <ensonic@users.sf.net>
1676 * gtk-doc.notmpl.make:
1678 New day, new fix. Remove testing $(DESTDIR) from makefile and use
1679 Getopt::Long qw(:config gnu_getopt); in rebase.
1681 2007-09-26 Stefan Kost <ensonic@users.sf.net>
1684 And actually saving before commiting might greatly help.
1686 2007-09-26 Stefan Kost <ensonic@users.sf.net>
1689 * gtk-doc.notmpl.make:
1690 Another attempt to fix the rules.
1692 2007-09-26 Stefan Kost <ensonic@users.sf.net>
1695 * gtk-doc.notmpl.make:
1696 If there is nothing to install, don't rebase.
1698 2007-09-26 Stefan Kost <ensonic@users.sf.net>
1701 * gtk-doc.notmpl.make:
1702 Unbreak the last change.
1704 2007-09-26 Stefan Kost <ensonic@users.sf.net>
1707 * gtk-doc.notmpl.make:
1708 Handle DESTDIR= case.
1710 2007-09-26 Stefan Kost <ensonic@users.sf.net>
1713 * gtk-doc.notmpl.make:
1715 Fix destdir option name.
1717 2007-09-25 Stefan Kost <ensonic@users.sf.net>
1719 * tests/gtk-doc.make:
1720 Get make distcheck fully working.
1722 2007-09-25 Stefan Kost <ensonic@users.sf.net>
1724 * tests/Makefile.am:
1727 * tests/gtkdoctest.sh:
1728 Try to get make distcheck to run.
1730 * tests/gtk-doc.make:
1731 Don't dist docs generated during test runs and remove some cruft.
1734 2007-09-24 Stefan Kost <ensonic@users.sf.net>
1736 patch by: David Nečas <yeti@physics.muni.cz>
1739 * tests/bugs/docs/Makefile.am:
1740 * tests/gobject/docs/Makefile.am:
1741 * tests/gtk-doc.make:
1742 Adapt xml/ cleaning from gtk-doc.notmpl.make. Clean log files.
1744 2007-09-24 Stefan Kost <ensonic@users.sf.net>
1747 Current release notes.
1749 2007-09-24 Stefan Kost <ensonic@users.sf.net>
1754 * examples/Makefile.am:
1756 * gtk-doc.notmpl.make:
1757 Process files from DISTCLEANFILES in the dist-hooks.
1759 2007-09-24 Stefan Kost <ensonic@users.sf.net>
1761 patch by: David Nečas <yeti@physics.muni.cz>
1764 Add gtk-doc.notmpl.make to EXTRA_DIST. Fixes #479913.
1766 2007-09-20 Stefan Kost <ensonic@users.sf.net>
1768 * gtkdoc-fixxref.in:
1769 Revert online option for fixxref now that we have a rebase command.
1771 2007-09-18 Stefan Kost <ensonic@users.sf.net>
1774 Handle function pointers. Fixes #477532.
1776 2007-09-18 Stefan Kost <ensonic@users.sf.net>
1778 patch by: David Nečas <yeti@physics.muni.cz>
1781 Parse reoccuring const. Fixes #471014.
1783 * tests/bugs/docs/Makefile.am:
1784 * tests/bugs/docs/tester-sections.txt:
1785 * tests/bugs/src/tester.c:
1786 * tests/bugs/src/tester.h:
1787 * tests/gobject/docs/Makefile.am:
1788 * tests/gobject/src/tester.c:
1789 * tests/gobject/src/tester.h:
1790 Add more tests and cleanup the test-code a little.
1792 2007-09-17 Stefan Kost <ensonic@users.sf.net>
1795 * gtk-doc.notmpl.make:
1796 Revert some Makefile improvements, as we can't control the quoting
1799 2007-09-11 Stefan Kost <ensonic@users.sf.net>
1802 Default master doc should have proper extension. Fixes #467773.
1804 2007-09-11 Stefan Kost <ensonic@users.sf.net>
1806 patch by: David Nečas <yeti@physics.muni.cz>
1809 * gtk-doc.notmpl.make:
1810 Makefile improvements.
1812 2007-09-03 Stefan Kost <ensonic@users.sf.net>
1815 Update MAINTAINER to adhere to rules given on
1816 http://live.gnome.org/MaintainersCorner#maintainers
1818 2007-08-23 Benjamin Otte <otte@gnome.org>
1821 sync with gtkdoc-mkdb completely. Really fixes #419997
1823 2007-08-21 Stefan Kost <ensonic@users.sf.net>
1827 Add divider and empty space at the bottom. Mostly fixes #448879.
1829 2007-08-21 Stefan Kost <ensonic@users.sf.net>
1832 * gtk-doc.notmpl.make:
1833 Make use of rebase if possible. Fixes #465920
1836 Rebase improvements and fixes.
1838 2007-08-16 Stefan Kost <ensonic@users.sf.net>
1842 * help/manual/.cvsignore:
1843 * help/manual/C/.cvsignore:
1844 Get rid of cvsignore files.
1846 2007-08-14 Stefan Kost <ensonic@users.sf.net>
1848 * gtkdoc-common.pl.in:
1849 * tests/bugs/docs/tester-sections.txt:
1850 * tests/bugs/src/tester.h:
1851 Don't die when encountering #if/#endif in enums. Fixes #324535.
1853 2007-08-14 Stefan Kost <ensonic@users.sf.net>
1855 patch by: Frederic Peters <fpeters@0d.be>
1860 2007-08-14 Stefan Kost <ensonic@users.sf.net>
1862 * help/manual/C/gtk-doc-manual.xml:
1863 Document new features and bump version.
1865 2007-08-13 Stefan Kost <ensonic@users.sf.net>
1868 Fix the funny side-effect of last 'broken-returns' fix.
1870 2007-08-13 Stefan Kost <ensonic@users.sf.net>
1873 * tests/bugs/src/tester.h:
1876 2007-08-13 Stefan Kost <ensonic@users.sf.net>
1879 Now the 'broken' returns seems to work better. Fixes #380824 more.
1881 2007-08-13 Stefan Kost <ensonic@users.sf.net>
1883 * tests/bugs/docs/tester-sections.txt:
1884 * tests/bugs/src/tester.c (bug_379466, bug_380824):
1885 * tests/bugs/src/tester.h (test):
1887 * tests/gtkdoctest.sh:
1890 2007-08-12 Stefan Kost <ensonic@users.sf.net>
1892 * tests/bugs/docs/tester-sections.txt:
1893 * tests/bugs/src/tester.h:
1894 Add another test for a bug we fixed with the changes below.
1897 2007-08-12 Stefan Kost <ensonic@users.sf.net>
1900 * tests/bugs/docs/tester-sections.txt:
1901 * tests/bugs/src/tester.c:
1902 * tests/bugs/src/tester.h:
1903 Improved scan logic. Fixes #411739.
1905 2007-08-12 Stefan Kost <ensonic@users.sf.net>
1908 * tests/bugs/src/tester.h:
1909 Handle newline in declarations better. Fixes #379466.
1910 Ensure space in multiline declarations when removing the newline.
1911 Fix missing argument docs in template free build.
1913 2007-08-12 Stefan Kost <ensonic@users.sf.net>
1917 Handle "unsigned long|unsigned short|signed long|signed short".
1920 2007-08-12 Stefan Kost <ensonic@users.sf.net>
1926 Replacing my shell based test script by Davids perl based one. Add
1927 licence, copyright and docs header. Integrate with build.
1929 2007-08-12 Stefan Kost <ensonic@users.sf.net>
1931 patch by: David Nečas <yeti@physics.muni.cz>
1933 * gtkdoc-scangobj.in:
1934 Make introspection of interfaces work in more cases. Fixes #355352.
1936 2007-08-12 Stefan Kost <ensonic@users.sf.net>
1938 patch by: David Nečas <yeti@physics.muni.cz>
1941 Cleanup glib detection for tests.
1943 2007-08-11 Stefan Kost <ensonic@users.sf.net>
1946 Fix modulename check.
1948 2007-08-11 Stefan Kost <ensonic@users.sf.net>
1951 Install new makefile.
1954 Bump version as we're working on 1.9.
1957 Add option to select makefile-flavour.
1959 2007-08-11 Stefan Kost <ensonic@users.sf.net>
1962 Add dummy rule to make first build run through. Fixes #156643
1964 2007-08-11 Stefan Kost <ensonic@users.sf.net>
1967 Hide fixed navigationbar when printing. Fixes #449618
1969 2007-08-11 Stefan Kost <ensonic@users.sf.net>
1971 * gtk-doc.notmpl.make:
1972 Add new makefile for tmpl-less build.
1974 2007-08-11 Stefan Kost <ensonic@users.sf.net>
1976 patch by: David Nečas <yeti@physics.muni.cz>
1979 Accepts automake 1.10 too. Fixes #459225
1981 2007-08-11 Stefan Kost <ensonic@users.sf.net>
1984 Make the tmpl-less build work.
1986 * tests/gtk-doc.make:
1987 Switch again to the tmpl-less build.
1989 2007-08-10 Stefan Kost <ensonic@users.sf.net>
1991 patch by: Rouslan Solomakhin <rouslan@solomakhin.net>
1996 2007-08-10 Stefan Kost <ensonic@users.sf.net>
1999 * tests/gtk-doc.make:
2000 Revert fix for #433338 and reopen bug. Breaks if file is not there,
2001 e.g. if --rebuild-types is used.
2003 2007-08-10 Stefan Kost <ensonic@users.sf.net>
2008 * tests/gtk-doc.make:
2009 Try the tmpl free build here.
2011 2007-08-10 Stefan Kost <ensonic@users.sf.net>
2013 * examples/Makefile.am:
2014 Add commented out TESTS.
2017 Check for location of gtkdoc-check.
2021 Test doc status and print result in check like layout.
2023 2007-08-02 Stefan Kost <ensonic@users.sf.net>
2025 patch by: Sven Herzberg <herzi@gnome-de.org>
2028 * tests/gtk-doc.make:
2029 Rebuild documentation of $(DOC_MODULE).types changed. Fixes #433338
2031 2007-08-02 Stefan Kost <ensonic@users.sf.net>
2033 patch by: David Nečas <yeti@physics.muni.cz>
2038 Allow rebasing cross-references in generated docs. Fixes #434134.
2040 2007-08-02 Stefan Kost <ensonic@users.sf.net>
2043 Add a hack to gtkdoc-mkhtml to run uninstalled too.
2045 2007-08-02 Stefan Kost <ensonic@users.sf.net>
2047 Patch by: David Nečas <yeti@physics.muni.cz>
2050 Generate ONLINE tag in index.sgml.
2052 * gtkdoc-fixxref.in:
2053 Allow to base links against online versions of xreffed docs.
2057 Add releaseinfo to doctemplates.
2059 * tests/bugs/docs/tester-docs.sgml:
2060 * tests/gobject/docs/tester-docs.sgml:
2063 2007-08-02 Stefan Kost <ensonic@users.sf.net>
2065 * tests/bugs/docs/Makefile.am:
2066 * tests/gobject/docs/Makefile.am:
2067 * tests/gtk-doc.make:
2068 Use PERL5LIB envvar to use uninstalled gtkdoc-common.pl for tests.
2069 Use tee to both show and redirect logs.
2070 Build test-docs in check-local instead of all-local.
2073 2007-07-25 Stefan Kost <ensonic@users.sf.net>
2077 Some more debug prints and code cleaning.
2079 2007-07-23 Stefan Kost <ensonic@users.sf.net>
2081 Patch by: Yeti <yeti@physics.muni.cz>
2085 Report undeclared symbols into a file. Fixes #436565.
2087 2007-07-18 Stefan Kost <ensonic@users.sf.net>
2090 Readd two debug prints and remove one obsolete one.
2092 * tests/bugs/Makefile.am:
2093 * tests/gobject/Makefile.am:
2094 Enforce 'make clean' before 'make check'.
2096 2007-07-18 Stefan Kost <ensonic@users.sf.net>
2098 Patch by: Yeti <yeti@physics.muni.cz>
2101 Cleanup broek-return handling and add ignore_broken_returns for
2102 section docs. Fixes #457077
2104 * tests/bugs/docs/Makefile.in:
2105 * tests/gobject/docs/Makefile.in:
2108 * tests/gtk-doc.make:
2109 Use the local tools so that 'make check' works uninstalled.
2112 2007-07-18 Stefan Kost <ensonic@users.sf.net>
2114 * tests/bugs/docs/tester-sections.txt:
2115 * tests/bugs/src/tester.c: (bug_419997):
2116 * tests/bugs/src/tester.h:
2117 * tests/gobject/src/tester.c: (gtkdoc_tester_class_init):
2118 * tests/gobject/src/tester.h:
2119 Add more test cases.
2121 2007-07-17 Stefan Kost <ensonic@users.sf.net>
2123 * tests/bugs/docs/Makefile.in:
2124 * tests/bugs/docs/tester-sections.txt:
2125 * tests/bugs/src/tester.c: (bug_141869_a), (bug_141869_b),
2126 (bug_379466), (bug_445693):
2127 * tests/bugs/src/tester.h:
2128 * tests/gtk-doc.make:
2129 * tests/gtkdoctest.sh:
2132 2007-07-17 Stefan Kost <ensonic@users.sf.net>
2134 Patch by: Yeti <yeti@physics.muni.cz>
2136 * gtkdoc-common.pl.in:
2140 Improve paramenter parsing to allow parameter names that contain
2141 const or restricted. Fixes #419997
2142 Also fix the signed/unsigned more.
2144 2007-07-17 Stefan Kost <ensonic@users.sf.net>
2149 * tests/Makefile.am:
2151 * tests/bugs/Makefile.am:
2152 * tests/bugs/docs/Makefile.am:
2153 * tests/bugs/docs/Makefile.in:
2154 * tests/bugs/docs/tester-docs.sgml:
2155 * tests/bugs/docs/tester-sections.txt:
2156 * tests/bugs/docs/tester.types:
2157 * tests/bugs/src/Makefile.am:
2158 * tests/bugs/src/tester.c: (bug_445693), (bug_141869_a),
2160 * tests/bugs/src/tester.h:
2162 * tests/gobject/Makefile.am:
2163 * tests/gobject/docs/Makefile.am:
2164 * tests/gobject/docs/Makefile.in:
2165 * tests/gobject/docs/tester-docs.sgml:
2166 * tests/gobject/docs/tester-sections.txt:
2167 * tests/gobject/docs/tester.types:
2168 * tests/gobject/src/Makefile.am:
2169 * tests/gobject/src/tester.c: (gtkdoc_tester_new),
2170 (gtkdoc_tester_get_property), (gtkdoc_tester_set_property),
2171 (gtkdoc_tester_class_init), (gtkdoc_tester_get_type):
2172 * tests/gobject/src/tester.h:
2173 * tests/gtk-doc.make:
2174 * tests/gtkdoctest.sh:
2175 Add test-suite. Fixes #457173
2177 2007-07-16 Stefan Kost <ensonic@users.sf.net>
2179 Patch by: Yeti <yeti@physics.muni.cz>
2182 Avoid useless $return_start access.
2184 2007-07-16 Stefan Kost <ensonic@users.sf.net>
2186 Patch by: Petteri Räty <betelgeuse@gentoo.org>
2189 Make gtk-doc.m4 fail when needed gtk-doc is not installed and notify
2190 user. Fixes #323938 and #450338.
2192 2007-07-15 Stefan Kost <ensonic@users.sf.net>
2196 Handle signed/unsigned without int. Fixes #141869.
2198 2007-07-15 Stefan Kost <ensonic@users.sf.net>
2200 Patch by: Yeti <yeti@physics.muni.cz>
2203 Improve handling of legacy "return" statement doc parsing. Warn about
2206 2007-07-15 Stefan Kost <ensonic@users.sf.net>
2209 Fix perl warning about usage of undefined symbol.
2211 2007-07-15 Stefan Kost <ensonic@users.sf.net>
2215 Sync the function decl arg parsing. Fixes #419308.
2217 2007-07-15 Stefan Kost <ensonic@users.sf.net>
2219 * gtkdoc-fixxref.in:
2220 Improve the ---help output a little.
2222 2007-07-15 Stefan Kost <ensonic@users.sf.net>
2224 * gtkdoc-fixxref.in:
2225 Improve detection of absolute/relatives paths. Skip duplicate paths.
2228 2007-06-14 Lo�c Minier <lool@dooz.org>
2231 Cleanup $(DOC_MODULE)-undocumented.txt files in
2232 maintainer-clean-local. Fixes #415388.
2234 2007-06-14 Lo�c Minier <lool@dooz.org>
2237 Fix warnings in m4 macros when running "autoreconf -fi -Wall";
2238 Guillem Jover. Fixes #428596.
2240 2007-06-11 Damon Chaplin <damon@gnome.org>
2242 * gtkdoc-mkdb.in (ExpandAbbreviations): just output "signal" and
2243 "property" as the text for cross-reference links to signals and
2244 properties, rather than something like "Object::signal" which can get
2245 a bit long. Also tidied up the code a little.
2246 (GetArgs): put the " inside the literal element.
2247 (GetSignals): use a literal element for the signal name in the title,
2248 to match the properties.
2250 2007-03-16 Stefan Kost <ensonic@users.sf.net>
2252 * gtkdoc-common.pl.in: handle preprocessor statements in enum and
2253 struct declarations. Fixes #418027.
2255 2007-02-27 Stefan Kost <ensonic@users.sf.net>
2257 * gtk-doc.xsl: create toc for part and reference
2259 * style.css: Fix placement of div.reference
2263 2007-02-16 Damon Chaplin <damon@gnome.org>
2267 2007-02-16 Damon Chaplin <damon@gnome.org>
2269 * gtkdoc-scan.in: only rebuild the .types file automatically on the
2270 very first run (i.e. when there are no sections or types files).
2272 * gtkdoc-scangobj.in: skip gnome_keyring_item_info_get_type if it is
2273 in the .types file as it isn't a real GObject type. This is a hack to
2274 avoid breaking the GNOME build. See bug #386508.
2276 2007-02-11 Stefan Kost <ensonic@users.sf.net>
2278 * gtk-doc.xsl: fix prerequisite section in nav-header
2280 2007-02-07 Stefan Kost <ensonic@users.sf.net>
2282 * style.css: fixing footnote subscripts, make tables look nicer.
2285 2007-02-07 Damon Chaplin <damon@gnome.org>
2287 * gtk-doc.make: make $(DOC_MODULE)-sections.txt and
2288 $(DOC_MODULE)-overrides.txt depend on scan-build.stamp, so that
2289 parallel make works. #404122, Ed Catmur.
2291 2007-02-07 Damon Chaplin <damon@gnome.org>
2293 * gtkdoc-scangobj.in: don't return if !G_TYPE_IS_OBJECT (object_type)
2294 as that means interface properties don't get output. This was broken
2295 by the patch for #348058.
2297 2007-01-21 Damon Chaplin <damon@gnome.org>
2299 * gtkdoc-mkdb.in: added "--default-includes" option to specify the
2300 default "#include"s to place at the top of the synopsis of each
2301 section. Normally this is specified in a <INCLUDE>...</INCLUDE> line
2302 in MODULE-sections.txt, but if you are using the "--rebuild-sections"
2303 option to automatically rebuild the MODULE-sections.txt file you can't
2306 2007-01-21 Damon Chaplin <damon@gnome.org>
2308 * gtkdoc-mktmpl.in (ReadTemplateFile):
2309 * gtkdoc-mkdb.in (ReadTemplateFile): improved param regexp to handle
2310 weird macro vararg names like "format...". #398971.
2312 2007-01-16 Damon Chaplin <damon@gnome.org>
2314 * gtkdoc-mkdb.in: support "Include" setting in section docs in source
2315 code, same as <INCLUDE>...</INCLUDE> setting in sections.txt file.
2318 2007-01-16 Damon Chaplin <damon@gnome.org>
2320 * gtkdoc-mkdb.in (OutputMacro): try to line up multiple lines of
2321 arguments if possible. #384249
2323 2007-01-16 Damon Chaplin <damon@gnome.org>
2325 * gtkdoc-scan.in (ScanHeader): for headers marked private, return
2326 immediately so we don't add anything to the sections file. #395005.
2328 2007-01-16 Damon Chaplin <damon@gnome.org>
2330 * gtkdoc-mkdb.in: a number of changes to help when adding example code
2331 to the docs (#368382):
2333 a) Support CDATA in source code comments. (We don't touch anything in
2335 b) Support |[ ... ]| to include example code. (Just gets converted to
2336 <informalexample><programlisting>)
2337 c) Improve <programlisting> handling, by not inserting <para></para>
2338 and not expanding "()", "@" or "%". (It still expands '#' so people
2339 can use cross-references to any symbols if they want to.).
2340 d) Improve '#' links a bit by skipping symbols that look like C
2341 preprocessor directives (e.g. "#include").
2342 e) Improve '&' handling a bit by converting to '&' if it doesn't
2343 already look like the start of an entity reference.
2344 f) Added special case for "#include <xxxx>" in <programlisting> so the
2345 "<" and ">" get replaced by entities.
2347 * gtkdoc-mktmpl.in (ReadTemplateFile):
2348 * gtkdoc-mkdb.in (ReadTemplateFile): fixed param regexp so it handles
2349 "@...:" for varargs again. It also cleans up messed up template files
2352 2007-01-04 Damon Chaplin <damon@gnome.org>
2354 * gtk-doc.make (dist-hook): abort dist if html docs aren't generated.
2355 #166462, Gustavo Carneiro.
2357 2007-01-03 Damon Chaplin <damon@gnome.org>
2359 * gtkdoc-mkdb.in: improved output a little - made field widths larger,
2360 removed signal prototypes from synopsis, and capitalized all signal
2361 flags (to be consistent with argument capitalization). #384247,
2362 Hans Petter Jansson.
2364 2007-01-03 Damon Chaplin <damon@gnome.org>
2366 * gtkdoc-mktmpl.in (OutputDeclaration):
2367 * gtkdoc-mkdb.in (OutputFunction): fix parsing of "char * const"
2368 arguments, with an extra "\s*". #387681
2370 2007-01-03 Damon Chaplin <damon@gnome.org>
2373 * xmldocs.make: updated to new versions from gnome-common. #363622
2374 Also reverted the changes made for #316508 since they may cause
2375 problems. We'll let the scrollkeeper/gnome-common/autoconf people
2376 sort out that issue.
2378 2006-12-07 Ross Burton <ross@burtonini.com>
2380 * help/manual/C/gtk-doc-manual.xml:
2381 Add examples of how to document structs, properties and signals
2384 2006-12-04 Damon Chaplin <damon@gnome.org>
2386 * gtkdoc-scangobj.in: added a '--query-child-properties' argument to
2387 allow you to specify a function to return a list of child properties
2388 for a class (similar to GtkContainer child properties). #379203
2390 2006-10-16 Damon Chaplin <damon@gnome.org>
2392 * gtkdoc-scangobj.in: remove a shadow declaration to avoid compiler
2395 2006-10-15 Damon Chaplin <damon@gnome.org>
2397 * gtkdoc-scan.in: added a '--rebuild-sections' option that will
2398 automatically recreate the MODULE-sections.txt file each time.
2399 (This only works for projects with very neat header files.) #310494.
2401 2006-10-15 Damon Chaplin <damon@gnome.org>
2403 Bug #338517: Automatically creating/updating .types file:
2405 * gtkdoc-scan.in: added a '--rebuild-types' option which will
2406 automatically update the .types file using all _get_type() functions
2407 found in the headers. (It will also do this if no .types file is found,
2408 i.e. when gtk-doc is first run on a project.)
2410 * gtk-doc.make (scan-build.stamp): run gtkdoc-scan before
2411 gtkdoc-scangobj so we can use the generated .types file.
2413 * gtkdoc-scangobj.in: if the .types file doesn't have any #include
2414 directives, just output "extern GType *get_type();" declarations for
2415 each *_get_type() function.
2417 2006-10-14 Damon Chaplin <damon@gnome.org>
2419 * gtkdoc-mkdb.in (ExpandAbbreviationsExceptCDATA): new function used
2420 to expand abbreviations in extra files, but leaving CDATA sections
2421 as they are. (#360579)
2423 2006-10-14 Damon Chaplin <damon@gnome.org>
2425 * gtkdoc-mkdb.in (OutputSGML): Allow the section id to be set from
2426 within the source code "SECTION:" comment block. (#349855)
2428 2006-10-13 Damon Chaplin <damon@gnome.org>
2430 * style.css: added missing comma from previous fix (#360967).
2432 2006-10-13 Damon Chaplin <damon@gnome.org>
2434 * gtkdoc-mkdb.in (OutputSymbolTraits): new function to output the
2435 "Since" and "Stability Level:" paragraphs, with roles to allow
2436 XSLT styling. (#348046)
2438 2006-10-13 Damon Chaplin <damon@gnome.org>
2440 * gtkdoc-scangobj.in: support interfaces on non-GObject types.
2441 (#348058, Josh Parsons).
2443 2006-10-13 Damon Chaplin <damon@gnome.org>
2445 * gtkdoc-scangobj.in: make sure interfaces are initialized so the
2446 signals query works. (#355352)
2448 2006-10-13 Damon Chaplin <damon@gnome.org>
2450 * style.css: Make sure appendix title isn't obscured by navigation bar
2451 (#360967, Philip Kovacs).
2453 2006-09-09 Matthias Clasen <mclasen@redhat.com>
2455 * gtkdoc-scangobj.in (get_type_name): Don't set is_pointer
2456 to TRUE for enum and flags types. (#354880, Yevgen Muntyan)
2460 2006-07-29 Damon Chaplin <damon@gnome.org>
2464 2006-06-30 Damon Chaplin <damon@gnome.org>
2466 * gtkdoc-mkdb.in (ScanSourceFile): fix regexp to allow section names
2469 * gtk-doc.make (all-local, docs): added separate 'docs' target that can
2470 be used even when the '--disable-gtk-doc' configure option is used.
2472 2006-06-15 Jody Goldberg <jody@gnome.org>
2474 * gtkdoc-mkdb.in (OutputFunction) : finish off #341872
2475 Support 'T const * const *foo' and other more complex types.
2476 Support ptr2ptr2func as a func argument.
2477 'void foo (void (**func) (void))'
2478 * gtkdoc-mktmpl.in : ditto.
2480 (committed by Damon with minor changes to spacing so GTK+ docs are
2483 2006-06-09 Damon Chaplin <damon@gnome.org>
2486 * gtk-doc.xsl: use the 'role' attribute rather than the 'id' attribute
2487 to identify the different sections for the navigation bar, since 'id'
2488 must be unique throughout the entire document. Also fixed a few minor
2489 issues with the output. (#342861, Leonardo Boshell)
2491 2006-05-30 Damon Chaplin <damon@gnome.org>
2493 * gtkdoc-fixxref.in (FixHTMLFile): Use the 's' modifier to the
2494 substitution so we handle links spanning more than one line.
2497 2006-05-22 Damon Chaplin <damon@gnome.org>
2502 * help/manual/Makefile.am: use a separate Makefile.am for each
2503 subdirectory rather than using "SUBDIRS=help/manual/C".
2505 2006-05-21 Jody Goldberg <jody@gnome.org>
2507 * gtkdoc-common.pl.in (ParseStructDeclaration) : Support
2508 'long double foo' and
2509 'T const * const *foo' (#341872)
2510 * gtkdoc-mktmpl.in (OutputDeclaration) : handle ptrs to ptrs to
2511 functions 'void func (void (**ptr2ptr2func)(int a))'
2513 2006-05-21 Damon Chaplin <damon@gnome.org>
2515 * gtkdoc-mkdb.in (ScanSourceFile): don't check basename for '.[hc]'
2516 suffix since we allow other suffixes as well now. (#340199)
2518 * gtkdoc-mktmpl.in (OutputSignalTemplates): check if the parameter
2519 is actually in the source code comment block. If not, use the default
2520 name. Otherwise we were outputting an empty "@:" in the templates.
2521 (ReadTemplateFile): remove empty "@:" lines caused by above bug.
2523 2006-04-15 Damon Chaplin <damon@gnome.org>
2525 * xmldocs.make: use gtkdochelpdir rather than docdir to avoid clash
2526 with autoconf. (#316508)
2528 * tools/gtk-doc.el: Output "Returns:" rather than "Return value:",
2529 and a "C-x4s" binding for inserting a blank section header.
2531 * gtk-doc.make (sgml-build.stamp): added $(DOC_MODULE)-sections.txt
2532 to the dependencies, since although the templates depend on it, they
2533 may not be changed, but the XML should still be rebuilt.
2535 * gtkdoc-mkdb.in (ScanSourceFile): allow whitespace after "SECTION:".
2537 2006-04-13 Damon Chaplin <damon@gnome.org>
2539 * gtkdoc-mkdb.in (ReadArgsFile): When outputting a warning about a
2540 property, use a single colon ':', since that is what is used to
2541 document properties in the source code. (2 colons are used for signals)
2543 * gtk-doc.make (sgml-build.stamp): added $(HFILE_GLOB) here, to
2544 catch any new documentation in the headers.
2546 2006-04-12 Damon Chaplin <damon@gnome.org>
2548 * gtkdoc-mkdb.in (tagify2): strip special "-struct" suffix from
2549 text of links to widget structs.
2551 2006-04-09 Stefan Kost <ensonic@users.sf.net>
2554 fix link after live.gnome.org wiki changes
2558 2006-04-09 Damon Chaplin <damon@gnome.org>
2562 2006-03-29 Stefan Kost <ensonic@users.sf.net>
2564 * gtkdoc-scangobj.in:
2565 missing '*' for arg in signal prototype in docs (#335486)
2567 2006-03-26 Damon Chaplin <damon@gnome.org>
2569 * gtkdoc-mkdb.in (MergeSourceDocumentation): don't output warnings
2570 for overridden titles, since that happens a lot. (#320010)
2572 * configure.in: check for pkg-config >= 0.19.
2574 * Makefile.am (pkgconfigdir): put the .pc file in $(datadir) rather
2575 than $(libdir), since gtk-doc is architecture-independant. (#120950)
2577 * configure.in: removed the hard dependancy on openjade or jade, since
2578 XML is used mostly now rather than SGML. We just output a warning
2579 rather than an error if neither openjade or jade are found.
2581 2006-03-21 Stefan Kost <ensonic@users.sf.net>
2584 add sect1 to pages with top-page offset adjustment (#166363)
2586 2006-03-19 Damon Chaplin <damon@gnome.org>
2588 * gtkdoc-scan.in (ScanHeader): try to handle the start of function
2589 declarations spread over 3 lines. (#321708, Jorn Baayen)
2591 2006-03-19 Damon Chaplin <damon@gnome.org>
2593 (OutputOldParams): don't bother outputting unused parameters if they
2594 don't have any documentation as that is pointless.
2596 2006-03-19 Damon Chaplin <damon@gnome.org>
2598 * gtkdoc-mktmpl.in (ReadTemplateFile): Add a workaround for an old
2599 bug handling macros with arguments spread over several lines. (#318666)
2601 2006-03-19 Damon Chaplin <damon@gnome.org>
2603 * gtkdoc-mkdb.in (MakeIndexterms): Make sure we still output an index
2604 term if there isn't 'deprecated' or 'since' info.
2605 (#334851, Tommi Komulainen).
2607 2006-03-19 Damon Chaplin <damon@gnome.org>
2609 * gtkdoc-scan.in (ScanHeader): added "--ignore-decorators" option to
2610 ignore a list of declarators in function declarations.
2611 (#316512, Bertram Felgenhauer).
2613 2006-03-19 Damon Chaplin <damon@gnome.org>
2615 * gtkdoc-mkdb.in (GetSignals, GetArgs): call MakeIndexTerms() to make
2616 sure that signals appear in the deprecated/new symbol indices.
2617 (#332007, Tommi Komulainen).
2619 2006-03-19 Damon Chaplin <damon@gnome.org>
2621 * gtkdoc-mkdb.in (OutputEnum, ExpandAbbreviations, symbolify):
2622 allow use of '#Object::signal' and '#Object:property' to link to
2623 signals and properties, and add links to enum constant values.
2624 (#332483, Stefan Kost)
2626 2006-03-15 Matthias Clasen <mclasen@redhat.com>
2628 * gtkdoc-mkdb.in (MakeIndexterms): Create separate indexterms
2629 for different roles, since the docbook stylesheets don't handle
2630 multiple roles in one attribute. (#331586, Tommi Komulainen)
2634 2006-03-07 Damon Chaplin <damon@gnome.org>
2638 2006-03-06 Tommi Komulainen <tommi.komulainen@nokia.com>
2640 * gtkdoc-scan.in (ScanHeader): Print object name after <TITLE> in
2641 order to get get object hierarchy, signals and properties
2642 documentation appear automatically (#333380)
2644 2006-01-24 Stefan Kost <ensonic@users.sf.net>
2646 * gtkdoc-mkdb.in: patch from Damon Chaplin to fix signal flag parsing
2648 2006-01-08 Damon Chaplin <damon@gnome.org>
2650 * gtkdoc-mkdb.in: patch from Jonathan Blandford to add support for a
2651 "--source-suffixes" option so you can scan files with any suffixes
2652 you want (e.g. C++ files).
2654 2005-12-19 Matthias Clasen <mclasen@redhat.com>
2656 * gtkdoc-mktmpl.in: Use \w+: instead of \S+: when
2657 matching parameter names, so that @Deprecated:2.10:
2658 works in template files like in source code comments.
2660 * gtkdoc-mkdb.in: Add a missing "and" to the versioned
2663 2005-12-09 Stefan Kost <ensonic@users.sf.net>
2666 try more to downgrade devhelp for old file format
2668 2005-12-09 Stefan Kost <ensonic@users.sf.net>
2673 create a autoregen.sh
2677 generate two separate versions
2679 fix parsing const after type (#322556)
2681 fix parseing multiline macro heads (#320588)
2682 * gtkdoc-scangobj.in:
2683 allow additional root types (#323581)
2685 2005-12-05 Matthias Clasen <mclasen@redhat.com>
2687 * gtkdoc-mktmpl.in (OutputDeclaration):
2688 * gtkdoc-mkdb.in (OutputFunction): Allow parameters to be declared
2689 volatile (this happens in GLib nowadays)
2691 2005-10-11 Stefan Kost <ensonic@users.sf.net>
2694 remove left-over debug-print
2696 2005-10-10 Stefan Kost <ensonic@users.sf.net>
2700 enhance gtkdoc devhelp output (#318129)
2702 2005-10-05 Stefan Kost <ensonic@users.sf.net>
2704 * gtkdoc-common.pl.in:
2705 revert exchanging with  
2707 2005-10-04 Damon Chaplin <damon@gnome.org>
2709 * gtkdoc-scanobj.in: patch from Andrae Steiner to add missing ';'
2712 2005-09-29 Stefan Kost <ensonic@users.sf.net>
2715 additionally point people to the gnome-wiki
2718 don't warn on macros with return docs (#314267)
2720 2005-09-28 Matthias Clasen <mclasen@redhat.com>
2722 Show signal flags: (#316789)
2724 * gtkdoc-scangobj.in: Emit flags for signals
2725 as <FLAGS> element in $MODULE.signals
2727 * gtkdoc-mkdb.in: Emit signal flags similar
2730 * gtkdoc-mktmpl.in: Handle <FLAGS> here, too.
2732 2005-09-20 Stefan Kost <ensonic@users.sf.net>
2737 * doc/sections-file.txt:
2738 * doc/setting-up.txt:
2739 * doc/style-guide.txt:
2740 * gtkdoc-common.pl.in:
2741 adding a note about where the new docs are
2743 2005-09-15 Damon Chaplin <damon@gnome.org>
2745 * gtkdoc-scan.in (ScanHeader):
2746 * gtkdoc-mktmpl.in (OutputDeclaration):
2747 * gtkdoc-mkdb.in (OutputFunction): patch from dodji seketeli to handle
2748 functions returning explicit enums. (#303337)
2750 Patch from Stepan Kasal:
2752 * gtkdoc-mkhtml.in, gtkdoc-mkman.in, gtkdocize.in: Add datarootdir
2753 variable, for compatibility with future Autoconf releases.
2755 * configure.in (PACKAGE_DATA_DIR): Simplify the computation;
2756 use a local macro AC_DEFINE_DIR, based on a macro from Autoconf
2757 macro archive. (#313876)
2759 2005-09-15 Damon Chaplin <damon@gnome.org>
2761 * gtkdoc-scangobj.in: Patch from Stepan Kasal to avoid some gcc
2764 * gtkdoc-scanobj.in:
2765 * gtkdoc-scangobj.in: Use brackets around open() arguments to avoid
2766 precedence problems. (#314838)
2768 * gtkdoc-scanobj.in:
2769 * gtkdoc-scangobj.in: Output more messages about compilation, linking
2770 and running of scanner, to try to help track down any problems.
2771 Also use "sh -c" to run the scanner (#167688)
2773 * gtkdoc-scanobj.in:
2774 * gtkdoc-scangobj.in: patch from Stefan Kost to improve error messages,
2775 though I changed it slightly so it doesn't output errno.
2777 2005-09-09 Damon Chaplin <damon@gnome.org>
2781 * gtk-doc.xsl: Use a fixed navigation bar at the top of the page.
2782 Patch from Stefan Kost with minor changes by me. (#313569)
2784 2005-08-18 Damon Chaplin <damon@gnome.org>
2786 * gtkdoc-scangobj.in: added "const" in a few places to avoid lots
2787 of warnings if all gcc warnings are on. (#312985)
2789 2005-08-15 Stefan Kost <ensonic@users.sf.net>
2796 adding the infrastructure for installation of gtkdoc manual
2798 2005-08-12 Stefan Kost <ensonic@users.sf.net>
2801 fix warning about uninitialized var EXPAND_CONTENT_FILES
2803 Tue Aug 9 12:01:27 2005 tjlocal <timj@imendio.com>
2805 * autogen.sh: bail out with exit $? for failing programs.
2807 2005-07-26 Damon Chaplin <damon@gnome.org>
2809 * gtk-doc.make: Pass DOC_MAIN_SGML_FILE as the main filename to
2810 gtkdoc-mkdb. Avoids creating spurious foo.sgml files in an XML build.
2811 Patch from Malcolm Tredinnick. (#311344)
2813 Prefix build messages with "gtk-doc: " rather than surrounding them
2814 with "***" which looks like an error. (#170008)
2816 2005-07-26 Damon Chaplin <damon@gnome.org>
2818 * README: removed comment about not being able to add section
2819 documentation to source code files, which is not true any more.
2823 2005-07-03 Damon Chaplin <damon@gnome.org>
2827 2005-06-20 Matthias Clasen <mclasen@redhat.com>
2829 * gtkdoc-mkdb.in: Fix typos in warnings.
2831 2005-06-17 Mikael Hallendal <micke@imendio.com>
2833 * README: Updated Devhelp web address.
2835 2005-05-16 Matthias Clasen <mclasen@redhat.com>
2837 * gtkdoc-mkdb.in: Add "expand-content-files:s" to the GetOptions() call.
2839 2005-05-10 Owen Taylor <otaylor@redhat.com>
2841 * gtkdoc-mkdb.in: Add an --expand-content-files option
2842 to specify extra files to expand abbreviations in and
2843 copy into the output directory.
2845 * gtk-doc.make examples/Makefile.am: Add expand_content_files
2848 * gtkdoc-mktmpl.in (OutputTemplateFile): Add an
2849 --only-section-tmpl flag so that projects that keep everything
2850 but section descriptions inline can avoid cvs conflicts.
2852 * gtk-doc.make examples/Makefile.am: Add support for
2855 * configure.in: Up version to 1.4.
2857 2005-05-02 Matthias Clasen <mclasen@redhat.com>
2859 * gtkdoc-mkdb.in: Accept C comments between struct name
2860 and struct definition. GObject has an instance of this.
2862 2005-03-21 Matthias Clasen <mclasen@redhat.com>
2864 * gtk-doc.dcl: Allow ':' in names. (#169087)
2866 2005-03-21 James Henstridge <james@jamesh.id.au>
2868 * gtk-doc.xsl (encoding): output US-ASCII instead of ISO-8859-1.
2869 This ensures that the output will be display correctly when served
2870 as either ISO-8859-1 or UTF-8.
2872 2005-02-26 Sven Neumann <sven@gimp.org>
2874 * gtkdoc-mkdb.in (MakeIndexterms): allow space in Since: keywords,
2875 only strip leading and trailing whitespace (bug #168384).
2877 2005-02-16 Damon Chaplin <damon@gnome.org>
2879 * gtkdoc-mkdb.in (ScanSourceFile): add support for "@stability:"
2880 in the inline section docs (Brian Cameron).
2882 2005-02-07 Damon Chaplin <damon@gnome.org>
2884 * gtkdoc-mkdb.in (MergeSourceDocumentation): allow use of "@...:" in
2885 the source code as well as "@Varargs:". Patch from Benjamin Otte.
2888 2005-02-04 Damon Chaplin <damon@gnome.org>
2890 * gtkdoc-mkdb.in (ParseStabilityLevel): don't reset $stability if it
2891 isn't Stable/Unstable/Private (Brian Cameron).
2892 (ScanSourceFile): skip whitespace after "SECTION:".
2894 2005-02-01 Damon Chaplin <damon@gnome.org>
2896 * gtkdoc-mkdb.in (ScanSourceFile, MergeSourceDocumentation): patch
2897 from Stefan Kost to support section documentation within the source
2898 code (long description, short description, see also and title).
2901 * gtkdoc-mktmpl.in: patch from Brian Cameron to support stability
2904 * gtkdoc-mkdb.in (OutputFunction):
2905 * gtkdoc-mktmpl.in (OutputDeclaration):
2906 * gtkdoc-common.pl.in (ParseStructDeclaration): patch from Roger Leigh
2907 to add support for the "restrict" keyword.
2909 * gtkdoc-scan.in (ScanHeader): patch from Roger Leigh to add support
2910 for "unsigned" to one of the regexps.
2912 2005-01-31 Damon Chaplin <damon@gnome.org>
2914 * gtk-doc.make (scan-build.stamp): added "2>&1" to grep command to
2917 * gtkdoc-mkdb.in: patch from Stefan Kost to not add '<' '>' around
2918 include files that already have '"' '"' around them, and to try to
2919 gather more information about undocumented symbols. #164462.
2921 2005-01-28 Damon Chaplin <damon@gnome.org>
2923 * gtk-doc.make: use dist-hook rather than EXTRA_DIST to copy the
2924 $(DOC_MODULE).types file over, so we can skip this if it doesn't exist.
2927 2005-01-12 Damon Chaplin <damon@gnome.org>
2929 * README: patch from Stefan Kost to mention GObject classes
2930 and describe the transformation process to XML/SGML and HTML,
2931 and to mention Devhelp.
2935 2005-01-09 Damon Chaplin <damon@gnome.org>
2939 2005-01-09 Damon Chaplin <damon@gnome.org>
2941 * gtkdoc-mkdb.in (MergeSourceDocumentation): output better warnings
2942 using the type information. Patch from Stefan Kost. #161979
2944 * gtkdoc-scan.in (ScanHeader): support "typedef struct a *b;". Fixes
2945 last part of #156318.
2947 * gtkdoc-common.pl.in (ParseStructDeclaration): return an empty array
2948 for forward struct declarations. Part of #156318.
2951 * gtkdoc-mkdb.in: updated a few of the warnings to make them a bit
2952 easier to understand.
2954 2004-11-22 James Henstridge <james@jamesh.id.au>
2956 * acconfig.h: remove file, since we don't have a config.h
2958 * configure.in: make sure $ACLOCAL_FLAGS is passed to aclocal on a
2961 * autogen.sh: use Automake-1.9 if available, and call aclocal,
2962 autoconf, automake, etc in the same order as autoreconf does.
2964 * gtkdocize.in: if the AC_CONFIG_MACRO_DIR option is used in the
2965 configure script, copy gtk-doc.m4 to that directory in the source
2968 2004-11-16 Damon Chaplin <damon@gnome.org>
2970 * gtkdoc-mkdb.in (OutputFunction): output "const" rather than
2971 "G_CONST_RETURN". #157674.
2973 * gtkdoc-mktmpl.in (OutputDeclaration): skip "void" return types but
2974 not if it has modifiers e.g. "void *". #156963.
2976 * gtkdoc-scan.in (ScanHeader): handle __attribute__. Patch from
2977 Simon Josefsson. #156962.
2979 2004-10-31 Damon Chaplin <damon@gnome.org>
2981 * gtkdoc-mkdb.in (OutputStruct): handle opaque/forward struct
2982 declarations. #156318 again. Tiny fix to avoid warnings.
2984 2004-10-28 Damon Chaplin <damon@gnome.org>
2986 * gtkdoc-mktmpl.in (ReadDeclarationsFile):
2987 * gtkdoc-mkdb.in (ReadDeclarationsFile):
2988 * gtkdoc-scan.in (ScanHeader): handle opaque/forward struct
2989 declarations. #156318.
2991 2004-10-25 Damon Chaplin <damon@gnome.org>
2993 * gtkdoc-mkdb.in (OutputParamDescriptions): use a after Returns:
2994 so it doesn't break before the colon.
2996 2004-10-24 Damon Chaplin <damon@gnome.org>
2998 * gtkdoc-common.pl (ParseEnumDeclaration): handle "typedef enum XXX {"
2999 #156297. Patch from Simon Josefsson.
3001 2004-10-20 Damon Chaplin <damon@gnome.org>
3003 * gtkdoc-mkdb.in (ReadDeclarationsFile): set a flag to indicate a
3004 struct has a typedef declaration.
3005 (OutputStruct): better output for structs with typedefs. #83269.
3007 * gtkdoc-scan.in (ScanHeader): leave the struct declaration as it is.
3008 Don't strip out 'typedef'. Also allow simple "struct foo {".
3010 2004-10-19 Damon Chaplin <damon@gnome.org>
3012 * gtkdoc-fixxref.in: use pkg-config to find where GLib is installed
3013 and scan that directory for index files. Also scan $GNOME2_PATH.
3014 These are only used as a last resort. If they are used we have to
3015 output links as absolute URLs, rather than the default relative ones.
3017 2004-10-18 Damon Chaplin <damon@gnome.org>
3019 * gtkdoc-common.pl.in (ParseStructDeclaration): support function
3020 pointers that return "foo const *" #141870.
3022 * gtkdoc-scan.in (ScanHeader):
3023 * gtkdoc-mkdb.in (OutputFunction):
3024 * gtkdoc-mktmpl.in (OutputDeclaration): handle functions with const
3025 or struct return types. #141870 and #148507.
3027 2004-10-15 Damon Chaplin <damon@gnome.org>
3029 * gtkdoc-common.pl.in (ParseStructDeclaration)
3030 (ParseEnumDeclaration): moved these here, rather than have 2 copies
3031 in gtkdoc-mkdb.in and gtkdoc-mktmpl.in.
3033 * gtkdoc-common.pl.in (ParseStructDeclaration): handle struct fields
3034 better. We can now handle things like *foo, ***bar, *baz[12][23],
3035 foo : 25 all on one line. Fixes part of #151219.
3036 Also support the 'short' modifier to fix #90565.
3037 And use $nbsp; rather than spaces to try to avoid splitting
3038 declarations in the output.
3039 Also take an extra arg specifying whether to include parameters in
3040 the function pointer fields.
3042 * gtkdoc-scan.in (ScanHeader): Deal with array types in typedefs.
3043 (Eg, "typedef unsigned char MD5Digest[16];") From Dan Winship.
3044 Last bit of #151219.
3046 2004-10-14 Damon Chaplin <damon@gnome.org>
3048 * gtkdoc-mkdb.in (CreateValidSGMLID): use ":CAPS" rather than
3049 "-CAPS" to distinguish all-caps identifiers, to avoid clashing with
3050 identifiers ending in _caps! Bug #113120.
3052 * gtkdoc-mkdb.in (MergeSourceDocumentation): if it looks like a
3053 parameter has been described, but not in the right place, output
3054 a better error message. Bug #141871.
3056 * gtkdoc-mkdb.in (OutputMacro, OutputFunction, GetSignals): allow
3057 the author to use <!--PARAMETERS--> to specify the position of the
3058 parameter table if they want. Hopefully good enough for bug #99567.
3059 (MergeSourceDocumentation): end the paragraph before <!--PARAMETERS-->
3060 and start a new one after it.
3062 * doc/authors.txt: document <!--PARAMETERS-->.
3064 * style.css: don't underline links normally, as we output lots of
3065 them and it makes it very cluttered. Only underline links when the
3066 mouse hovers over them, and change the color. Fixes #108037.
3068 * gtk-doc.make (scan-build.stamp): depend on $(CFILE_GLOB) as well,
3069 since changes in properties need to be picked up by gtkdoc-scangobj.
3072 * gtkdoc-mkdb.in: (ParseStructDeclaration): for fields that are
3073 function pointers, only return the function name, as otherwise the
3074 output gets really messy. Fixes #66618.
3079 * gtkdoc-scanobj.in:
3080 * gtkdoc-scangobj.in: use '@PACKAGE_DATA_DIR@' instead of
3081 "@PACKAGE_DATA_DIR@" so that it isn't interpolated. It failed when
3082 $prefix was /software/@sys/usr. Fixes #113456.
3084 2004-10-13 Damon Chaplin <damon@gnome.org>
3086 * gtkdoc-scanobj.in:
3087 * gtkdoc-scangobj.in: patch from Olexiy Avramchenko to add 3 new
3090 * gtkdoc-scanobj.in:
3091 * gtkdoc-scangobj.in: patch from Benjamin Otte to get rid of
3092 -Wsign-compare warnings. Bug #137013.
3094 Fri Sep 17 01:13:24 2004 Matthias Clasen <maclas@gmx.de>
3096 * gtk-doc.xsl: Add the images from the gallery on top
3097 of the refentry they point to.
3099 * style.css: Move the css bits of the gallery implementation
3102 Fri Sep 17 00:30:16 2004 Matthias Clasen <maclas@gmx.de>
3104 * gtk-doc.xsl: Don't generate <link rel="refentry">
3105 links, since e.g. the GTK+ docs contain MANY refentries.
3107 2004-09-10 Damon Chaplin <damon@gnome.org>
3109 * autogen.sh: support automake 1.8. (part of #151219).
3111 * examples/Makefile.am: require automake 1.6.
3113 * gtkdoc-scan.in: create an empty MODULE-overrides.txt file if it
3114 doesn't exist. gtkdoc.make expects one to exist.
3116 * doc/setting-up.txt: updated to document new procedure using
3119 * examples/Makefile.am: updated to use gtkdoc.make.
3121 * examples/configure.in: removed this. gtkdoc.make is used instead
3124 * examples/README: updated.
3126 * Makefile.am (EXTRA_DIST): removed examples/configure.in.
3128 Wed Sep 8 01:12:25 2004 Matthias Clasen <maclas@gmx.de>
3130 * gtkdoc-scan.in (ScanHeader):
3131 * gtkdoc-mktmpl.in (OutputDeclaration):
3132 * gtkdoc-mkdb.in (OutputFunction): Accept mixtures of *
3133 and const in return types.
3135 Wed Sep 01 05:58:08 2004 Matthias Clasen <maclas@gmx.de>
3137 * gtkdoc-mkdb.in: Remove a debug printf
3139 Tue Aug 24 02:30:08 2004 Matthias Clasen <maclas@gmx.de>
3141 * gtk-doc.xsl: Add support for a gallery of widget images.
3143 Wed Jul 28 13:00:54 2004 Jonathan Blandford <jrb@gnome.org>
3145 * gtk-doc.xsl: remove the examples from the toc.
3147 2004-07-28 Damon Chaplin <damon@gnome.org>
3149 * doc/sections-file.txt: mention use of '#' for comments.
3151 * gtkdoc-mkdb.in: removed HEADER_FILE stuff, since it isn't used now.
3153 2004-07-23 Damon Chaplin <damon@gnome.org>
3155 * examples/Makefile.am (all-local): add empty all-local target for
3156 when ENABLE_GTK_DOC is false. (#148209, Martin Quinson)
3158 Fri Jul 23 13:21:34 2004 Matthias Clasen <maclas@gmx.de>
3160 * gtkdoc-mkdb.in (ScanSourceFile): Fix regexps for matching
3161 ignored files. (#148211, Martin Quinson)
3163 2004-07-03 Matthias Clasen <mclasen@redhat.com>
3165 * style.css: Add a missing '}' and align arguments to the
3166 top of their descriptions. (#145363, #145364, Mariano
3169 2004-05-18 Matthias Clasen <mclasen@redhat.com>
3171 * gtk-doc.xsl: Let the docbook stylesheets generate
3172 extra <link rel=...> elements. (#140221, Geert Stappers)
3174 2004-05-10 Geert Stappers <stappers@stappers.nl>
3176 * TODO: new file, basicly a reference to bugzilla.
3178 * examples/README: tell about gtk-doc.make.
3180 2004-05-06 Geert Stappers <stappers@stappers.nl>
3182 * MAINTAINERS: Add myself.
3184 2004-05-05 Matthias Clasen <mclasen@redhat.com>
3186 * gtk-doc.xsl: Correct the docbook stylesheet version
3187 in which filtered index support will appear to 1.66.
3189 2004-04-27 Geert Stappers <stappers@stappers.nl>
3191 * README: Updated the information on Debian packages.
3192 Removed old author and time stamp line.
3194 2004-04-21 Matthias Clasen <mclasen@redhat.com>
3196 * doc/sections-file.txt: Add hint about private types.
3200 * MAINTAINERS: Add myself.
3202 * gtkdoc-mkdb.in (ReadKnownSymbols): New function which
3203 extracts information about public and private symbols from
3204 the $MODULE-sections.txt file.
3205 (ReadObjectHierarchy): Prune the tree, based on the information
3206 collected by ReadKnownSymbols.
3207 (ReadInterfaces): Also filter out private interfaces here
3208 (ReadPrerequisites): ...and here.
3210 2004-04-19 Matthias Clasen <mclasen@redhat.com>
3212 * Makefile.am: Add version-greater-or-equal.xsl.
3214 * version-greater-or-equal.xsl: New file, implementing
3215 the version-greater-or-equal template for comparing version
3218 * gtk-doc.xsl: Import version-greater-or-equal.xsl and
3219 use the version-greater-or-equal template to a) check that
3220 the xsl stylesheets are not too old and b) to avoid creating
3221 multiple indices if the xsl stylesheets don't support filtered
3224 * gtkdoc-mkdb.in (MakeIndexterms): Emit role attributes
3225 on indexterms which can be used to create filtered indices
3226 with sufficiently new xsl stylesheets. The required functionality
3227 will appear in version 1.62 of the xsl stylesheets. (#115530)
3229 2004-04-16 Matthias Clasen <mclasen@redhat.com>
3231 * style.css: Style information in a separate stylesheet.
3233 * gtkdoc-mkhtml.in: Copy css files.
3235 * Makefile.am (gtkdocdata_DATA): Add style.css
3237 * gtk-doc.xsl: Use a stylesheet instead of hardwiring
3238 styles. (#134683, Vincent Torri)
3240 * gtkdoc-mkdb.in (GetSignals): Organize the properties
3241 descriptions to fit better with the other sections, and
3242 also display information about allowed and default values.
3244 2004-04-15 Matthias Clasen <mclasen@redhat.com>
3246 * gtkdoc-scangobj.in: Use introspection more fully to emit
3247 allowed ranges for integral types and default values.
3249 * gtkdoc-mkdb.in (GetSignals): Handle missing signal parameter
3252 2004-03-04 Damon Chaplin <damon@gnome.org>
3254 * autogen.sh: fixed URLs to download autoconf/automake/libtool.
3255 Patch from Frederic L. W. Meunier.
3257 2004-02-16 Damon Chaplin <damon@gnome.org>
3259 * .cvsignore: added gtk-doc.cat and gtkdocize.
3263 2004-02-16 Damon Chaplin <damon@gnome.org>
3267 2004-02-16 Damon Chaplin <damon@gnome.org>
3269 * gtk-doc.cat.in: removed public ID for gtk-doc.dtd, since we don't
3272 Sat Feb 14 02:14:27 2004 Matthias Clasen <maclas@gmx.de>
3274 * gtk-doc.m4: Avoid unnecessary checks if gtk-doc is
3275 disabled. (#134221, Julio M. Merino Vidal)
3277 Sat Feb 14 02:03:01 2004 Matthias Clasen <maclas@gmx.de>
3279 * gtk-doc.make: Don't create unneeded empty
3280 directories. (#134319, Julio M. Merino Vidal)
3282 Sat Feb 14 01:37:38 2004 Matthias Clasen <maclas@gmx.de>
3284 * gtk-doc.make: Add an empty all-local target to make it work
3285 with non-GNU make. (#134343, Julio M. Merino Vidal)
3287 Wed Jan 28 00:52:00 2004 Matthias Clasen <maclas@gmx.de>
3289 * gtkdoc-mkdb.in (OutputObjectList): Avoid emitting invalid
3290 docbook markup if there are no objects. Partial fix for #132661.
3292 Sun Jan 25 22:01:15 2004 Matthias Clasen <maclas@gmx.de>
3294 * gtkdoc-mkdb.in: Accept both the old and the new XInclude
3295 namespace. (#131675, Edd Dumbill)
3297 2004-01-23 Thomas Vander Stichele <thomas at apestaart dot org>
3299 * gtkdoc-mkhtml.in: exit when tools return non-zero so errors can
3302 Thu Jan 15 23:06:10 2004 Matthias Clasen <maclas@gmx.de>
3304 * gtk-doc.xsl: Set the chunk.fast parameter, to gain some
3307 Thu Jan 15 23:05:23 2004 Matthias Clasen <maclas@gmx.de>
3309 * gtkdoc-fixxref.in: Make it work again without explicit
3312 Sat Dec 27 01:36:08 2003 Matthias Clasen <maclas@gmx.de>
3314 * gtkdoc-scangobj.in:
3317 * gtkdoc-fixxref.in: Add --help. (#126915)
3319 Sat Dec 27 00:43:42 2003 Matthias Clasen <maclas@gmx.de>
3321 * gtkdoc-mkdb.in (ParseEnumDeclaration):
3322 * gtkdoc-mktmpl.in (ParseEnumDeclaration): Support a trailing ,
3323 in enum declarations. These are a GNU C extension, but also
3324 blessed by C99. (#129949, Thomas Vander Stichele)
3326 Sun Nov 16 00:29:03 2003 Matthias Clasen <maclas@gmx.de>
3328 * gtkdoc-scangobj.in: Don't use g_strdown(). (#127028,
3331 Sun Nov 16 00:26:05 2003 Matthias Clasen <maclas@gmx.de>
3333 * gtkdoc-scangobj.in: If compiled against GLib >= 2.3.0, look
3334 for properties on interfaces. (#127068, James M. Cape)
3336 2003-11-03 Dan Winship <danw@ximian.com>
3338 * gtkdoc-scangobj.in: Clean up $MODULE-scan.o even when using
3341 * gtkdoc-scanobj.in: Likewise
3343 * gtk-doc.make (CLEANFILES): Remove $(MODULE)-scan.o from here
3344 (clean-local): rm -rf .libs
3346 Wed Oct 8 01:21:54 2003 Matthias Clasen <maclas@gmx.de>
3348 * gtkdoc-scan.in (ScanHeader): Make gtkdoc-scan grok
3349 typedef struct { } foo; in addition to the more baroque
3350 typedef struct _foo foo; struct _foo { };
3351 (#116807, Malcolm Tredinnick)
3353 Wed Oct 8 01:21:35 2003 Matthias Clasen <maclas@gmx.de>
3355 * gtkdoc-mkdb.in (OutputParamDescriptions): Remove a pointless
3358 2003-10-01 Matthias Clasen <maclas@gmx.de>
3360 Make signals and properties end up in the right template
3361 file (#116569, Owen Taylor):
3363 * gtkdoc-mktmpl.in (OutputSignalTemplates):
3364 (OutputArgTemplates): Return a string rather than directly
3366 (OutputTemplateFile): Don't interpret $title as the name of
3367 the object to print signal and property templates for.
3368 (UpdateTemplates): Collect signal and property templates for all
3369 objects contained in the section.
3371 2003-08-10 James Henstridge <james@daa.com.au>
3373 * acinclude.m4 (JH_PATH_XML_CATALOG): allow caller to specify
3374 actions if found or not found.
3375 (JH_CHECK_XML_CATALOG): when requiring JH_PATH_XML_CATALOG, don't
3376 error out if it is not found.
3378 2003-08-03 Matthias Clasen <maclas@gmx.de>
3380 * doc/gnome.txt: Add some hints regarding markup of examples.
3382 2003-07-22 Matthias Clasen <maclas@gmx.de>
3385 * gtk-doc.cat: Fix a problem with the previous commit.
3387 2003-07-21 Matthias Clasen <maclas@gmx.de>
3389 Applied patches from Sebastian Rittau to add maintainer mode and an SGML catalog. (#117955, #117956)
3391 * gtk-doc.cat.in: New catalog file.
3392 * configure.in: Added gtk-doc.catalog to output files.
3393 * Makefile.am: Install gtk-doc.catalog.
3395 * configure.in: Added AM_MAINTAINER_MODE.
3396 * autogen.sh: Added --enable-maintainer-mode to configure options.
3398 2003-07-09 Matthias Clasen <maclas@gmx.de>
3400 * gtkdoc-mktmpl.in (ParseStructDeclaration):
3401 * gtkdoc-mkdb.in (ParseStructDeclaration): Accept volatile struct members, which have just
3402 made their appearance in glib.
3404 2003-06-29 Matthias Clasen <maclas@gmx.de>
3406 * gtkdoc-mkdb.in (ExpandAbbreviations): When expanding @param, catch the common @param->field
3407 and @param.field, to reduce the need for littering the C sources with <literal>foo->bar</literal>.
3409 2003-06-25 Matthias Clasen <maclas@gmx.de>
3411 Changes for #115528:
3413 * gtkdoc-mkdb.in (OutputSGML): Collect hierarchy, interfaces, implementations, prerequisites
3414 and derived interfaces separately.
3415 (OutputSGMLFile): Take two more arguments: implementations and derived interfaces.
3416 (GetHierarchy): Also put immediate children in the local tree.
3417 (GetInterfaces): Split into GetInterfaces and GetImplementations.
3418 (GetImplementations): New function to get the implementations of an interface.
3419 (GetDerived): New function to get the known derived interfaces of an interface.
3421 * gtkdoc-mkdb.in (MakeXRef): Accept a second, optional parameter for the
3423 (ExpandAbbreviations): Add semantic markup inside the links, so that
3424 non-crossreferenced symbols come out properly formatted after link
3427 2003-06-15 Matthias Clasen <maclas@gmx.de>
3429 Support for a flat index of all symbols. (#92861)
3430 To use, put an empty <index/> element in your driver document.
3432 * gtkdoc-mkdb.in (MakeIndexterms): New function, emits an indexterm.
3433 (OutputMacro, OutputTypedef, OutputStruct, OutputEnum,
3434 OutputUnion, OutputVariable, OutputFunction): Use MakeIndexterms.
3435 to emit indexterms for symbols.
3437 * gtkdoc-mkdb.in (GetSignals):
3438 (GetArgs): Emit Since: information for signals and properties.
3440 Thu Jun 12 15:55:57 2003 Owen Taylor <otaylor@redhat.com>
3442 * gtkdoc-mkhtml.in (declaration): Replace head -1 with -n 1.
3443 (Merge change by Elliot Lee from Red Hat package)
3445 2003-06-11 Matthias Clasen <maclas@gmx.de>
3447 * doc/gnome.txt: Updates to the documentation of inline comments.
3449 2003-06-03 Matthias Clasen <maclas@gmx.de>
3451 * gtk-doc.spec.in: Add a missing Provides: and include the .pc file.
3452 (#106568, Joe Pranevich)
3454 2003-05-27 Matthias Clasen <maclas@gmx.de>
3456 * gtkdoc-mkdb.in (GetSignals):
3457 (GetArgs): Add signals and properties to the statistics.
3458 (OutputMissingDocumentation): Emit undocumented signals and
3459 properties. (#113645)
3461 2003-04-21 Matthias Clasen <maclas@gmx.de>
3463 * tools/docpercentages.pl: Fix autolinkification for undocumented
3466 * doc/style-guide.txt: Typo fix.
3470 2003-04-18 James Henstridge <james@daa.com.au>
3474 2003-04-18 James Henstridge <james@daa.com.au>
3476 * NEWS: add news items.
3478 * configure.in: increment version number.
3480 2003-03-14 Matthias Clasen <maclas@gmx.de>
3482 * gtkdoc-mkdb.in (OutputBook): Fix the public identifier for
3483 DocBook V3.0: Davenport, not DavenPort.
3484 (#108343, Mariano Suarez-Alvarez)
3486 2003-03-10 James Henstridge <james@daa.com.au>
3488 * configure.in: associate the chmod commands with the files they
3489 are chmod'ing. This way config.status will always run the correct
3492 2003-03-04 James Henstridge <james@daa.com.au>
3494 * configure.in: look up the docbook DTD by public id rather than
3497 2003-02-26 Matthias Clasen <maclas@gmx.de>
3499 * gtkdoc-mkdb.in (GetArgs): Prefer template or comment docs over
3500 blurbs only if they're nonempty, otherwise the empty docs from the
3501 templates override all the blurbs.
3503 2003-02-26 James Henstridge <james@daa.com.au>
3505 * autogen.sh (THEDIR): set up so that it will choose automake 1.7
3506 or 1.6 in preference to 1.4. Passes distcheck okay.
3508 * configure.in: update configure.in script to match
3509 recommendations of newer autoconf's, and add an AC_PREREQ()
3510 statement, since the xml catalog checks are using new autoconf
3513 * gtk-doc.make (xml-build.stamp): since other bits of the makefile
3514 were assuming xml, may as well hard code --output-format=xml.
3516 2003-02-19 James Henstridge <james@daa.com.au>
3518 * Makefile.am: get rid of the dist-hook, and just include the
3519 given files in EXTRA_DIST instead.
3521 * configure.in: provide meaningful names for the commands.
3523 * acinclude.m4 (JH_CHECK_XML_CATALOG): add some extra arguments: a
3524 friendly name for the catalog entry, and actions to run if the
3525 entry was found or not. Also include a bit more information in
3526 the config.log file if an error occurs.
3528 2003-02-18 Matthias Clasen <maclas@gmx.de>
3530 * gtkdoc-mkhtml.in (declaration): Avoid the unportable grep
3531 option -q. (#105311)
3533 2003-02-19 James Henstridge <james@daa.com.au>
3535 * devhelp.xsl: put chapters that aren't at the top level into the
3536 toc tree (to make gtk's .devhelp tree look better).
3538 * gtk-doc.spec.in (Requires): make the requires lines match
3539 current requirements ...
3541 * gtkdoc-mkhtml.in (XSLTPROC): pass --nonet to xsltproc, so we
3542 don't try to download DTDs and XSLT over the net. The configure
3543 checks should catch people who don't have the correct files in
3546 2003-02-17 James Henstridge <james@daa.com.au>
3548 * gtkdocize.in (--version): add --version argument.
3550 2003-02-14 James Henstridge <james@daa.com.au>
3552 * gtkdoc-mkdb.in (GetOptions): actually accept --tmpl-dir as a
3553 command line option. Based on a patch from Simon Josefsson
3556 * gtk-doc.xsl: remove the xmlns declaration. Not really needed
3557 for html output anyway ...
3559 2003-02-13 James Henstridge <james@daa.com.au>
3561 * devhelp.xsl: remove refsect1's and refsect2's from book tree, as
3562 suggested by Hallski.
3564 * gtk-doc.make (install-data-local): the change to install images
3565 was superfluous, so I have removed it.
3566 (CLEANFILES): move some more stuff to CLEANFILES from the
3567 distclean-local rule.
3569 2003-02-12 James Henstridge <james@daa.com.au>
3571 * gtk-doc.make: add some chmod calls to work arround distcheck on
3573 (install-data-local): copy the images as well as the html files
3575 (uninstall-local): add an uninstall rule to remove the docs.
3576 (CLEANFILES): add $(DOC_MODULE)-scan.o to the list of files to be
3579 2003-02-09 James Henstridge <james@daa.com.au>
3581 * gtkdocize.in: script used to copy gtk-doc.make into another
3584 * gtk-doc.make: automake makefile fragment to handle gtk-doc
3585 support in other modules.
3587 * configure.in: check to make sure DocBook XML DTD and XSLT
3588 stylesheets are present in the XML catalog.
3590 * acinclude.m4 (JH_CHECK_XML_CATALOG): new macro to check for
3591 entries in the XML catalog.
3593 2003-02-04 James Henstridge <james@daa.com.au>
3595 * gtk-doc.m4: a macro to check for gtk-doc.
3597 * Makefile.am (gtkdocdata_DATA): don't bother installing xml.dcl.
3598 It isn't used anymore (since switching xml mode to xsltproc).
3600 * gtkdoc-mkhtml.in (gtkdocdir): and here.
3602 * Makefile.am (gtkdocdatadir): change dir.
3604 * configure.in: put data files in $(datadir)/gtk-doc/data, so that
3605 they don't all get mixed up with the html docs installed by other
3610 2003-01-20 Damon Chaplin <damon@gnome.org>
3614 2003-01-20 Damon Chaplin <damon@gnome.org>
3616 * configure.in: bumped version to 1.0, and added SGML_OUTPUT_TYPE
3617 variable, which we set to 'sgml-raw' if we have openjade, or 'sgml'
3618 if we have jade. Added gtk-doc.pc to AC_OUTPUT.
3620 * gtkdoc-mkhtml.in: used SGML_OUTPUT_TYPE variable to set the output
3621 type of jade/openjade.
3623 * gtk-doc.pc.in: new pkg-config file, which apps can use to reliably
3624 check the gtk-doc version in future.
3626 * Makefile.am (pkgconfigdir): install .pc file, and add it to
3629 * examples/configure.in: updated example to use pkg-config for the
3632 2003-01-18 James Henstridge <james@daa.com.au>
3634 * gtkdoc-mkhtml.in (declaration): switch the output type from
3635 "sgml" to "sgml-raw" when using Jade to process docs. This gets
3636 rid of the line breaks inside the tags, which were confusing Lynx.
3638 2003-01-15 Matthias Clasen <maclas@gmx.de>
3640 * gtkdoc-scan.in (ScanHeader): Remove special cases for Pango and
3642 * gtkdoc-mkdb.in (OutputDeclaration):
3643 * gtkdoc-mktmpl.in (OutputDeclaration): Remove special cases for
3644 structs named BlablaClass. (#95398)
3646 * gtkdoc-mkdb.in (GetInterfaces): Fix an off-by-one error.
3647 (#103466, Josh Parsons)
3649 2002-12-28 Chema Celorio <chema@celorio.com>
3651 * gtkdoc-scan[g]obj.in: add "void" to functions with no parameters,
3652 avoids warning with -Wmissing-prototypes when compiling
3655 2002-12-16 James Henstridge <james@daa.com.au>
3657 * gtk-doc.spec.in: require perl >= 5.6.0
3659 * configure.in: require Perl >= 5.6.0
3661 * gtkdoc-fixxref.in: add "use bytes;" to fix malformed UTF-8
3662 character errors when run with a UTF-8 locale.
3664 2002-12-16 Matthias Clasen <maclas@gmx.de>
3666 * gtkdoc-mkdb.in (OutputSGMLFile): Don't emit the additional
3667 anchors in the title which breaks the generated html (the title
3668 text is copied around). Instead, put the anchors before the
3669 synopsis. This isn't perfect, but the best we can achieve without
3672 2002-12-13 Matthias Clasen <maclas@gmx.de>
3674 * gtkdoc-mkdb.in: Add an --ignore-files option which can be used
3675 to omit files or directories from scanning.
3676 (OutputSGMLFile): Emit anchors for all objects contained in the
3677 file to avoid dangling links.
3678 (OutputMissingDocumentation): Emit deprecated symbols after
3681 2002-12-12 Matthias Clasen <maclas@gmx.de>
3683 * gtkdoc-scan.in (ScanHeader): Also recognize "positive" guards
3684 like #ifdef GTK_ENABLE_BROKEN.
3686 2002-12-11 Matthias Clasen <maclas@gmx.de>
3688 * gtk-doc.xsl: Change XPath path to "//anchor|//refentry" for the
3689 generation of index.sgml. The previous path "//anchor|refentry"
3690 was not matching any refentrys.
3692 2002-12-09 Matthias Clasen <maclas@gmx.de>
3694 * gtkdoc-mktmpl.in (UpdateTemplates): Emit unused class structs
3695 to $MODULE-unused.txt.
3697 2002-12-08 Matthias Clasen <maclas@gmx.de>
3699 * gtkdoc-mkdb.in (OutputStruct): Don't emit private parts
3700 of class structs to parameter lists in docs. Remove leftover
3703 * gtkdoc-mktmpl.in (OutputDeclaration): Don't emit private parts
3704 of class structs to parameter lists in templates.
3706 2002-12-06 Matthias Clasen <maclas@gmx.de>
3708 Improved /*< private >*/ handling: (#95398)
3710 * gtkdoc-mkdb.in (OutputStruct): Handle /*< public >*/ and
3711 /*< private >*/ for all structs. Default to private for object and
3712 class structs, to public for all other structs.
3714 * gtkdoc-scan.in (ScanHeader): Emit declarations for class structs
3715 to $MODULE-decl.txt.
3717 2002-12-05 Matthias Clasen <maclas@gmx.de>
3719 * gtkdoc-mktmpl.in (OutputDeclaration):
3720 * gtkdoc-mkdb.in (ReadTemplateFile): Support @Since: and
3721 @Deprecated: as a way to specify since and deprecated information
3722 in template files. This works for all kinds of symbols, even those
3723 which normally don't have parameter lists.
3725 2002-12-02 Matthias Clasen <maclas@gmx.de>
3727 * gtkdoc-mkdb.in (MakeDeprecationNote): Support multi-paragraph
3730 2002-11-29 James Henstridge <james@daa.com.au>
3732 * gtkdoc-mkhtml.in: copy the navigation images for both XML and
3735 * gtk-doc.dsl.in: update DSSSL stylesheets to match layout of XSL
3738 2002-11-29 Matthias Clasen <maclas@gmx.de>
3740 * gtkdoc-scan.in (ScanHeader): Make deprecation guards work with
3742 #ifndef DEPRECATION_GUARD
3743 #if !defined(DEPRECATION_GUARD) || defined(FOO_COMPILATION)
3744 The second form is used in GDK and GTK+ to include selected
3745 deprecated symbols when compiling the library itself.
3747 2002-11-27 Matthias Clasen <maclas@gmx.de>
3749 * gtkdoc-mkdb.in: Parse to new tags in inline doc comments,
3750 Since: and Deprecated:, which can be placed after the Returns:
3751 tag. Emit the Since: information (which is expected to be just a
3752 version number) after the parameters and the Deprecated:
3753 information (which is expected to be one or more full sentences)
3754 inside the deprecation warning.
3755 Warn if a Deprecated: tag is found on a symbol which is not
3756 guarded by a deprecation guard in the header.
3758 2002-11-26 James Henstridge <james@daa.com.au>
3760 * gtkdoc-mkhtml.in: set gtkdoc-bookname and gtkdoc-version
3761 parameters in sgml mode, and don't bother with the sed run after
3762 processing with jade.
3763 In XML mode, pass the version number in as a parameter too.
3765 * gtk-doc.dsl.in ($user-html-header$): add <meta> tag if
3766 gtkdoc-version is set.
3767 (generate-index-mode): if gtkdoc-bookname is set, add it to the
3768 hrefs in the index file, like the XSLT sheets do.
3770 * gtk-doc.xsl: add gtkdoc.version parameter, and use it to add a
3771 <meta> tag with the gtk-doc version number.
3773 === release 0.10 ===
3775 2002-11-16 Damon Chaplin <damon@gnome.org>
3779 2002-11-16 Damon Chaplin <damon@gnome.org>
3781 * configure.in: bumped version to 0.10.
3783 * Makefile.am (EXTRA_DIST): added MAINTAINERS.
3785 * README: updated requirements info, mainly to add XML stuff.
3787 * NEWS: added news for 0.10
3790 * AUTHORS: updated my email address.
3792 2002-11-16 James Henstridge <james@daa.com.au>
3794 * gtk-doc.xsl: output HTML in ISO-8859-1 (latin1), as using UTF-8
3795 can trigger misinterpretation of web pages when the web server
3796 asserts that the document is encoded in latin1 in the mime type.
3798 2002-11-15 James Henstridge <james@daa.com.au>
3800 * gtk-doc.xsl: small changes to make the output closer to valid
3803 * gtkdoc-fixxref.in (MakeXRef): when substituting in cross
3804 references, use lower case element and attribute names, and quote
3805 the attribute value.
3807 2002-11-12 James Henstridge <james@daa.com.au>
3809 * gtkdoc-mkdb.in: put content of parameter descriptions in
3810 <simpara> elements instead of <para>'s. This makes the generated
3811 HTML more compact, as it will omit the <p> tag inside the list
3814 * gtk-doc.xsl: adjust stylesheet a little.
3816 2002-11-10 James Henstridge <james@daa.com.au>
3818 * gtk-doc.xsl: change style for documentation.
3820 * gtkdoc-mkhtml.in (declaration): copy PNG files to the html
3823 2002-11-10 Matthias Clasen <maclas@gmx.de>
3825 * gtkdoc-mkdb.in (GetArgs): Expand abbreviations in source doc
3828 2002-11-09 Matthias Clasen <maclas@gmx.de>
3830 * gtkdoc-mktmpl.in (OutputSignalTemplates): Don't replace template
3831 param names with meaningless argn names generated by gtkdoc-scangobj.
3833 * gtkdoc-mkdb.in (GetSignals): Use argument names from source doc
3834 comments, if available.
3835 (GetArgs): Use source doc comments instead of blurb, if available.
3836 (ScanSourceFile): Also accept object::signal and object:property
3838 (MergeSourceDocumentation): For signals only, prefer source doc
3839 param names over template param names.
3841 Fri Nov 8 15:10:57 2002 Owen Taylor <otaylor@redhat.com>
3843 * gtkdoc-mkdb.in (GetPrerequisites): Add missing <para>
3846 Mon Nov 4 17:17:40 2002 Owen Taylor <otaylor@redhat.com>
3848 * gtkdoc-mkdb.in (MergeSourceDocumentation): Warn
3849 when overriding docs in template file by inline comments.
3851 * gtkdoc-mkdb.in (GetInterfaces): Add missing <para> in
3852 "Implemented interfaces" output.
3854 2002-10-29 Damon Chaplin <damon@ximian.com>
3856 * gtkdoc-scangobj.in: in get_type_name() set is_pointer to TRUE for
3857 subtypes of G_TYPE_BOXED and G_TYPE_POINTER. This means we get things
3858 like "GtkTreeIter *iter" rather than "GtkTreeIter iter" which was
3859 incorrect. Also return 'GParamSpec*' for G_TYPE_PARAM.
3860 in lookup_signal_arg_names() changed GtkNotebook::switch-page
3861 page argument to guint. And fixed a few other entries.
3862 Also fixed argument numbering, so we don't get 2 "widget" arguments.
3864 * gtkdoc-scanobj.in: add ';' after unlink command to avoid warning.
3866 2002-10-20 Matthias Clasen <maclas@gmx.de>
3868 * examples/Makefile.am (SCANOBJ_FILES): Add $(DOC_MODULE).prerequisites.
3870 * gtkdoc-mkdb.in: Read $MODULE.prerequisites and put list of
3871 prerequisites below the object hierarchy for interfaces.
3873 * gtkdoc-scangobj.in: Write information about interface
3874 prerequisites to $MODULE.prerequisites.
3876 2002-10-15 Matthias Clasen <maclas@gmx.de>
3878 * gtkdoc-scangobj.in: Sort paramspec arrays for
3879 greater stability and less random tmpl file diffs.
3881 2002-10-14 Matthias Clasen <maclas@gmx.de>
3883 * examples/Makefile.am (SCANOBJ_FILES): Add $(DOC_MODULE).interfaces.
3885 * gtkdoc-mkdb.in: Read $MODULE.interfaces and put lists of
3886 implemented interfaces/known implementations below the object
3887 hierarchy for classes/interfaces.
3889 * gtkdoc-scangobj.in: Write interface information to
3892 2002-10-12 Matthias Clasen <maclas@gmx.de>
3894 * gtkdoc-scangobj.in: Make interface appear in the object hierarchy.
3896 2002-10-11 Matthias Clasen <maclas@gmx.de>
3898 * gtk-doc.xsl: use 'UTF-8', not UTF-8 for default.encoding, to
3899 make the encoding actually appear in the resulting HTML.
3901 2002-10-09 James Henstridge <james@daa.com.au>
3903 * gtkdoc-mkdb.in: set $doctype_header to "" for the SGML case, as
3904 we don't add a doctype to the beginning of SGML fragments.
3906 Tue Sep 17 01:07:51 2002 Jonathan Blandford <jrb@gnome.org>
3908 * gtk-doc.xsl: output the chunks in UTF-8 so other tools can use
3911 2002-09-03 James Henstridge <james@daa.com.au>
3913 * gtk-doc.xsl: turn on rendering of variablelists as tables, and
3914 set CSS rules to style .variablelist instead of .informaltable.
3916 * gtk-doc.dsl.in (variablelist): override the variablelist handler
3917 instead of the tgroups.
3919 * gtkdoc-mkdb.in (OutputStruct): use a <variablelist> for listing
3920 the field descriptions.
3921 (OutputEnum): same here.
3922 (OutputParamDescriptions): and here.
3924 2002-08-12 James Henstridge <james@daa.com.au>
3926 * gtk-doc.xsl: include devhelp.xsl, and call generate.devhelp when
3927 processing the docbook/xml input.
3929 * devhelp.xsl: new file, implements .devhelp file output.
3931 2002-08-18 Havoc Pennington <hp@pobox.com>
3933 * autogen.sh: hardcode aclocal-1.4/automake-1.4 so that users with
3934 both automake 1.6 and 1.4 installed get the right automake. Means
3935 compilation from CVS will now require the latest automake 1.4
3936 release, or manually creating symlinks called "automake-1.4" and
3939 2002-08-08 Matthias Clasen <maclas@gmx.de>
3941 * gtkdoc-scangobj.in: Make sure blurbs end with a '.'
3943 2002-08-08 James Henstridge <james@daa.com.au>
3945 * gtk-doc.xsl: add a gtkdoc.bookname param, and include it in the
3946 index.sgml output (if not empty).
3948 * gtkdoc-mkhtml.in: only perform the sed operation if we are using
3949 Jade, and pass the module name as a parameter when using xsltproc.
3951 2002-08-04 Matthias Clasen <maclas@gmx.de>
3953 * gtkdoc-scangobj.in: Don't try to list signals on types which
3954 don't support signals, e.g. boxed types.
3956 2002-06-14 jacob berkman <jacob@ximian.com>
3958 * gtkdoc-mkdb.in: do the version check before help, so --version
3959 doesn't output --help (should fix recent build bustage)
3961 2002-06-12 Matthias Clasen <maclas@gmx.de>
3963 * gtkdoc-mkdb.in: Make header-grabbing work without an explicit
3964 --main-sgml-file argument.
3966 * gtkdoc-mkdb.in: Emit the object hierarchy as a <screen> rather
3967 than a <literallayout>, since the Docbook XSL stylesheets don't
3968 handle <link>s inside <literallayout>.
3970 * gtkdoc-mkdb.in: Decide wether to generate standalone documents
3971 for XIncluding or entities based on the presence of the XInclude
3972 namespace declaration on the document element.
3974 2002-06-09 James Henstridge <james@daa.com.au>
3976 * gtkdoc-mkdb.in: try to grab the header off the top of the main
3979 2002-05-31 James Henstridge <james@daa.com.au>
3981 * gtkdoc-mkdb.in (OutputSGML): put XIncludes in the $book_bottom
3983 (OutputBook): add the XInclude namespace declaration to the book
3986 * gtkdoc-mkhtml.in (declaration): if the document looks like XML,
3987 process it with xsltproc.
3989 * configure.in: check for xsltproc.
3991 * gtk-doc.xsl: start of XSLT template for converting docbook/xml
3994 2002-06-03 Matthias Clasen <maclas@gmx.de>
3996 * gtkdoc-mkdb.in (ConvertSGMLChars): Don't use Posix character
3997 classes. Perl < 5.6 doesn't have them; and the API doc autobuilder
3998 on widget.gnome.org has an old Perl.
4000 2002-05-29 Matthias Clasen <maclas@gmx.de>
4004 * gtkdoc-mkdb.in (OutputSGML): Call GetSignals, GetArgs and
4005 GetHierarchy for each symbol here and accumulate.
4006 (OutputSGMLFile): Get signal, argument and hierarchy information
4008 (GetSignals, GetArgs, GetHierarchy): Don't wrap the return value
4009 in a refsect1, so that the results of multiple calls can be accumulated.
4011 2002-05-28 Matthias Clasen <maclas@gmx.de>
4013 * gtkdoc-mkdb.in (ConvertSGMLChars): Make this work correctly
4014 for empty elements and XML comments in doc comments.
4016 2002-05-27 Matthias Clasen <maclas@gmx.de>
4018 * gtkdoc-mkdb.in (ReadTemplateFile, OutputSGMLFile):
4019 Use only the basename of the template file in the key for the
4020 symbol table, in order to decouple the file extensions of the
4021 template files and the generated entities (we want to generate
4022 .xml entities from .sgml template files when emitting XML).
4024 2002-05-25 Matthias Clasen <maclas@gmx.de>
4026 * gtkdoc-mkdb.in (ConvertSGMLChars): New function which tries to
4027 be a bit more clever when escaping SGML syntax characters.
4028 (ScanSourceFile): Use ConvertSGMLChars instead of CreateValidSGML.
4029 This reduces the work needed to make gtk-doc emit XML (where <, &
4030 and friends must always be escaped).
4032 2002-05-18 Matthias Clasen <maclas@gmx.de>
4034 * gtkdoc-mkhtml.in: Detect whether we're processing SGML or XML.
4036 * gtkdoc-mkdb.in: New option --output-format to switch between
4037 SGML and XML output.
4039 * Makefile.am (EXTRA_DIST): Add xml.dcl
4041 * xml.dcl: The XML declaration.
4043 2002-05-06 jacob berkman <jacob@ximian.com>
4045 * gtkdoc-scangobj.in: add an include for the GTK_CHECK_VERSION
4048 2002-05-05 Matthias Clasen <maclas@gmx.de>
4050 * gtkdoc-scangobj.in: Output style properties. (#80659)
4052 * gtkdoc-mkdb.in (GetArgs): Return separate sections for
4053 properties, child properties and style properties. (#80659)
4055 2002-05-03 Matthias Clasen <maclas@gmx.de>
4057 * gtkdoc-scangobj.in: Fix for segfault in scangobj-generated C
4058 program on Solaris. (#80606, Jacob Berkman)
4060 2002-05-01 Matthias Clasen <maclas@gmx.de>
4062 * tools/docpercentages.pl: Add the script which Owen uses for the
4063 d.g.o online API docs. Its easier to keep in sync here.
4065 * gtkdoc-mkdb.in (OutputMissingDocumentation): Fix
4066 $MODULE-undocumented.txt for d.g.o online API docs.
4068 * gtkdoc-mkdb.in (GetArgs): Use blurbs for property documentation.
4070 * gtkdoc-scangobj.in: Output child properties. Output nicks and
4071 blurbs for properties.
4073 2002-04-28 Matthias Clasen <maclas@gmx.de>
4075 * gtkdoc-mkdb.in (ScanSourceFile): Don't scan for return value
4076 descriptions unnecessarily. (#65997)
4078 2002-03-11 Matthias Clasen <maclas@gmx.de>
4080 * gtkdoc-scangobj.in, gtkdoc-mkdb.in: Create docs for signals on interfaces.
4082 2002-02-01 Damon Chaplin <damon@ximian.com>
4084 * configure.in: check for openjade or jade. Patch from Stefan Kost
4085 <kost@imn.htwk-leipzig.de>.
4087 * gtkdoc-mkhtml.in: use @JADE@ so the correct version of jade is used.
4089 * autogen.sh: commented out autoheader since we don't have a config.h.
4093 2002-01-18 Damon Chaplin <damon@ximian.com>
4097 2002-02-01 Damon Chaplin <damon@ximian.com>
4099 * examples/Makefile.am: added SCANOBJ_OPTIONS in case the module needs
4100 to pass options to gtkdoc-scanobj or gtkdoc-scangobj.
4102 2002-01-24 Damon Chaplin <damon@ximian.com>
4104 * tools/gtk-doc.el: added Zucchi's emacs lisp for automatically adding
4105 skeleton comment blocks above functions. Very handy!
4107 2002-01-23 Damon Chaplin <damon@ximian.com>
4109 * configure.in: bumped the version to 0.9, so GTK+ can depend on this
4112 * gtkdoc-scangobj.in: we now default to calling g_type_init() to
4113 initialize the type system, rather than gtk_init(). This means you
4114 don't need an X connection to build the docs any more. Hurrah!
4115 Also added a '--type-init-func' argument so you can change the
4116 function to be called. GTK+ uses --type-init-func="gtk_type_init(0)".
4118 * gtkdoc-scan.in (ScanHeader): removed 'Found object' debug message.
4122 2002-01-18 Damon Chaplin <damon@ximian.com>
4126 2002-01-18 Damon Chaplin <damon@ximian.com>
4128 * Makefile.am (EXTRA_DIST): added gtk-doc.dcl to EXTRA_DIST.
4130 2002-01-18 Damon Chaplin <damon@ximian.com>
4132 * gtkdoc-scangobj.in: Reverted jacob's patch for this release, since
4133 it breaks GTK+ and possibly other packages. I'll re-apply it after
4134 the release, so we can fix everything in CVS.
4136 2002-01-18 jacob berkman <jacob@ximian.com>
4138 * gtkdoc-scangobj.in: default to calling g_type_init(), remove
4139 --nogtkinit argument and replace with a more flexible
4142 2002-01-18 Damon Chaplin <damon@ximian.com>
4144 * gtkdoc-mkdb.in (ScanSourceFile): patch from Matthias Clasen
4145 <matthiasc@poet.de> to only strip first space after '*' in source
4146 code comment blocks, so example code can be indented as desired.
4149 Wed Nov 21 16:50:35 2001 Owen Taylor <otaylor@redhat.com>
4151 * gtkdoc-mkdb,tmpl.in: Add some extra quoting to
4152 error messages to make it clearer what is going on
4153 with trailing commas on enumeration declarations.
4155 Wed Nov 21 16:00:45 2001 Owen Taylor <otaylor@redhat.com>
4157 * Applied patch from Matthias Clasen to use a modified
4158 .dcl file with the 44 character name length limit removed.
4161 2001-10-17 Damon Chaplin <damon@ximian.com>
4163 * gtkdoc-mkdb.in: applied patch from Matthias Clasen
4164 <matthiasc@poet.de> to take a --sgml-mode argument which means
4165 all comment blocks in the source code are assumed to be DocBook
4166 (i.e. we don't convert '<', '>' and '&' to '<' etc.
4168 2001-10-09 Damon Chaplin <damon@ximian.com>
4170 * gtkdoc-mkdb.in (OutputMissingDocumentation): changed %.2f to %.0f
4171 so hopefully the automated reports on developer.gnome.org will work
4174 2001-10-02 Damon Chaplin <damon@ximian.com>
4176 * gtkdoc-mktmpl.in (OutputDeclaration):
4177 * gtkdoc-mkdb.in (OutputFunction): applied patch from
4178 matthiasc@poet.de (Matthias Clasen) to handle G_CONST_RETURN in a
4179 parameter list. Bug #61341.
4181 2001-10-02 Damon Chaplin <damon@ximian.com>
4183 * gtkdoc-mkdb.in (OutputMissingDocumentation): applied patch from
4184 matthiasc@poet.de (Matthias Clasen) to output percentages better.
4186 Also set percent to 100 if total is 0, avoiding divide-by-zero.
4188 2001-10-02 Damon Chaplin <damon@ximian.com>
4190 * examples/Makefile.am (DOC_OVERRIDES): define as an empty string,
4193 2001-09-13 Damon Chaplin <damon@ximian.com>
4195 * gtkdoc-mkdb.in (OutputMissingDocumentation): initialize buffer to "".
4196 Fix for SGI from David Kaelbling <drk@sgi.com>.
4198 Sat Sep 8 14:08:51 2001 Jonathan Blandford <jrb@webwynk.net>
4200 * gtkdoc-scan.in (ScanHeader): recognize GET_IFACE macros
4202 2001-09-08 Havoc Pennington <hp@pobox.com>
4204 * gtkdoc-mkdb.in (GetArgs): Title the section on object properties
4205 "Properties" instead of "Args"
4207 2001-08-14 Laszlo Peter <laca@ireland.sun.com>
4209 * gtkdoc-scanobj.in:
4210 * gtkdoc-scangobj.in: change \n's to \\n's in perl scripts
4213 2001-08-12 Jens Finke <jens@gnome.org>
4215 * Updated gtk-doc.spec.in file to match gpp standard.
4219 2001-08-04 Damon Chaplin <damon@ximian.com>
4223 2001-08-04 Damon Chaplin <damon@ximian.com>
4225 * gtkdoc-mkdb.in (OutputFunction):
4226 * gtkdoc-mktmpl.in (OutputDeclaration): patch from Lowell Johnson
4227 <ldjohn@usgs.gov> to accept things like "long long", "short int",
4228 "char test[][CLEN]" as function parameters.
4230 2001-07-20 Anders Carlsson <andersca@gnome.org>
4232 * gtkdoc-scangobj.in: Remove argument to g_type_init ();
4234 2001-07-09 Damon Chaplin <damon@ximian.com>
4236 * gtkdoc-mkdb.in (ParseStructDeclaration): accept G_CONST_RETURN
4237 modifier for function return values. gtkdoc-mktmpl.in already had this.
4239 Thu Jun 21 11:57:16 2001 Owen Taylor <otaylor@redhat.com>
4241 * gtkdoc-scangobj.in: Conform to changes in GObject API
4242 for property retrieval.
4244 2001-05-25 Peter Williams <peterw@ximian.com>
4246 * gtkdoc-mkdb.in (ScanSourceFile): Skip single-line comments --
4247 prevents barfing on ORBit-generated files.
4249 2001-05-20 Damon Chaplin <damon@ximian.com>
4251 * examples/Makefile.am (sgml-build.stamp): replaced use of wildcard
4252 (which isn't portable) with original *.sgml. I think this just means
4253 that the first time you try to build the docs it will fail, but if
4254 you run make again it will work.
4256 * doc/setting-up.txt: explained that make may fail the first time.
4258 2001-05-19 Damon Chaplin <damon@ximian.com>
4262 * doc/setting-up.txt:
4263 * doc/sections-file.txt:
4264 * doc/authors.txt: updated docs to cover simpler setup procedure.
4266 * doc/gtk_button.txt:
4269 * doc/notes.txt: removed out-of date stuff.
4271 * Makefile.am (dist-hook): updated so it doesn't try to remove old
4272 examples subdirectory stuff.
4274 2001-05-19 Damon Chaplin <damon@ximian.com>
4277 * examples/gnomeui/*: removed out-of-date example files.
4279 * examples/configure.in:
4280 * examples/Makefile.am: new example setup mostly copied from GTK+.
4282 * examples/README: describe the example configure.in/Makefile.am.
4284 2001-05-19 Damon Chaplin <damon@ximian.com>
4286 * gtkdoc-mkdb.in: added --help option and changed output slightly to
4287 make more compatable with XML. Patch from Toshio Kuratomi
4288 <badger@prtr-13.ucsc.edu>
4290 2001-05-19 Damon Chaplin <damon@ximian.com>
4292 * gtkdoc-mktmpl.in (OutputDeclaration):
4293 * gtkdoc-mkdb.in (OutputFunction): changed a '?' to a '*' so we accept
4294 multi-dimensional array function parameters. Patch from Paolo Casarini
4295 <casarini@CS.UniBO.IT>
4297 2001-05-12 Damon Chaplin <damon@ximian.com>
4299 * gtkdoc-scangobj.in:
4300 * gtkdoc-scanobj.in: used "*pos = 0" to avoid problems with backslashes
4303 * configure.in: removed dsssl dirs stuff, since we use public entities
4306 * gtkdoc-mkdb.in (OutputBook): if there is no main SGML file we create
4307 it here. Also added a --main-sgml-file option so we know where to put
4310 * gtkdoc-scan.in: if there is no MODULE-sections.txt file, we copy
4311 the MODULE-decl-list.txt file to it. The user can tweak it later.
4313 2001-05-11 Damon Chaplin <damon@ximian.com>
4315 * gtk-doc.spec.in: applied patch from Toshio Kuratomi
4316 <badger@prtr-13.ucsc.edu>.
4318 2001-05-07 Joakim Ziegler <joakim@ximian.com>
4320 * gtkdoc-mkdb.in: Added option --outputallsymbols to create a symbol list
4321 in the module doc dir.
4323 * gtkdoc-mkdb.in: Added functionality to output a list of undocumented
4324 symbols in a module, most of is is in OutputMissingDocumentation.
4326 * gtkdoc-scan.in: Small scanning fixes to facilitate the doc coverage
4327 output mentioned above.
4329 2001-04-25 Federico Mena Quintero <federico@ximian.com>
4331 * gtkdoc-scanobj.in: Added missing output-dir in the call to
4334 2001-04-24 Damon Chaplin <damon@ximian.com>
4336 * gtkdoc-scanobj.in: copied --outputdir option from gtkdoc-scangobj.in.
4338 Fri Apr 13 15:25:44 2001 Owen Taylor <otaylor@redhat.com>
4340 * gtkdoc-mkdb.in: Restore call to OutputBook that was accidentally
4343 Thu Apr 12 17:57:12 2001 Owen Taylor <otaylor@redhat.com>
4345 * gtkdoc-scangobj.in: Add a --outputdir option (sort of hacky.
4346 Need this because $CC, $LD can include relative paths if they
4347 are based on $LIBTOOL)
4349 2001-03-26 Damon Chaplin <damon@ximian.com>
4351 * gtkdoc-mkdb.in (ReadSourceDocumentation): scan .h files as well,
4352 so macros can be documented there if desired. Patch from
4353 Yoann Vandoorselaere <yoann@mandrakesoft.com>
4355 * gtkdoc-mkhtml.in (gtkdocdir): use 'test -f' rather than 'test -e'
4356 which is GNU-specific.
4358 Thu Mar 8 17:26:29 2001 Tim Janik <timj@gtk.org>
4360 * gtkdoc-scangobj.in: fix signal param type handling.
4362 Tue Mar 6 23:21:46 2001 Jonathan Blandford <jrb@redhat.com>
4364 * gtkdoc-scanobj.in: Add gobject support. Now works on files that
4365 don't link against GTK.
4367 Sat Mar 3 17:43:42 2001 Owen Taylor <otaylor@redhat.com>
4369 * gtkdoc-{scan,mktmpl,mkdb}.in: Add support for G_CONST_RETURN.
4370 (Right now, it will appear as G_CONST_RETURN in the output -
4371 I'm not sure that's right - perhaps it should be converted
4374 2001-02-20 Michael Meeks <michael@ximian.com>
4376 * gtkdoc-mktmpl.in: s/TRUE/1/
4378 2001-02-19 Damon Chaplin <damon@ximian.com>
4380 * gtkdoc-mktmpl.in (UpdateTemplates): fixed bug handling the $changed
4383 2001-02-17 Damon Chaplin <damon@ximian.com>
4385 * gtkdoc-scan.in (ScanHeaders):
4386 (ScanHeader): patch from Johannes Stezenbach <js@convergence.de>
4387 so we don't use '\b' in the regexp to match files/dirs to ignore.
4388 '\b' can match '_' so we matched things we shouldn't have.
4390 Mon Feb 12 12:50:57 2001 Owen Taylor <otaylor@redhat.com>
4392 * configure.in: Up version.
4394 Sun Feb 11 18:35:07 2001 Owen Taylor <otaylor@redhat.com>
4396 * gtkdoc-mktmpl.in: Add a timestamp file for the
4397 templates like sgml.stamp
4399 * gtkdoc-mktmpl.in (OutputUnusedTemplates): Write the
4400 symbols out in sorted order instead of hash table
4401 order to reduce conflicts.
4403 Mon Feb 5 16:48:51 2001 Owen Taylor <otaylor@redhat.com>
4405 * configure.in gtk-doc.dsl.in: Remove checks for DSSSL - use a
4406 public entity instead.
4408 * gtkdoc-scangobj.in: Fix to work with libtool better.
4410 2001-01-30 Havoc Pennington <hp@pobox.com>
4412 * gtkdoc-fixxref.in, gtkdoc-mkdb.in, gtkdoc-mktmpl.in,
4413 gtkdoc-scan.in, gtkdoc-scangobj.in, gtkdoc-scanobj.in:
4414 Added -*- cperl -*- magic, and --deprecated-guards
4417 2001-01-23 Damon Chaplin <damon@helixcode.com>
4419 * gtkdoc-scangobj.in:
4420 * gtkdoc-scanobj.in:
4423 * gtkdoc-mktmpl.in: changed so that they only update files when
4424 necessary (they write new versions of the files out, then use 'cmp'
4425 to compare with the existing versions to see if they have changed.)
4426 This should make it easier to do proper dependency rules in Makefiles,
4427 and it may cut down on CVS traffic.
4429 * gtkdoc-mkhtml.in: update a timestamp file (html.stamp) after running.
4430 * gtkdoc-mkdb.in: update a timestamp file (sgml.stamp) if any of the
4431 DocBook SGML files have been changed. So hopefully you can now use
4432 rules like this to avoid unnecessary regeneration of the HTML:
4440 html.stamp: sgml.stamp $(EXTRA_SGML_FILES)
4443 (I've tried this with the old GTK+ reference API docs and it seems to
4446 * gtkdoc-scangobj.in:
4447 * gtkdoc-scanobj.in:
4453 * gtkdoc-fixxref.in:
4454 Added '--version' command-line arg to all shell & perl scripts, so
4455 you can check for version 0.5 if you want to use the above rules.
4456 (If 0.4 is used make will probably complain about not knowing how to
4457 to build sgml.stamp.)
4459 * gtkdoc-common.pl.in: new file to contain shared routines.
4460 For now it just contains the UpdateFileIfChanged routine for the above.
4461 We can move the duplicated routines here in future, though the use of
4462 global variables makes this a bit awkward.
4464 * configure.in (PACKAGE_DATA_DIR): calculates the data dir and
4465 substitutes it so that the scripts know where gtkdoc-common.pl
4466 is installed. Also added gtkdoc-common.pl to AC_OUTPUT.
4468 * Makefile.am: added gtkdoc-common.pl to gtkdocdata_DATA.
4470 * gtkdoc-mkhtml.in: deleted the old index.sgml file, since it causes
4471 problems if it is owned by root (e.g. after you run 'make install' as
4472 root. jade prompts you about overwriting it, which is annoying.
4474 2001-01-10 Havoc Pennington <hp@redhat.com>
4476 * gtkdoc-mktmpl.in: Only move old file to backup if the old file
4477 exists, and have better error messages when doing the backups
4479 Mon Jan 8 14:57:29 2001 Owen Taylor <otaylor@redhat.com>
4481 * gtkdoc-mktmpl.in: Canonicalize signal and argument
4484 * gtkdoc-scangobj.in: Fix up for GParamSpec.
4486 2001-01-04 Fr�d�ric Gobry <frederic.gobry@smartdata.ch>
4488 * gtkdoc-scan.in: fixed matching of < private_header > directive
4490 2000-12-19 Damon Chaplin <damon@helixcode.com>
4492 * gtkdoc-scanobj.in:
4493 * gtkdoc-scangobj.in: added default cases to get_type_name().
4495 2000-12-10 Arturo Tena <arturo@directmail.org>
4497 * gtkdoc-scanobj.in (get_type_name):
4498 * gtkdoc-scangobj.in (get_type_name): fixed syntax error: forgotten
4499 to close a switch statement.
4501 2000-12-10 Damon Chaplin <damon@helixcode.com>
4503 * gtk-doc.spec.in: added spec.in file from John Gotts
4504 <jgotts@linuxsavvy.com>.
4506 * configure.in (AC_OUTPUT): added spec file.
4508 * Makefile.am: uncommented spec file stuff, now that we have one.
4510 * gtkdoc-scanobj.in (get_type_name):
4511 * gtkdoc-scangobj.in (get_type_name): updated to use the type numbers
4512 rather than the type names, which were changed in GTK+ 1.2. This
4513 should fix a problem where GTK_TYPE_STRING arguments were output as
4514 'GtkString *arg' instead of 'gchar *arg'.
4516 I'm still not sure what to output for the structured types such as
4517 GTK_TYPE_SIGNAL/ARGS/FOREIGN/CALLBACK/C_CALLBACK. Should these be
4518 expanded to several arguments to the signal handler?
4520 2000-11-25 Dan Mueth <d-mueth@uchicago.edu>
4522 * help/manual/C/: created this path
4523 * gtk-doc-manual.sgml: Put part of the outline into SGML.
4524 Chris plans to put rest of outline in here and start
4526 * fdl-appendix.sgml: The FDL in SGML. We will probably post
4527 these on the web as a single document (book) so we will
4528 need the FDL to be included as an appendix.
4530 Fri Nov 3 07:21:34 2000 Tim Janik <timj@gtk.org>
4533 (ParseStructDeclaration):
4536 (ParseStructDeclaration):
4537 support /*<protected>*/ equivalently to /*<private>*/
4539 Fri Nov 3 07:15:58 2000 Tim Janik <timj@gtk.org>
4543 (ReadTemplateFile): only eat up the first space (if at all
4544 present) after "@param:" to preserve indentation for multiline
4545 parameter descriptions.
4547 2000-10-30 Raja R Harinath <harinath@cs.umn.edu>
4549 * gtkdoc-mkdb.in (ParseStructDeclaration):
4550 Stop scanning at '}' only when it starts a line.
4551 * gtkdoc-mktmpl.in (ParseStructDeclaration): Likewise.
4553 Mon Oct 30 02:59:54 2000 Tim Janik <timj@gtk.org>
4555 * gtkdoc-scangobj.in: use g_signal_list_ids().
4557 Sun Oct 29 02:54:51 2000 Owen Taylor <otaylor@redhat.com>
4559 * gtkdoc-scangobj.in: Sort signal types arrays for
4560 greater stability and less random tmpl file diffs.
4562 Sun Oct 29 01:02:35 2000 Owen Taylor <otaylor@redhat.com>
4564 * gtkdoc-scangobj.in: Work properly with GSignal
4568 2000-10-21 Damon Chaplin <damon@helixcode.com>
4572 2000-10-14 Damon Chaplin <damon@helixcode.com>
4575 * MAINTAINERS: changed my email address.
4577 * Makefile.am (dist-hook): remove the CVS dirs from the dist.
4579 * doc/setting-up.txt: typo.
4581 Fri Oct 6 17:51:50 2000 <otaylor@redhat.com>
4583 * gtkdoc-scan.in gtkdoc-mkdb.in: Allow multiple
4584 --source-dir options.
4586 Thu Sep 7 11:41:12 2000 Owen Taylor <otaylor@redhat.com>
4588 * gtkdoc-mkdb.in: Ignore all . files when scanning directories.
4590 * gtkdoc-scan.in: Add support for GLIB_VAR, GDKVAR,
4591 etc when looking for variable declarations.
4593 * gtkdoc-scan.in: Recognize GET_CLASS macros.
4595 * gtkdoc-scangobj.in: Support .lo intermediate files
4598 Wed Sep 6 17:57:33 2000 Owen Taylor <otaylor@redhat.com>
4600 * gtkdoc-scangobj.in: Add gtkdoc-scangobj scanner for
4601 GObject type system.
4603 * gtkdoc-scanobj.in: Allow setting $LD to allow separating
4604 compilation and linking and thus to allow using libtool.
4606 * gtkdoc-fixxref.in (ScanIndices): Allow HTMLDIR
4607 not to be present yet.
4609 Tue Sep 5 23:37:53 2000 Owen Taylor <otaylor@redhat.com>
4611 * gtkdoc-fixxref.in: Add a --extra-dir option to
4612 allow scanning of additional uninstalled HTML
4615 * gtkdoc-scan.in (ScanHeaders): Honor subdirectories
4616 appearing in --ignore-headers.
4618 * gtkdoc-mkdb.in: Append -CAPS to all all-caps identifiers
4619 to prevent an infinite expansion of special cases.
4621 * gtkdoc-fixxref.in: Add a --module-dir option to
4622 allow fixing references in an uninstalled tree.
4624 * gtkdoc-mkdb.in gtkdoc-mkhtml.in: Simple handling
4625 for macros with embedded commas in enumeration
4628 Mon Aug 28 18:18:53 2000 Owen Taylor <otaylor@redhat.com>
4630 * configure.in (DSSSL_DIR): Remove check for AM_PATH_GTK
4631 since the dependency is only run-time not install-time,
4632 and to avoid dependency loops.
4634 2000-06-21 Damon Chaplin <damon@helixcode.com>
4636 * gtkdoc-mkdb.in: fixed <INCLUDES> bug, I think.
4638 Wed Feb 9 11:29:25 2000 Owen Taylor <otaylor@redhat.com>
4640 * gtkdoc-scan.in: Hack to avoid misidentifying structures
4641 as GtkObjects within Pango.
4643 1999-12-15 Raja R Harinath <harinath@cs.umn.edu>
4645 * gtk-doc.dsl.in ($generate-chapter-toc$): Add missing close
4648 1999-11-23 Raja R Harinath <harinath@cs.umn.edu>
4650 * gtk-doc.dsl.in: Use the (define (foo) ...) syntax rather than
4651 the uglier (define foo (lambda () ...)) syntax.
4652 ($generate-chapter-toc$): Simplify.
4653 ($shade-verbatim-attr$): Simplify. Use ($table-width$) instead of
4654 "100%" for width (See docs. of NWalsh Docbook DSSSL Stylesheets
4655 for an explanation).
4657 1999-09-20 Damon Chaplin <damon@karuna.freeserve.co.uk>
4659 * gtk-doc.dsl.in: If a Chapter has role="no-toc" we don't generate a
4660 table of contents. This is useful if a better contents page has been
4661 added manually, e.g. for the GTK+ Widgets & Objects page. (But it is
4664 * gtkdoc-scanobj.in: added --nogtkinit flag which will make it call
4665 gtk_type_init() rather than gtk_init(). This is useful when it is
4666 run automatically to update the docs by a cron job or similar and a
4667 connection to an X server is not desirable. However, if any widgets
4668 need a connection to X in their class init function then this can't
4669 be used (e.g. GtkFontSelection at present).
4671 Mon Sep 20 09:09:12 1999 Owen Taylor <otaylor@redhat.com>
4673 * gtkdoc-mkdb.in gtkdoc-mktmpl.in: (ParseStructDeclaration):
4674 Fixed up the code to do /*< private >*/ ... stripping.
4676 1999-09-10 Martin Baulig <martin@home-of-linux.org>
4678 * gtkdoc.dsl.in ($generate-chapter-toc$): Return #t, not #f.
4680 1999-09-09 Martin Baulig <martin@home-of-linux.org>
4682 * gtkdoc-scan.in (ScanHeader): Don't force typedefs and other
4683 things to start in column 0; allow some spaces in front of them.
4684 Output `typedef struct { ... } name' structs as typedef, not as
4687 1999-09-08 Martin Baulig <martin@home-of-linux.org>
4689 * gtkdoc-mkdb.in (CreateValidSGMLID): `s/::/-/g;' for CORBA objects.
4691 1999-08-22 Erik Walthinsen <omega@cse.ogi.edu>
4693 * gtkdoc-scan.in: modified so it will find any Class, not just Gtk
4694 and Gnome classes. Introduces the possibility of extraneous Class
4695 definitions (verified), which should be pruned somehow (haven't
4696 analyzed the false positive yet).
4698 1999-08-22 Damon Chaplin <damon@karuna.freeserve.co.uk>
4701 * gtkdoc-mkdb.in: a few fixes to ParseStructDeclaration. It still
4702 has problems with nested structs/unions like those which occur in
4703 gtkclist.h and gtktypeutils.h.
4705 * configure.in: removed gtk-doc.spec from AC_OUTPUT, as whoever wrote
4706 this forgot to add gtk-doc.spec.in to CVS.
4707 * Makefile.am: commented out gtk-doc.spec.
4709 Wed Aug 18 03:55:30 1999 Owen Taylor <otaylor@redhat.com>
4711 * gtkdoc-mktmpl.in: Propagate fix from gtkdoc-mkdb.in.
4712 :-(; need to libraryize, need to libraryize.
4714 Wed Aug 18 03:55:30 1999 Owen Taylor <otaylor@redhat.com>
4716 * gtkdoc-mkdb.in: Fix bug that was preventing
4717 structure field definitions from being output.
4719 Wed Aug 18 23:25:23 1999 Owen Taylor <otaylor@redhat.com>
4721 * configure.in: Add /usr/lib/sgml/stylesheet to list
4722 of stylesheet directories. (Found in recent Debian
4725 1999-08-15 Damon Chaplin <damon@karuna.freeserve.co.uk>
4727 * gtkdoc-mkdb.in: Output $decl_out as the struct rather than the
4728 original $declaration.
4730 1999-08-12 Damon Chaplin <damon@karuna.freeserve.co.uk>
4733 * gtkdoc-mktmpl.in: Added special case in ParseEnumDeclaration to
4734 handle GIOCondition which uses strange macros like this:
4737 G_IO_IN GLIB_SYSDEF_POLLIN,
4739 The GLIB_SYSDEF_POLLIN macro expands to something like '=1'
4741 1999-08-05 Damon Chaplin <damon@karuna.freeserve.co.uk>
4743 * gtk-doc.dsl.in: output <br clear=all> after sections and at end of
4744 page so that right-aligned images aren't messed up quite as much.
4746 Wed Aug 4 04:04:55 1999 Owen Taylor <otaylor@redhat.com>
4748 * gtkdoc-mk{db,tmpl}.in (ParseStructDeclaration): Allow
4751 * gtkdoc-mktmpl.in (ReadObjectHierarchy): Remove
4752 call to MakeXref that slipped in accidentally.
4754 Wed Aug 4 03:30:19 1999 Owen Taylor <otaylor@redhat.com>
4756 * doc/style-guide.txt: Removed references to creating
4757 tables explicitely in favor of demonstrating new
4758 syntax. Added a short section on /<* public >*/
4759 and /*< private *>/.
4761 Wed Aug 4 03:15:19 1999 Owen Taylor <otaylor@redhat.com>
4763 * gtkdoc-mktmpl.in gtkdoc-mkhtml.in: Handle Struct and
4764 Enumerations in approximately the same way as we
4765 handle parameters. That is, instead of (as before)
4766 coding in the tables by hand, one uses lines like:
4768 @width: the width of the rectangle in pixels.
4770 To support migration from the older hand-coded
4771 tables, if none of the members of a structure or
4772 enumeration have a description in a @... line, then
4773 we don't generate the table at all.
4775 Also, gtkdoc-mktmpl now loads up the object heirarchy,
4776 because we need to be able to check if structures
4777 are widget structures.
4779 In general, the coding here is pretty clean, though
4780 the style is a little different. (I'm interating
4781 through strings with m/.../msg; instead of
4782 s/^...//; for one thing.) However, there are a some
4783 of FIXME's where I've whimped out on try to handle
4784 real C syntax, and the need to split out and librarize
4785 a bunch of duplicated code is greater than ever.
4787 1999-06-06 Damon Chaplin <damon@karuna.freeserve.co.uk>
4789 * configure.in: updated version to 0.3.
4791 * doc/style-guide.txt: A couple of minor changes.
4793 * gtkdoc-mkdb.in: Get rid of a couple of messages.
4794 Output an empty <para> if an Arg isn't documented, to keep Jade happy.
4796 1999-05-22 Damon Chaplin <damon@karuna.freeserve.co.uk>
4798 * gtk-doc.dsl.in: Renamed %shade-verbatim-attr-2% to
4799 $shade-verbatim-attr$ and removed our redefinition of
4800 $verbatim-display$ since the stylesheets version now calls
4801 $shade-verbatim-attr$ as a function which is just what we wanted.
4803 * README: Updated info on stylesheet versions supported - 1.40 is
4804 known to be OK (with this version of gtk-doc), 1.19+ may work.
4806 1999-03-31 Damon Chaplin <damon@karuna.freeserve.co.uk>
4808 * configure.in: update version to 0.2 for next release.
4811 * gtkdoc-mkdb.in: added support for 'See Also' section.
4813 * gtk-doc.dsl.in: changed green background color slightly, and
4814 set background color for enum tables.
4816 1999-03-21 Damon Chaplin <damon@karuna.freeserve.co.uk>
4818 * gtkdoc-mkhtml.in (gtkdocdir): use '-w no-idref' to suppress all the
4819 warnings about references to non-existent IDs.
4821 1999-03-18 Damon Chaplin <damon@karuna.freeserve.co.uk>
4823 * gtkdoc-mkdb.in (OutputParamDescriptions): use role="params" for the
4824 table so we can adjust the stylesheet code.
4825 (OutputSGMLFile): Don't output 'one line description goes here'.
4826 (ExpandAbbreviations): allow '-' in #symbol abbreviations, so we can
4827 use #GtkWidget-struct.
4828 (MakeXRef): get rid of special '-struct' suffix, for #GtkWidget-struct.
4830 * gtk-doc.dsl.in: use the "role" attribute on tables to set the
4833 * gtkdoc-scan.in (ScanHeader): fix for scanning functions declared
4834 over multiple lines - was catching things which weren't functions.
4836 1999-03-11 Damon Chaplin <damon@karuna.freeserve.co.uk>
4838 * examples/gnomeui/Makefile.am (clean-local):
4839 * examples/gnome/Makefile.am (clean-local): added *.args
4841 * gtkdoc-mkdb.in: added support for Args and variables. Also a few
4842 minor changes in the output, e.g. don't show macros > 2 lines long.
4845 * gtkdoc-scanobj.in: added support for Args.
4847 * gtkdoc-scan.in: added support for extern'ed variables. Also
4848 accept 'extern' before function declarations.
4850 * gtk-doc.dsl.in: made output prettier. Changed the navigation bars
4851 and the colours used for the various backgrounds.
4853 * doc/style-guide.txt: new file containinf a style guide for writing
4854 the GTK+ documentation.
4856 * doc/README: added description of style-guide.txt
4858 * doc/setting-up.txt: fixed a typo
4860 * README: added a bit about Args.
4862 1999-02-07 Damon Chaplin <damon@karuna.freeserve.co.uk>
4864 * Makefile.am: Removed all the scripts from EXTRA_DIST, as they are
4865 now generated from the .in files which automatically go in the dist.
4867 1999-02-02 Damon Chaplin <damon@karuna.freeserve.co.uk>
4869 * doc/setting-up.txt (scan): removed text which incorrectly said that
4870 changing section titles means you have to recreate the main SGML file.
4872 1999-02-03 Sebastian Wilhelmi <wilhelmi@ira.uka.de>
4874 * configure.in: find perl in $PATH, generate the perl programs
4875 from their *.in counterparts.
4877 * gtkdoc-fixxref, gtkdoc-mkdb, gtkdoc-mktmpl, gtkdoc-scan,
4878 gtkdoc-scanobj: Renamed to *.in and changed /usr/bin/perl to
4879 @PERL@, as determined by configure.
4881 * .cvsignore: Added diverse config* stuff and the new generated
4884 1999-01-28 Damon Chaplin <damon@karuna.freeserve.co.uk>
4886 * gtk-doc.dsl.in: I forgot to make the new refentry code process the
4887 child elements, so it was only outputting anchors for each page.
4889 * doc/setting-up.txt (scan): added step to create MODULE.types file
4890 for modules which contain widgets (or objects).
4892 * gtkdoc-mkdb (OutputStruct): allow spaces inside the public/private
4893 markers, e.g. "/* < public > */"
4895 1999-01-27 Damon Chaplin <damon@karuna.freeserve.co.uk>
4897 * Makefile.am: added scripts to EXTRA_DIST and copied examples, doc
4898 and db2man dirs in dist-hook.
4900 * doc/sections-file.txt: added a couple of examples.
4902 * doc/setting-up.txt: new document describing how to set up a module
4905 * doc/README: added description of setting-up.txt
4907 * README: added short 'Installation' section describing the
4908 --with-dsssl-dir option.
4910 * gtk-doc.dsl.in: also output links to each RefEntry page in the
4911 index.sgml file, so libgnomeui docs can link to widgets. (The widget
4912 hierarchy links were not working before.)
4914 1999-01-26 Damon Chaplin <damon@karuna.freeserve.co.uk>
4916 * gtkdoc-scan (ScanHeader): parse function declarations that have the
4917 return type and name on one line, and the '(' and args on the next.
4918 NOTE: functions with the start of the declaration split over 3 lines
4919 will not be parsed (e.g. return type on one line, function name on
4920 next, and '(' and first argument on the third.) I hope there aren't
4923 * gtkdoc-mkdb (OutputStruct): Use a different SGML ID for widget
4924 structs, since the original ID is used for the entire RefEntry.
4925 Also only show parts of widget structs which are marked with a
4926 comment '/*<public>*/'. Use '/*<private>*/' for private fields.
4928 * gtkdoc-mktmpl (UpdateTemplates): We include widget structs now,
4929 so we do want warnings if they aren't used.
4931 * examples/gnomeui/gnomeui-docs.sgml:
4932 * examples/gnomeui/gnomeui-sections.txt:
4933 * examples/gnomeui/gnomeui.types:
4934 * examples/gnome/gnome-docs.sgml:
4935 * examples/gnome/gnome-sections.txt: sync with latest source.
4937 * examples/configure.in: Add --with-gnome-libs-dir option, so it can
4938 be configured easily.
4939 * examples/gnomeui/Makefile.am (DOC_SOURCE_DIR):
4940 * examples/gnome/Makefile.am (DOC_SOURCE_DIR): use the new
4943 * gtkdoc-mkdb (MergeSourceDocumentation): accept parameters names in
4944 the source which use the wrong case, since there are quite a few of
4947 1999-01-25 Damon Chaplin <damon@karuna.freeserve.co.uk>
4949 * gtkdoc-mktmpl: parse G_GNUC_EXTENSION before typedef'ed types.
4951 * gtkdoc-mkdb: added support for specifying include files in the
4952 MODULE-sections.txt file, to be output at the top of the synopsis.
4954 * doc/sections-file.txt: added description of <INCLUDE> tag.
4956 * examples/gnomeui/gnomeui-sections.txt:
4957 * examples/gnome/gnome-sections.txt: added use of <INCLUDE>
4959 * examples/configure.in: changed 'gtk-reference' to
4960 'gnome-libs-reference'.
4962 1999-01-18 Damon Chaplin <damon@karuna.freeserve.co.uk>
4964 * README: updated my email address & noted that version 1.15+ of the
4965 DocBook modular stylesheets is needed (for $table-width$).
4967 * AUTHORS: updated my email address.
4969 1998-12-20 Jeff Garzik <jgarzik@pobox.com>
4971 * examples/gnomeui/gnomeui-docs.sgml,
4972 examples/gnomeui/gnomeui-sections.txt,
4973 examples/gnomeui/gnomeui.types:
4974 s/gtkspell/gnome-spell/g
4976 1998-12-16 Damon Chaplin <DAChaplin@msn.com>
4978 * gtkdoc-mkdb (ExpandAbbreviations): Allow -ve contants, e.g. %-1.
4979 (ScanSourceFile): Try to handle function descriptions that start
4980 with 'Returns'. It was assuming that they were describing the return
4982 Gets rid of 'Description:' which is sometimes included
4983 at the start of the function description in the source comment blocks.
4984 Makes sure newlines are preserved in the description, as consecutive
4985 newlines are converted to paragraph separators later.
4987 1998-12-15 Damon Chaplin <DAChaplin@msn.com>
4988 * Major changes to the scripts to merge in comments within source code
4989 * gtk-doc-fixxref added
4990 * examples directory added with an example for setting up modules to
4992 * documentation updated
4995 1998-11-28 Damon Chaplin <DAChaplin@msn.com>
5000 * gtkdoc-mkdb: Major changes to make it easy to update the docs
5001 when the API changes. It's pretty much all automatic now.
5002 Also added licenses and function comments, and added 'use strict'.
5003 The Gnome widgets should now be visible in the hierarchy.
5004 Removed a few 'mkdir's which I don't think are necessary now.
5006 Tue Nov 24 16:32:23 1998 Owen Taylor <otaylor@redhat.com>
5008 * README doc/authors.txt: Updated to describe the
5009 new generic scripts instead of the old ones hard-coded
5012 Tue Nov 24 01:06:17 1998 Owen Taylor <otaylor@redhat.com>
5014 * .cvsignore: Added .cvsignore
5016 Tue Nov 24 01:03:47 1998 Owen Taylor <otaylor@redhat.com>
5018 * autogen.sh configure.in: Minor touchups so the newly
5019 imported stuff autogen's correctly.