2005-12-01 12:29:34 +00:00
|
|
|
GST_DOC_SCANOBJ = $(top_srcdir)/common/gstdoc-scangobj
|
|
|
|
|
|
|
|
|
|
## Process this file with automake to produce Makefile.in
|
|
|
|
|
|
|
|
|
|
# The name of the module, e.g. 'glib'.
|
|
|
|
|
#DOC_MODULE=gst-plugins-libs-@GST_MAJORMINOR@
|
|
|
|
|
MODULE=gstreamer
|
|
|
|
|
DOC_MODULE=$(MODULE)-plugins
|
|
|
|
|
|
2009-06-11 12:16:29 +00:00
|
|
|
# for upload-doc.mak
|
2005-12-01 12:29:34 +00:00
|
|
|
DOC=$(MODULE)-plugins
|
|
|
|
|
FORMATS=html
|
|
|
|
|
html: html-build.stamp
|
2009-06-11 12:16:29 +00:00
|
|
|
include $(top_srcdir)/common/upload-doc.mak
|
2005-12-01 12:29:34 +00:00
|
|
|
|
2009-10-08 10:17:14 +00:00
|
|
|
# Extra environment needed for Core only...
|
|
|
|
|
INSPECT_EXTRA_ENVIRONMENT= \
|
|
|
|
|
GST_PLUGIN_SCANNER=$(top_builddir)/libs/gst/helpers/plugin-scanner
|
|
|
|
|
|
2005-12-01 12:29:34 +00:00
|
|
|
# generated basefiles
|
|
|
|
|
#basefiles = \
|
|
|
|
|
## $(DOC_MODULE).types \
|
|
|
|
|
# $(DOC_MODULE)-sections.txt \
|
|
|
|
|
# $(DOC_MODULE)-docs.sgml
|
|
|
|
|
|
|
|
|
|
# ugly hack to make -unused.sgml work
|
|
|
|
|
#unused-build.stamp:
|
|
|
|
|
# BUILDDIR=`pwd` && \
|
|
|
|
|
# cd $(srcdir)/tmpl && \
|
|
|
|
|
# ln -sf gstreamer-libs-unused.sgml \
|
|
|
|
|
# $$BUILDDIR/tmpl/gstreamer-libs-@GST_MAJORMINOR@-unused.sgml
|
|
|
|
|
# touch unused-build.stamp
|
|
|
|
|
|
|
|
|
|
# these rules are added to create parallel docs using GST_MAJORMINOR
|
|
|
|
|
#$(basefiles): gstreamer-libs-@GST_MAJORMINOR@%: gstreamer-libs%
|
|
|
|
|
# cp $< $@
|
|
|
|
|
|
|
|
|
|
#CLEANFILES = $(basefiles)
|
|
|
|
|
|
|
|
|
|
# The top-level SGML file. Change it if you want.
|
|
|
|
|
DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
|
|
|
|
|
|
|
|
|
|
# The directory containing the source code. Relative to $(top_srcdir).
|
|
|
|
|
# gtk-doc will search all .c & .h files beneath here for inline comments
|
|
|
|
|
# documenting functions and macros.
|
|
|
|
|
DOC_SOURCE_DIR = $(top_srcdir)/plugins
|
|
|
|
|
|
|
|
|
|
# Extra options to supply to gtkdoc-scan.
|
|
|
|
|
SCAN_OPTIONS=
|
|
|
|
|
|
|
|
|
|
# Extra options to supply to gtkdoc-mkdb.
|
|
|
|
|
MKDB_OPTIONS=--sgml-mode
|
|
|
|
|
|
|
|
|
|
# Extra options to supply to gtkdoc-fixref.
|
2007-07-05 08:42:42 +00:00
|
|
|
FIXXREF_OPTIONS=--extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html \
|
|
|
|
|
--extra-dir=$(datadir)/gtk-doc/html
|
2005-12-01 12:29:34 +00:00
|
|
|
|
|
|
|
|
# Used for dependencies.
|
|
|
|
|
HFILE_GLOB=$(DOC_SOURCE_DIR)/*/*.h
|
|
|
|
|
CFILE_GLOB=$(DOC_SOURCE_DIR)/*/*.c
|
|
|
|
|
|
|
|
|
|
# this is a wingo addition
|
|
|
|
|
# thomasvs: another nice wingo addition would be an explanation on why
|
|
|
|
|
# this is useful ;)
|
|
|
|
|
|
|
|
|
|
SCANOBJ_DEPS =
|
|
|
|
|
|
|
|
|
|
# Header files to ignore when scanning.
|
|
|
|
|
IGNORE_HFILES =
|
|
|
|
|
IGNORE_CFILES =
|
|
|
|
|
|
|
|
|
|
# we add all .h files of elements that have signals/args we want
|
|
|
|
|
# sadly this also pulls in the private methods - maybe we should
|
|
|
|
|
# move those around in the source ?
|
|
|
|
|
# also, we should add some stuff here conditionally based on whether
|
|
|
|
|
# or not the plugin will actually build
|
|
|
|
|
# but I'm not sure about that - it might be this Just Works given that
|
|
|
|
|
# the registry won't have the element
|
|
|
|
|
|
|
|
|
|
EXTRA_HFILES = \
|
docs/: Correct fixxrefs options.
Original commit message from CVS:
* docs/gst/Makefile.am:
* docs/libs/Makefile.am:
Correct fixxrefs options.
* docs/plugins/Makefile.am:
* docs/plugins/gstreamer-plugins-docs.sgml:
* docs/plugins/gstreamer-plugins-sections.txt:
* plugins/elements/Makefile.am:
* plugins/elements/gstcapsfilter.c (gst_capsfilter_details):
* plugins/elements/gstcapsfilter.h (__GST_CAPSFILTER_H__,
GST_TYPE_CAPSFILTER, GST_CAPSFILTER, GST_CAPSFILTER_CLASS,
GST_IS_CAPSFILTER, GST_IS_CAPSFILTER_CLASS, GstCapsFilter,
GstCapsFilterClass, _GstCapsFilter, trans, filter_caps,
_GstCapsFilterClass, trans_class):
* plugins/elements/gstelements.c (name, rank, type, _elements):
* plugins/elements/gstidentity.c
(gst_identity_check_imperfect_timestamp,
gst_identity_check_imperfect_offset):
Document capsfilter and add doc-blurb to identity.
2007-05-06 18:27:25 +00:00
|
|
|
$(top_srcdir)/plugins/elements/gstcapsfilter.h \
|
2005-12-01 12:29:34 +00:00
|
|
|
$(top_srcdir)/plugins/elements/gstfakesrc.h \
|
|
|
|
|
$(top_srcdir)/plugins/elements/gstfakesink.h \
|
2007-06-13 15:39:53 +00:00
|
|
|
$(top_srcdir)/plugins/elements/gstfdsink.h \
|
2006-01-04 12:41:35 +00:00
|
|
|
$(top_srcdir)/plugins/elements/gstfdsrc.h \
|
2005-12-01 12:29:34 +00:00
|
|
|
$(top_srcdir)/plugins/elements/gstfilesrc.h \
|
|
|
|
|
$(top_srcdir)/plugins/elements/gstfilesink.h \
|
2006-01-04 12:41:35 +00:00
|
|
|
$(top_srcdir)/plugins/elements/gstidentity.h \
|
2008-02-01 10:17:40 +00:00
|
|
|
$(top_srcdir)/plugins/elements/gstmultiqueue.h \
|
2006-01-04 12:41:35 +00:00
|
|
|
$(top_srcdir)/plugins/elements/gstqueue.h \
|
|
|
|
|
$(top_srcdir)/plugins/elements/gsttypefindelement.h \
|
|
|
|
|
$(top_srcdir)/plugins/elements/gsttee.h
|
2005-12-01 12:29:34 +00:00
|
|
|
|
|
|
|
|
# Images to copy into HTML directory.
|
|
|
|
|
HTML_IMAGES =
|
|
|
|
|
|
|
|
|
|
# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
|
|
|
|
|
content_files =
|
|
|
|
|
|
|
|
|
|
# Other files to distribute.
|
|
|
|
|
extra_files =
|
|
|
|
|
|
|
|
|
|
# CFLAGS and LDFLAGS for compiling scan program. Only needed if your app/lib
|
|
|
|
|
# contains GtkObjects/GObjects and you want to document signals and properties.
|
|
|
|
|
GTKDOC_CFLAGS = $(GST_OBJ_CFLAGS) -I$(top_builddir) -I$(top_builddir)/libs
|
|
|
|
|
GTKDOC_LIBS = $(SCANOBJ_DEPS) $(GST_OBJ_LIBS)
|
|
|
|
|
|
2009-02-22 15:22:16 +00:00
|
|
|
GTKDOC_CC=$(LIBTOOL) --tag=CC --mode=compile $(CC)
|
|
|
|
|
GTKDOC_LD=$(LIBTOOL) --tag=CC --mode=link $(CC)
|
2005-12-01 12:29:34 +00:00
|
|
|
|
|
|
|
|
# If you need to override some of the declarations, place them in this file
|
|
|
|
|
# and uncomment this line.
|
|
|
|
|
#DOC_OVERRIDES = $(DOC_MODULE)-overrides.txt
|
|
|
|
|
DOC_OVERRIDES =
|
|
|
|
|
|
|
|
|
|
include $(top_srcdir)/common/gtk-doc-plugins.mak
|
