summaryrefslogtreecommitdiff
path: root/docs/libnm/Makefile.am
blob: 3de6976b70fc4ef567c5fdd62970a5f45e26b8b2 (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
## Process this file with automake to produce Makefile.in
AUTOMAKE_OPTIONS = 1.6

check_local =

# The name of the module
DOC_MODULE=libnm

# The top-level SGML file.
DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.xml

# The directory containing the source code. Relative to $(srcdir).
# gtk-doc will search all .c & .h files beneath here for inline comments
# documenting functions and macros.
DOC_SOURCE_DIR= \
	$(top_builddir)/src/libnm-core-public \
	$(top_srcdir)/src/libnm-core-public \
	$(top_builddir)/src/libnm-core-impl \
	$(top_srcdir)/src/libnm-core-impl \
	$(top_srcdir)/src/libnm-client-public \
	$(top_builddir)/src/libnm-client-public \
	$(top_srcdir)/src/libnm-client-impl \
	$(top_builddir)/src/libnm-client-impl \
	$(NULL)

# Extra options to supply to gtkdoc-scan.
SCAN_OPTIONS=--rebuild-types --rebuild-sections --ignore-decorators="NM_AVAILABLE_IN_\d_\d\d?|NM_DEPRECATED_IN_\d_\d\d?"

# Extra options to supply to gtkdoc-mkdb.
MKDB_OPTIONS=--sgml-mode --output-format=xml

# Extra options to supply to gtkdoc-fixref.
FIXXREF_OPTIONS=

# Used for dependencies.
HFILE_GLOB=$(top_srcdir)/src/libnm-core-public/*.h $(top_srcdir)/src/libnm-client-public/*.h
CFILE_GLOB=$(top_srcdir)/src/libnm-core-impl/*.c $(top_srcdir)/src/libnm-client-impl/*.c

# Header files to ignore when scanning.
IGNORE_HFILES= \
	common.h \
	nm-core-internal.h \
	nm-core-tests-enum-types.h \
	nm-core-types-internal.h \
	nm-crypto-impl.h \
	nm-crypto.h \
	nm-dbus-helpers.h \
	nm-default-libnm-core.h \
	nm-device-private.h \
	nm-dhcp4-config.h \
	nm-dhcp6-config.h \
	nm-dns-manager.h \
	nm-ip4-config.h \
	nm-ip6-config.h \
	nm-manager.h \
	nm-object-private.h \
	nm-property-compare.h \
	nm-remote-connection-private.h \
	nm-setting-private.h \
	nm-utils-private.h \
	\
	test-general-enums.h \
	\
	nm-keyfile-internal.h \
	nm-keyfile-utils.h \
	\
	nm-auth-subject.h \
	nm-common-macros.h \
	nm-ethtool-base.h \
	nm-libnm-core-utils.h \
	\
	nm-dispatcher-api.h \
	nm-libnm-core-aux.h \
	\
	nm-libnm-aux.h \
	\
	$(NULL)

# Images to copy into HTML directory.
HTML_IMAGES = libnm.png

# Extra XML files that are included by $(DOC_MAIN_SGML_FILE).
content_files = version.xml

# Other files to distribute.
extra_files = libnm.png


# CFLAGS and LDFLAGS for compiling scan program. Only needed
# if $(DOC_MODULE).types is non-empty.
GTKDOC_CFLAGS = \
	-I$(top_builddir)/src/libnm-core-public \
	-I$(top_srcdir)/src/libnm-core-public \
	-I$(top_srcdir)/src/libnm-client-public \
	-I$(top_builddir)/src/libnm-client-public \
	-DNM_VERSION_MIN_REQUIRED=NM_VERSION_0_9_8 \
	$(GLIB_CFLAGS) \
	$(SANITIZER_EXEC_CFLAGS)

GTKDOC_LIBS = \
	$(top_builddir)/src/libnm-client-impl/libnm.la \
	$(GLIB_LIBS) \
	$(SANITIZER_EXEC_LDFLAGS)


# include common portion ...
include $(top_srcdir)/gtk-doc.make

EXTRA_DIST += \
	version.xml.in \
	meson.build \
	$(NULL)

CLEANFILES += \
	html/* \
	tmpl/* \
	xml/* \
	libnm-overrides.txt \
	libnm-sections.txt \
	libnm.actions \
	$(NULL)

if GTK_DOC_BUILD_HTML
check-local-gtk-doc-patch:
	@if grep -q -F '<a href="libnm-nm-setting-user.html">nm-setting-user</a>' "$(top_builddir)/docs/libnm/html/index.html"; then \
		echo "WARNING: The generated documentation has issues. Patch your gtk-doc (see https://gitlab.gnome.org/GNOME/gtk-doc/merge_requests/2). Let this check fail with NMTST_CHECK_GTK_DOC=1"; \
		test "$$NMTST_CHECK_GTK_DOC" != 1; \
	fi
check_local += check-local-gtk-doc-patch
endif

check-local: $(check_local)