092d75ec874b1781f84c14d2b4054e418d01e7e1
1 ## Process this file with automake to produce Makefile.in
3 # The name of the module, e.g. 'glib'.
4 #DOC_MODULE=gstreamer-libs-@GST_MAJORMINOR@
5 DOC_MODULE=gstreamer-libs
7 # don't want $(DOC_MODULE)-scan.c to be built with -Werror
8 ERROR_CFLAGS=
10 # for upload-doc.mak
11 DOC=gstreamer-libs
12 FORMATS=html
13 html: html-build.stamp
14 include $(top_srcdir)/common/upload-doc.mak
16 # generated basefiles
17 #basefiles = \
18 # $(DOC_MODULE).types \
19 # $(DOC_MODULE)-sections.txt \
20 # $(DOC_MODULE)-docs.sgml
22 # ugly hack to make -unused.sgml work
23 #unused-build.stamp:
24 # BUILDDIR=`pwd` && \
25 # cd $(srcdir)/tmpl && \
26 # ln -sf gstreamer-libs-unused.sgml \
27 # $$BUILDDIR/tmpl/gstreamer-libs-@GST_MAJORMINOR@-unused.sgml
28 # touch unused-build.stamp
30 # these rules are added to create parallel docs using GST_MAJORMINOR
31 #$(basefiles): gstreamer-libs-@GST_MAJORMINOR@%: gstreamer-libs%
32 # cp $< $@
34 #CLEANFILES = $(basefiles)
36 # The top-level SGML file. Change it if you want.
37 DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
39 # The directory containing the source code. Relative to $(top_srcdir).
40 # gtk-doc will search all .c & .h files beneath here for inline comments
41 # documenting functions and macros.
42 DOC_SOURCE_DIR=$(top_srcdir)/libs/gst
43 DOC_BUILD_DIR=$(top_builddir)/libs/gst
45 # Extra options to supply to gtkdoc-scan.
46 SCAN_OPTIONS=--deprecated-guards="GST_DISABLE_DEPRECATED"
48 # FIXME :
49 # there's something wrong with gstreamer-sections.txt not being in the dist
50 # maybe it doesn't resolve; we're adding it below for now
51 #EXTRA_DIST = gstreamer.types.in gstreamer.hierarchy $(DOC_MODULE)-sections.txt gstreamer-sections.txt $(DOC_MAIN_SGML_FILE)
53 # Extra options to supply to gtkdoc-mkdb.
54 MKDB_OPTIONS=--sgml-mode --output-format=xml
56 # Extra options to supply to gtkdoc-fixref.
57 FIXXREF_OPTIONS=--extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html \
58 --extra-dir=$(datadir)/gtk-doc/html
60 # Used for dependencies.
61 HFILE_GLOB=$(DOC_SOURCE_DIR)/*/*.h
62 CFILE_GLOB=$(DOC_SOURCE_DIR)/*/*.c
64 # Dependencies for the intermediate scanobj tool
65 SCANOBJ_DEPS = \
66 $(top_builddir)/libs/gst/controller/libgstcontroller-@GST_MAJORMINOR@.la \
67 $(top_builddir)/libs/gst/base/libgstbase-@GST_MAJORMINOR@.la \
68 $(top_builddir)/libs/gst/net/libgstnet-@GST_MAJORMINOR@.la
70 # Extra options to pass to gtkdoc-scanobj or gtkdoc-scangobj.
71 SCANOBJ_OPTIONS=--type-init-func="g_type_init();gst_init(&argc,&argv)"
73 # Header files to ignore when scanning.
74 IGNORE_HFILES = \
75 gstinterpolationcontrolsourceprivate.h \
76 gstlfocontrolsourceprivate.h \
77 gstcontrollerprivate.h \
78 gstgetbits_inl.h \
79 dp-private.h
81 # Images to copy into HTML directory.
82 HTML_IMAGES = gdp-header.png
84 # Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
85 content_files =
87 # Other files to distribute.
88 extra_files =
90 # CFLAGS and LDFLAGS for compiling scan program. Only needed if your app/lib
91 # contains GtkObjects/GObjects and you want to document signals and properties.
92 GTKDOC_CFLAGS = -I$(top_builddir) -I$(top_builddir)/libs $(GST_OBJ_CFLAGS)
93 GTKDOC_LIBS = $(SCANOBJ_DEPS) $(GST_OBJ_LIBS)
95 GTKDOC_CC=$(LIBTOOL) --tag=CC --mode=compile $(CC)
96 GTKDOC_LD=$(LIBTOOL) --tag=CC --mode=link $(CC)
98 GTKDOC_EXTRA_ENVIRONMENT= \
99 GST_PLUGIN_SCANNER=$(top_builddir)/libs/gst/helpers/plugin-scanner
101 # If you need to override some of the declarations, place them in this file
102 # and uncomment this line.
103 DOC_OVERRIDES = $(DOC_MODULE)-overrides.txt
105 include $(top_srcdir)/common/gtk-doc.mak