Skip to content

Commit c1a145b

Browse files
committed
Update to latest gtk-doc
Update autotools to run gtkdocize and various other updates for the latest gtk-doc
1 parent c5502ce commit c1a145b

24 files changed

Lines changed: 124 additions & 47 deletions

autogen.sh

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,7 @@ $ACLOCAL $ACLOCAL_FLAGS || exit $?
8282
autoconf || exit $?
8383
autoheader || exit $?
8484
$AUTOMAKE --add-missing || exit $?
85+
gtkdocize || exit $?
8586

8687
cd $ORIGDIR || exit $?
8788

configure.in

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -75,8 +75,8 @@ dnl Check for headers (Mac OSX often doesn't have them)
7575
AC_CHECK_HEADERS([getopt.h wchar.h iconv.h])
7676

7777

78-
GTK_DOC_CHECK([1.0])
79-
78+
GTK_DOC_CHECK([1.14],[--flavour no-tmpl])
79+
AC_CONFIG_MACRO_DIR(m4)
8080

8181
dnl ---------------------------------------------------------------------------
8282
dnl Warnings

docs/reference/Makefile.am

Lines changed: 94 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,48 +1,120 @@
1-
## Process this file with automake to produce Makefile.in
1+
# -*- mode: makefile -*-
2+
#
3+
# Makefile.am - template makefile for gtk-doc module
4+
# Copyright (C) 2007-2017 Stefan Sauer
5+
#
6+
# This program is free software: you can redistribute it and/or modify
7+
# it under the terms of the GNU General Public License as published by
8+
# the Free Software Foundation, either version 3 of the License, or
9+
# (at your option) any later version.
10+
#
11+
# This program is distributed in the hope that it will be useful,
12+
# but WITHOUT ANY WARRANTY; without even the implied warranty of
13+
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14+
# GNU General Public License for more details.
15+
#
16+
# You should have received a copy of the GNU General Public License
17+
# along with this program. If not, see <http://www.gnu.org/licenses/>.
18+
#
19+
# As a special exception, the above copyright owner gives unlimited
20+
# permission to copy, distribute and modify this Makefile.am template.
21+
# You need not follow the terms of the GNU General Public License when
22+
# using or distributing such Makefile.am files, even though portions of
23+
# the text of the Makefile.am appear in them. The GNU General Public
24+
# License (GPL) does govern all other use of the material that constitutes
25+
# the Makefile.am template.
26+
27+
# This is a blank Makefile.am for using gtk-doc.
28+
# Copy this to your project's API docs directory and modify the variables to
29+
# suit your project. See the GTK+ Makefiles in gtk+/docs/reference for examples
30+
# of using the various options.
231

332
# The name of the module, e.g. 'glib'.
433
DOC_MODULE=libiptcdata
534

6-
# The top-level SGML file. Change it if you want.
7-
DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
35+
# Uncomment for versioned docs and specify the version of the module, e.g. '2'.
36+
#DOC_MODULE_VERSION=2
37+
38+
# The top-level XML file.
39+
DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.xml
840

9-
# The directory containing the source code. Relative to $(srcdir).
10-
# gtk-doc will search all .c & .h files beneath here for inline comments
11-
# documenting functions and macros.
41+
# Directories containing the source code.
42+
# gtk-doc will search all .c and .h files beneath these paths
43+
# for inline comments documenting functions and macros.
44+
# e.g. DOC_SOURCE_DIR=$(top_srcdir)/gtk $(top_srcdir)/gdk
1245
DOC_SOURCE_DIR=../../libiptcdata
1346

14-
# Extra options to pass to gtkdoc-scanobj or gtkdoc-scangobj.
15-
SCANOBJ_OPTIONS=
47+
# Extra options to pass to gtkdoc-scangobj. Normally not needed.
48+
SCANGOBJ_OPTIONS=
1649

1750
# Extra options to supply to gtkdoc-scan.
51+
# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED"
1852
SCAN_OPTIONS=
1953

20-
# Extra options to supply to gtkdoc-mkdb.
21-
MKDB_OPTIONS= --sgml-mode --output-format=xml
54+
# Extra options to supply to gtkdoc-mkdb
55+
# e.g. MKDB_OPTIONS=--xml-mode --output-format=xml
56+
MKDB_OPTIONS=--xml-mode --output-format=xml
2257

23-
# Extra options to supply to gtkdoc-fixref.
58+
# Extra options to supply to gtkdoc-mkhtml
59+
MKHTML_OPTIONS=
60+
61+
# Extra options to supply to gtkdoc-fixref. Normally not needed.
62+
# e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html
2463
FIXXREF_OPTIONS=
2564

26-
# Used for dependencies.
65+
# Used for dependencies. The docs will be rebuilt if any of these change.
66+
# e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h
67+
# e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c
2768
HFILE_GLOB=
2869
CFILE_GLOB=
2970

30-
# Header files to ignore when scanning.
31-
IGNORE_HFILES= i18n.h
71+
# Extra header to include when scanning, which are not under DOC_SOURCE_DIR
72+
# e.g. EXTRA_HFILES=$(top_srcdir}/contrib/extra.h
73+
EXTRA_HFILES=
74+
75+
# Header files or dirs to ignore when scanning. Use base file/dir names
76+
# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h private_code
77+
IGNORE_HFILES=
3278

3379
# Images to copy into HTML directory.
34-
HTML_IMAGES =
80+
# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
81+
HTML_IMAGES=
3582

36-
# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
37-
content_files = \
83+
# Extra files that are included by $(DOC_MAIN_SGML_FILE).
84+
# e.g. content_files=running.xml building.xml changes-2.0.xml
85+
content_files= \
3886
version.xml \
39-
about.sgml \
40-
commandline.sgml \
41-
i18n.sgml \
42-
libjpeg.sgml \
43-
overview.sgml
87+
about.xml \
88+
commandline.xml \
89+
i18n.xml \
90+
libjpeg.xml \
91+
overview.xml
4492

93+
# Files where gtk-doc abbrevations (#GtkWidget) are expanded
94+
# e.g. expand_content_files=running.xml
95+
expand_content_files=
96+
97+
# CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library.
98+
# Only needed if you are using gtkdoc-scangobj to dynamically query widget
99+
# signals and properties.
100+
# e.g. GTKDOC_CFLAGS=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
101+
# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
102+
GTKDOC_CFLAGS=
103+
GTKDOC_LIBS=
104+
105+
# This includes the standard gtk-doc make rules, copied by gtkdocize.
45106
include $(top_srcdir)/gtk-doc.make
46107

108+
# Comment this out if you don't want 'make check' to test you doc status
109+
# and run some sanity checks
110+
if ENABLE_GTK_DOC
111+
TESTS_ENVIRONMENT = \
112+
DOC_MODULE=$(DOC_MODULE) DOC_MAIN_SGML_FILE=$(DOC_MAIN_SGML_FILE) \
113+
SRCDIR=$(abs_srcdir) BUILDDIR=$(abs_builddir)
114+
TESTS = $(GTKDOC_CHECK)
115+
endif
116+
47117
EXTRA_DIST += \
48118
version.xml.in
119+
120+
-include $(top_srcdir)/git.mk
Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
<?xml version="1.0"?>
22
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
33
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
4-
<!ENTITY iptc-overview SYSTEM "overview.sgml">
5-
<!ENTITY iptc-about SYSTEM "about.sgml">
6-
<!ENTITY iptc-commandline SYSTEM "commandline.sgml">
7-
<!ENTITY iptc-i18n SYSTEM "i18n.sgml">
8-
<!ENTITY iptc-libjpeg SYSTEM "libjpeg.sgml">
4+
<!ENTITY iptc-overview SYSTEM "overview.xml">
5+
<!ENTITY iptc-about SYSTEM "about.xml">
6+
<!ENTITY iptc-commandline SYSTEM "commandline.xml">
7+
<!ENTITY iptc-i18n SYSTEM "i18n.xml">
8+
<!ENTITY iptc-libjpeg SYSTEM "libjpeg.xml">
99
<!ENTITY version SYSTEM "version.xml">
1010
]>
1111
<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
<refpurpose>an example of using libiptcdata together with libjpeg</refpurpose>
1111
</refnamediv>
1212

13-
<refsect1 id="i18n">
13+
<refsect1 id="jpeg-reading">
1414
<title>Reading IPTC data from a file parsed with libjpeg</title>
1515

1616
<para>

libiptcdata/i18n.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
/* i18n.h
22
*
3-
* Copyright © 2001 David Moore <dcm@acm.org>
3+
* Copyright (c) 2001 David Moore <dcm@acm.org>
44
*
55
* This library is free software; you can redistribute it and/or
66
* modify it under the terms of the GNU Lesser General Public

0 commit comments

Comments
 (0)