mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2024-08-02 11:45:07 +00:00
bbae2942c2
Original commit message from CVS: * common/c-to-xml.py: * common/gtk-doc-plugins.mak: a simple py script to generate valid xml from a C example probably also need to strip an MIT license when we decide * docs/plugins/Makefile.am: * gst/level/Makefile.am: * gst/level/gstlevel.c: (gst_level_init): * gst/level/level-example.c: (message_handler), (main): add an example to level that will show up in the docs * gst/rtp/TODO: add a note for the future
107 lines
3 KiB
Makefile
107 lines
3 KiB
Makefile
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=gst-plugins-good
|
|
DOC_MODULE=$(MODULE)-plugins
|
|
|
|
# for upload.mak
|
|
DOC=$(MODULE)-plugins
|
|
FORMATS=html
|
|
html: html-build.stamp
|
|
include $(srcdir)/../upload.mak
|
|
|
|
# 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)
|
|
|
|
# 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.
|
|
# FIXME get the location of the installed gstreamer docs
|
|
#FIXXREF_OPTIONS=--extra-dir=../gst/html
|
|
|
|
# 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 = \
|
|
$(top_srcdir)/gst/level/gstlevel.h \
|
|
$(top_srcdir)/gst/goom/gstgoom.h
|
|
|
|
# example code that needs to be converted to xml and placed in xml/
|
|
EXAMPLE_CFILES = \
|
|
$(top_srcdir)/gst/level/level-example.c
|
|
|
|
# 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_BASE_CFLAGS) -I$(top_builddir)
|
|
GTKDOC_LIBS = $(SCANOBJ_DEPS) $(GST_BASE_LIBS)
|
|
|
|
GTKDOC_CC=$(LIBTOOL) --mode=compile $(CC)
|
|
GTKDOC_LD=$(LIBTOOL) --mode=link $(CC)
|
|
|
|
# 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
|