1 GST_DOC_SCANOBJ = $(top_srcdir)/common/gstdoc-scangobj
3 ## Process this file with automake to produce Makefile.in
5 # The name of the module, e.g. 'glib'.
6 #DOC_MODULE=gst-plugins-libs-@GST_MAJORMINOR@
8 DOC_MODULE=$(MODULE)-plugins
13 html: html-build.stamp
14 include $(top_srcdir)/common/upload-doc.mak
16 # Extra environment needed for Core only...
17 INSPECT_EXTRA_ENVIRONMENT= \
18 GST_PLUGIN_SCANNER=$(top_builddir)/libs/gst/helpers/gst-plugin-scanner
22 ## $(DOC_MODULE).types \
23 # $(DOC_MODULE)-sections.txt \
24 # $(DOC_MODULE)-docs.sgml
26 # ugly hack to make -unused.sgml work
29 # cd $(srcdir)/tmpl && \
30 # ln -sf gstreamer-libs-unused.sgml \
31 # $$BUILDDIR/tmpl/gstreamer-libs-@GST_MAJORMINOR@-unused.sgml
32 # touch unused-build.stamp
34 # these rules are added to create parallel docs using GST_MAJORMINOR
35 #$(basefiles): gstreamer-libs-@GST_MAJORMINOR@%: gstreamer-libs%
38 #CLEANFILES = $(basefiles)
40 # The top-level SGML file. Change it if you want.
41 DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
43 # The directory containing the source code. Relative to $(top_srcdir).
44 # gtk-doc will search all .c & .h files beneath here for inline comments
45 # documenting functions and macros.
46 DOC_SOURCE_DIR = $(top_srcdir)/plugins
48 # Extra options to supply to gtkdoc-scan.
51 # Extra options to supply to gtkdoc-mkdb.
52 MKDB_OPTIONS=--sgml-mode
54 # Extra options to supply to gtkdoc-fixref.
55 FIXXREF_OPTIONS=--extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html \
56 --extra-dir=$(datadir)/gtk-doc/html
58 # Used for dependencies.
59 HFILE_GLOB=$(DOC_SOURCE_DIR)/*/*.h
60 CFILE_GLOB=$(DOC_SOURCE_DIR)/*/*.c
62 # this is a wingo addition
63 # thomasvs: another nice wingo addition would be an explanation on why
68 # Header files to ignore when scanning.
72 # we add all .h files of elements that have signals/args we want
73 # sadly this also pulls in the private methods - maybe we should
74 # move those around in the source ?
75 # also, we should add some stuff here conditionally based on whether
76 # or not the plugin will actually build
77 # but I'm not sure about that - it might be this Just Works given that
78 # the registry won't have the element
81 $(top_srcdir)/plugins/elements/gstcapsfilter.h \
82 $(top_srcdir)/plugins/elements/gstfakesrc.h \
83 $(top_srcdir)/plugins/elements/gstfakesink.h \
84 $(top_srcdir)/plugins/elements/gstfdsink.h \
85 $(top_srcdir)/plugins/elements/gstfdsrc.h \
86 $(top_srcdir)/plugins/elements/gstfilesrc.h \
87 $(top_srcdir)/plugins/elements/gstfilesink.h \
88 $(top_srcdir)/plugins/elements/gstidentity.h \
89 $(top_srcdir)/plugins/elements/gstmultiqueue.h \
90 $(top_srcdir)/plugins/elements/gstqueue.h \
91 $(top_srcdir)/plugins/elements/gstqueue2.h \
92 $(top_srcdir)/plugins/elements/gsttypefindelement.h \
93 $(top_srcdir)/plugins/elements/gsttee.h \
94 $(top_srcdir)/plugins/elements/gstvalve.h
96 # Images to copy into HTML directory.
99 # Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
102 # Other files to distribute.
105 # CFLAGS and LDFLAGS for compiling scan program. Only needed if your app/lib
106 # contains GtkObjects/GObjects and you want to document signals and properties.
107 GTKDOC_CFLAGS = $(GST_OBJ_CFLAGS) -I$(top_builddir) -I$(top_builddir)/libs
108 GTKDOC_LIBS = $(SCANOBJ_DEPS) $(GST_OBJ_LIBS)
110 GTKDOC_CC=$(LIBTOOL) --tag=CC --mode=compile $(CC)
111 GTKDOC_LD=$(LIBTOOL) --tag=CC --mode=link $(CC)
113 # If you need to override some of the declarations, place them in this file
114 # and uncomment this line.
115 #DOC_OVERRIDES = $(DOC_MODULE)-overrides.txt
118 include $(top_srcdir)/common/gtk-doc-plugins.mak