blob: 5631bf684f50d5938cd69c8c52c3bba04febde44 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
|
## Process this file with automake to produce Makefile.in
abs_top_builddir = @abs_top_builddir@
# We require automake 1.6 at least.
AUTOMAKE_OPTIONS = 1.6
# This is a blank Makefile.am for using gtk-doc.
# Copy this to your project's API docs directory and modify the variables to
# suit your project. See the GTK+ Makefiles in gtk+/docs/reference for examples
# of using the various options.
# The name of the module, e.g. 'glib'.
DOC_MODULE=telepathy-glib
# The top-level SGML file. You can change this if you want to.
DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
# The directory containing the source code. Relative to $(srcdir).
# gtk-doc will search all .c & .h files beneath here for inline comments
# documenting the functions and macros.
# e.g. DOC_SOURCE_DIR=../../../gtk
DOC_SOURCE_DIR=../../telepathy-glib
# Extra options to pass to gtkdoc-scangobj. Not normally needed.
SCANGOBJ_OPTIONS=
# Extra options to supply to gtkdoc-scan.
# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED"
SCAN_OPTIONS=\
--deprecated-guards=TP_DISABLE_DEPRECATED \
--ignore-decorators=_TP_GNUC_DEPRECATED \
--rebuild-types
# Extra options to supply to gtkdoc-mkdb.
# e.g. MKDB_OPTIONS=--sgml-mode --output-format=xml
MKDB_OPTIONS=--sgml-mode --output-format=xml
# If _gen is a subdirectory of $(top_srcdir)/telepathy-glib then we
# already get it scanned by virtue of setting DOC_SOURCE_DIR. If
# it's not a subdirectory, we'll have to add a second --source-dir
# so both get scanned (we want the declarations and doc-comments in
# the generated source to take effect).
if OUT_OF_TREE_BUILD
SCAN_OPTIONS += --source-dir=$(abs_top_builddir)/telepathy-glib/_gen
MKDB_OPTIONS += --source-dir=$(abs_top_builddir)/telepathy-glib/_gen
endif
# Extra options to supply to gtkdoc-mktmpl
# e.g. MKTMPL_OPTIONS=--only-section-tmpl
MKTMPL_OPTIONS=
# Extra options to supply to gtkdoc-fixref. Not normally needed.
# e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html
FIXXREF_OPTIONS=
# Used for dependencies. The docs will be rebuilt if any of these change.
# e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h
# e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c
HFILE_GLOB=$(top_srcdir)/telepathy-glib/*.h $(top_builddir)/telepathy-glib/_gen/*.h
CFILE_GLOB=$(top_srcdir)/telepathy-glib/*.c $(top_builddir)/telepathy-glib/_gen/*.c
# Header files to ignore when scanning.
# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
IGNORE_HFILES=\
add-dispatch-operation-context-internal.h \
account-channel-request-internal.h \
base-connection-internal.h \
base-contact-list-internal.h \
channel-dispatch-operation-internal.h \
client-message-internal.h \
base-protocol-internal.h \
channel-internal.h \
cm-message-internal.h \
connection-internal.h \
contact-internal.h \
contact-list-channel-internal.h \
debug-internal.h \
handle-channels-context-internal.h \
handle-repo-internal.h \
message-internal.h \
observe-channels-context-internal.h \
protocol-internal.h \
proxy-internal.h \
proxy-introspectable.h \
signalled-message-internal.h \
util-internal.h
# Images to copy into HTML directory.
# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
HTML_IMAGES=
# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
# e.g. content_files=running.sgml building.sgml changes-2.0.sgml
content_files=tp-svc.xml
html-build.stamp: $(srcdir)/version.xml
pdf-build.stamp: $(srcdir)/version.xml
$(srcdir)/version.xml: Makefile
@-chmod u+w $(srcdir) $(srcdir)/version.xml
echo @PACKAGE_VERSION@ > $(srcdir)/version.xml
# SGML files where gtk-doc abbrevations (#GtkWidget) are expanded
# These files must be listed here *and* in content_files
# e.g. expand_content_files=running.sgml
expand_content_files=
# CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library.
# Only needed if you are using gtkdoc-scangobj to dynamically query widget
# signals and properties.
# e.g. INCLUDES=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
INCLUDES=-I$(top_srcdir) -I$(top_builddir) \
@DBUS_CFLAGS@ @GLIB_CFLAGS@
GTKDOC_LIBS=$(top_builddir)/telepathy-glib/libtelepathy-glib.la \
@DBUS_LIBS@ @GLIB_LIBS@
# This includes the standard gtk-doc make rules, copied by gtkdocize.
include $(top_srcdir)/gtk-doc.make
if ENABLE_GTK_DOC
check-local:
@err=0; \
if grep '^0 symbols incomplete' \
$(srcdir)/telepathy-glib-undocumented.txt; then\
:; \
else \
cat $(srcdir)/telepathy-glib-undocumented.txt; \
err=1; \
fi; \
if grep '^0 not documented' \
$(srcdir)/telepathy-glib-undocumented.txt; then\
:; \
else \
cat $(srcdir)/telepathy-glib-undocumented.txt; \
err=1; \
fi; \
if grep . $(srcdir)/telepathy-glib-unused.txt; then\
echo "^^^ Unused symbols" >&2; \
err=1; \
fi; \
if test -e $(srcdir)/telepathy-glib-undeclared.txt &&\
grep . $(srcdir)/telepathy-glib-undeclared.txt; then\
echo "^^^ Undeclared symbols" >&2; \
err=1; \
fi; \
sed -n -e 's,<FILE>\(.*\)</FILE>,\1,p' $(srcdir)/telepathy-glib-sections.txt |\
while read file; do \
if grep -F "xml/$$file.xml" $(srcdir)/telepathy-glib-docs.sgml \
>/dev/null;\
then \
:; \
else \
echo "$$file missing from telepathy-glib-docs.sgml"; \
err=1; \
fi; \
done; \
case @ENABLE_DOC_CHECKS@/$$err in \
(yes/1) \
echo "Documentation check failed" >&2; \
exit $$err; \
;; \
(*) \
exit 0; \
;; \
esac
endif
|
