Imported Upstream version 0.1.17
[platform/upstream/libnice.git] / docs / reference / libnice / Makefile.am
1 ## Process this file with automake to produce Makefile.in
2
3 # We require automake 1.6 at least.
4 AUTOMAKE_OPTIONS = 1.6
5
6 # The name of the module, e.g. 'glib'.
7 DOC_MODULE=libnice
8
9 # The top-level SGML file. You can change this if you want to.
10 DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.xml
11
12 # The directory containing the source code. Relative to $(srcdir).
13 # gtk-doc will search all .c & .h files beneath here for inline comments
14 # documenting the functions and macros.
15 # e.g. DOC_SOURCE_DIR=../../../gtk
16 DOC_SOURCE_DIR=$(top_srcdir)/agent $(top_srcdir)/stun
17
18 # Extra options to pass to gtkdoc-scangobj. Not normally needed.
19 SCANGOBJ_OPTIONS=
20
21 # Extra options to supply to gtkdoc-scan.
22 # e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED"
23 SCAN_OPTIONS=--rebuild-types
24
25 # Extra options to supply to gtkdoc-mkdb.
26 # e.g. MKDB_OPTIONS=--sgml-mode --output-format=xml
27 MKDB_OPTIONS=--xml-mode --output-format=xml --name-space=Nice
28
29 # Extra options to supply to gtkdoc-mktmpl
30 # e.g. MKTMPL_OPTIONS=--only-section-tmpl
31 MKTMPL_OPTIONS=
32
33 # Extra options to supply to gtkdoc-fixref. Not normally needed.
34 # e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html
35 FIXXREF_OPTIONS=
36
37 # Used for dependencies. The docs will be rebuilt if any of these change.
38 # e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h
39 # e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c
40 HFILE_GLOB=$(top_srcdir)/agent/agent.h $(top_srcdir)/agent/address.h \
41         $(top_srcdir)/agent/debug.h $(top_srcdir)/agent/candidate.h \
42         $(top_srcdir)/agent/interfaces.h \
43         $(top_srcdir)/agent/pseudotcp.h \
44         $(top_srcdir)/stun/stunagent.h  \
45         $(top_srcdir)/stun/stunmessage.h \
46         $(top_srcdir)/stun/debug.h \
47         $(top_srcdir)/stun/usages/bind.h \
48         $(top_srcdir)/stun/usages/ice.h \
49         $(top_srcdir)/stun/usages/timer.h \
50         $(top_srcdir)/stun/usages/turn.h
51
52 CFILE_GLOB=$(top_srcdir)/agent/agent.c \
53         $(top_srcdir)/agent/pseudotcp.c
54
55 # Header files to ignore when scanning.
56 # e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
57 IGNORE_HFILES= conncheck.h discovery.h stream.h component.h agent-priv.h \
58         iostream.h inputstream.h outputstream.h \
59         gstnice.h gstnicesrc.h gstnicesink.h  \
60         md5.h sha1.h stunhmac.h utils.h rand.h stun5389.h stuncrc32.h \
61         stund.h agent-signals-marshal.h win32_common.h
62
63 # Images to copy into HTML directory.
64 # e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
65 HTML_IMAGES = states.png
66
67 # Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
68 # e.g. content_files=running.sgml building.sgml changes-2.0.sgml
69 content_files=
70
71 # SGML files where gtk-doc abbrevations (#GtkWidget) are expanded
72 # These files must be listed here *and* in content_files
73 # e.g. expand_content_files=running.sgml
74 expand_content_files=
75
76 # CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library.
77 # Only needed if you are using gtkdoc-scangobj to dynamically query widget
78 # signals and properties.
79 # e.g. INCLUDES=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
80 # e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
81 AM_CFLAGS =  $(LIBNICE_CFLAGS) \
82         $(GLIB_CFLAGS) \
83         -I $(top_srcdir) \
84         -I $(top_srcdir)/random \
85         -I $(top_srcdir)/socket \
86         -I $(top_srcdir)/stun
87
88 GTKDOC_LIBS= $(top_builddir)/agent/libagent.la $(GLIB_LIBS) $(top_builddir)/stun/libstun.la \
89          $(GUPNP_LIBS)
90
91
92 # This includes the standard gtk-doc make rules, copied by gtkdocize.
93 include $(top_srcdir)/gtk-doc.make
94
95 # Other files to distribute
96 # e.g. EXTRA_DIST += version.xml.in
97 EXTRA_DIST += states.gv
98
99 EXTRA_DIST += meson.build
100
101 # Files not to distribute
102 # for --rebuild-types in $(SCAN_OPTIONS), e.g. $(DOC_MODULE).types
103 # for --rebuild-sections in $(SCAN_OPTIONS) e.g. $(DOC_MODULE)-sections.txt
104 #DISTCLEANFILES +=
105
106 # If we ever need to regenerate this diagram.
107 # Since it’s not expected to change much, let’s not depend on GraphViz to
108 # build the docs.
109 states.png: states.gv
110         dot -Tpng -Gsize=9.6,2.9\! -Gdpi=200 $^ > $@
111
112 if ENABLE_GTK_DOC
113 TESTS_ENVIRONMENT = \
114   DOC_MODULE=$(DOC_MODULE) DOC_MAIN_SGML_FILE=$(DOC_MAIN_SGML_FILE) \
115   SRCDIR=$(abs_srcdir) BUILDDIR=$(abs_builddir)
116 TESTS = $(GTKDOC_CHECK)
117 endif