Commit 781ad55f authored by Thibault Saunier's avatar Thibault Saunier

doc: Remove gtk-doc support

parent 3d5dbfb4
DISTCHECK_CONFIGURE_FLAGS=--enable-gtk-doc
# note: keep in sync with configure.ac
ACLOCAL_AMFLAGS = -I m4 -I common/m4
......@@ -8,7 +6,6 @@ aclocal_DATA = gst-element-check-1.0.m4
SUBDIRS = pkgconfig \
gst libs plugins tests \
docs \
po \
m4 \
common \
......@@ -21,7 +18,6 @@ endif
# These are all the possible subdirs
DIST_SUBDIRS = pkgconfig \
gst libs plugins tools tests \
docs \
po \
m4 \
common \
......@@ -186,8 +182,7 @@ CRUFT_DIRS = \
$(top_builddir)/tests/examples/queue \
$(top_builddir)/tests/examples/typefind \
$(top_builddir)/gst/tmp-introspect* \
$(top_builddir)/libs/gst/*/tmp-introspect* \
$(top_srcdir)/docs/plugins/tmpl
$(top_builddir)/libs/gst/*/tmp-introspect*
include $(top_srcdir)/common/cruft.mak
......
......@@ -457,10 +457,6 @@ AM_CONDITIONAL(HAVE_VALGRIND, test ! "x$VALGRIND_PATH" = "xno")
dnl check for gobject-introspection
GOBJECT_INTROSPECTION_CHECK([1.31.1])
dnl check for documentation tools
GTK_DOC_CHECK([1.12])
AG_GST_PLUGIN_DOCS([1.12])
dnl *** checks for libraries ***
dnl check for libm, for sin()
......@@ -1126,12 +1122,6 @@ tests/examples/streams/Makefile
tools/Makefile
common/Makefile
common/m4/Makefile
docs/Makefile
docs/gst/Makefile
docs/gst/gstreamer.types
docs/libs/Makefile
docs/plugins/Makefile
docs/version.entities
m4/Makefile
pkgconfig/Makefile
stamp.h
......@@ -1167,8 +1157,6 @@ Configuration
Package name : ${GST_PACKAGE_NAME}
Package origin : ${GST_PACKAGE_ORIGIN}
API Documentation : ${enable_gtk_doc}
Debug logging : ${enable_gst_debug}
Tracing subsystem hooks : ${enable_gst_tracer_hooks}
Command-line parser : ${enable_parse}
......
if ENABLE_GTK_DOC
if ENABLE_PLUGIN_DOCS
PLUGIN_DOCS_DIRS = plugins
else
PLUGIN_DOCS_DIRS =
endif
else
PLUGIN_DOCS_DIRS = plugins
endif
BUILT_SOURCES = version.entities
SUBDIRS = gst libs $(PLUGIN_DOCS_DIRS)
DIST_SUBDIRS = gst libs plugins
EXTRA_DIST = version.entities.in list-ulink.xsl
upload:
@if test "x$(SUBDIRS)" != x; then for a in $(SUBDIRS); do cd $$a; make upload; cd ..; done; fi
libs: gst
include $(top_srcdir)/common/parallel-subdirs.mak
Makefile
Makefile.in
gstreamer-decl-list.txt
gstreamer-decl.txt
gstreamer-undocumented.txt
gstreamer-unused.txt
gstreamer-undeclared.txt
gstreamer.args
gstreamer.hierarchy
gstreamer.interfaces
gstreamer.prerequisites
gstreamer.signals
html
sgml
tmpl
*.stamp
doc-registry.xml
gstreamer.html
gstreamer-presed-scan.c
gstreamer-scan.c
gstreamer-scan
tmpl.stamp
tmpl-build.stamp
sgml.stamp
sgml-build.stamp
scan-build.stamp
html.stamp
html-build.stamp
*.tgz
*.tex
*.log
*.aux
*.dvi
*.ps
*.bak
gtkdoc-fixxref
xml
gst-universe.svg
gstreamer.types
gstreamer-scan.gcno
## Process this file with automake to produce Makefile.in
# The name of the module, e.g. 'glib'.
# DOC_MODULE=gstreamer-@GST_API_VERSION@
DOC_MODULE=gstreamer
# don't want $(DOC_MODULE)-scan.c to be built with -Werror
ERROR_CFLAGS=
BUILT_SOURCES=gstreamer.types
# for upload-doc.mak
DOC=gstreamer
FORMATS=html
html: html-build.stamp
include $(top_srcdir)/common/upload-doc.mak
# The top-level SGML file. Change it if you want.
DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
# The files 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)/gst
# Extra options to supply to gtkdoc-scan.
SCAN_OPTIONS=--deprecated-guards="GST_DISABLE_DEPRECATED" \
--ignore-decorators='GST_API'
# Extra options to supply to gtkdoc-mkdb.
MKDB_OPTIONS=--sgml-mode --output-format=xml --ignore-files=parse
# Extra options to supply to gtkdoc-fixref.
FIXXREF_OPTIONS=--extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html
# Used for dependencies.
HFILE_GLOB=$(top_srcdir)/gst/*.h
CFILE_GLOB=$(top_srcdir)/gst/*.c
# Header files to ignore when scanning. Use base file name, no paths
IGNORE_HFILES= \
gettext.h \
glib-compat-private.h \
glib-compat.h \
gst-i18n-app.h \
gst-i18n-lib.h \
gst_private.h \
gstelementdetails.h \
gstmacros.h \
gstmarshal.h \
math-compat.h \
\
grammar.tab.h \
grammar.tab.pre.h \
parse_lex.h \
types.h \
\
gst-printf.h \
printf-args.h \
printf-extension.h \
printf-parse.h \
vasnprintf.h
gst-universe.svg: gst-universe.dot
-dot -Tsvg $< | sed 's/\(font-size:[0-9]*\.[0-9]*\);/\1px;/g' >$@
# Images to copy into HTML directory.
HTML_IMAGES =
# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
content_files = building.xml running.xml gst-universe.svg
# Other files to distribute.
extra_files = gst-universe.dot
# 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) -DGST_USE_UNSTABLE_API
GTKDOC_LIBS = $(GST_OBJ_LIBS) \
$(top_builddir)/gst/libgstreamer-@GST_API_VERSION@.la \
$(top_builddir)/libs/gst/base/libgstbase-@GST_API_VERSION@.la \
$(top_builddir)/libs/gst/controller/libgstcontroller-@GST_API_VERSION@.la \
$(top_builddir)/libs/gst/net/libgstnet-@GST_API_VERSION@.la
GTKDOC_EXTRA_ENVIRONMENT= \
GST_PLUGIN_SCANNER_1_0=$(top_builddir)/libs/gst/helpers/gst-plugin-scanner
# If you need to override some of the declarations, place them in this file
# and uncomment this line.
DOC_OVERRIDES = $(DOC_MODULE)-overrides.txt
include $(top_srcdir)/common/gtk-doc.mak
# gtk-doc.mak defines CLEANFILES
CLEANFILES += gst-universe.svg
<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
<!ENTITY % version-entities SYSTEM "version.entities">
%version-entities;
<!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'">
]>
<refentry id="gst-building" revision="25 mar 2009">
<refmeta>
<refentrytitle>Building GStreamer and GStreamer Applications</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>GStreamer Core</refmiscinfo>
</refmeta>
<refnamediv>
<refname>Building GStreamer and GStreamer Applications</refname>
<refpurpose>
How to build the GStreamer framework and applications using it.
</refpurpose>
</refnamediv>
<refsect1>
<title>Building GStreamer on UNIX</title>
<!-- this has been borrowed from the glib docs -->
<para>
On UNIX, GStreamer uses the standard GNU build system,
using <application>autoconf</application> for package
configuration and resolving portability issues,
<application>automake</application> for building makefiles
that comply with the GNU Coding Standards, and
<application>libtool</application> for building shared
libraries on multiple platforms. The normal sequence for
compiling and installing the GStreamer library is thus:
<literallayout>
<userinput>./configure</userinput>
<userinput>make</userinput>
<userinput>make install</userinput>
</literallayout>
</para>
<para>
The standard options provided by <application>GNU
autoconf</application> may be passed to the
<command>configure</command> script. Please see the
<application>autoconf</application> documentation or run
<command>./configure --help</command> for information about
the standard options.
</para>
<para>
In addition there are several options to activate or deactivate features.
E.g. passing <option>--disable-gst-debug</option> to <command>configure</command>
will turn the debugging subsystem into a non-functional stub and remove all
macro based invocations from within the library (and anything compiled
against the library afterwards.)
</para>
<para>
If library size matters and one builds in a controlled environment, it is
also possible to totally remove subsystem code. This is intentionally not
offered as a configure option as it causes an ABI break. Code built against
a version of GStreamer without these modifications needs to be recompiled.
<literallayout>
<userinput>make CFLAGS="-DGST_REMOVE_DEPRECATED -DGST_REMOVE_DISABLED"</userinput>
</literallayout>
<itemizedlist>
<listitem>
<para>
<symbol>GST_REMOVE_DEPRECATED</symbol> - Omit deprecated functions
from the library.
</para>
</listitem>
<listitem>
<para>
<symbol>GST_REMOVE_DISABLED</symbol> - Omit stubs for disabled
subsystems from the library.
</para>
</listitem>
</itemizedlist>
</para>
</refsect1>
<refsect1>
<title>Building GStreamer Applications</title>
<para>
Applications and libraries can use <command>pkg-config</command> to get all the
needed compiler and linker flags to build against GStreamer. Please note that
GStreamer is split into several libraries itself.
<command>pkg-config --list-all | grep gstreamer</command> will list the
available libraries.
</para>
</refsect1>
</refentry>
/* dot -Tpng gst-universe.dot -ogst-universe.png
*
* other layouts:
* circo -Tpng gst-universe.dot -ogst-universe.circo.png
* neato -Tpng gst-universe.dot -ogst-universe.neato.png
*
* todo:
* - add urls to api docs
* - use color
*/
digraph pipeline {
node [style="filled", shape="box", fillcolor="#eeeeee", fontsize="9px", fontname="Bitstream Vera Sans", target="_top"];
edge [labelfontsize="7px", fontsize="7px", labelfontname="Bitstream Vera Sans", fontname="Bitstream Vera Sans"];
labelloc=t;
nodesep=0.25;
/*
fontname="Bitstream Vera Sans";
fontsize="10px";
label="GStreamer Universe";
*/
/* objects */
application [color=black, fillcolor="#ffdddd"];
bin [href="GstBin.html", color=black, fillcolor="#ccccff"];
bus [href="GstBus.html"];
buffer [href="gstreamer-GstBuffer.html", color=black, fillcolor="#ddffdd"];
caps [href="gstreamer-GstCaps.html"];
clock [href="GstClock.html"];
element [href="GstElement.html", color=black, fillcolor="#ccccff"];
element_factory [href="GstElementFactory.html", label="element factory"];
event [href="gstreamer-GstEvent.html", color=black, fillcolor="#ddffdd"];
message [href="gstreamer-GstMessage.html", color=black, fillcolor="#ddffdd"];
pad [href="GstPad.html", color=black, fillcolor="#ccccff"];
pad_template [href="GstPadTemplate.html", label="pad template"];
pipeline [href="GstPipeline.html", color=black, fillcolor="#ccccff"];
plugin [href="GstPlugin.html"];
plugin_feature [href="GstPluginFeature.html", label="plugin feature"];
query [href="gstreamer-GstQuery.html", color=black, fillcolor="#ddffdd"];
registry [href="GstRegistry.html"];
structure [href="gstreamer-GstStructure.html"];
/* relations */
bin -> element [label="is-a"];
pipeline -> bin [label="is-a"];
pipeline -> bus [label="has 1"];
pipeline -> clock [label="has 1"];
element -> pad_template [label="has n"];
element -> pad [label="has n"];
element -> clock [label="may provide"];
pad -> caps [label="has n"];
pad_template -> caps [label="has n"];
buffer -> caps [label="has n"];
caps -> structure [label="has n"];
bin -> element [label="has n"];
pad -> pad_template [label="is created from"];
element -> element_factory [label="is created from"];
element -> query [label="answers"];
element -> event [label="send & receive"];
element -> buffer [label="send & receive"];
element -> message [label="send"];
bus -> message [label="receive"];
registry -> plugin [label="has n"];
plugin -> plugin_feature [label="has n"];
element_factory -> plugin_feature [label="is-a"];
application -> pipeline [label="has"];
application -> bus [label="listen on"];
application -> query [label="send"];
application -> event [label="send"];
}
<?xml version="1.0"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
<!ENTITY % version-entities SYSTEM "version.entities">
%version-entities;
<!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'">
<!ENTITY hash "#">
]>
<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
<bookinfo>
<title>GStreamer &GST_API_VERSION; Core Reference Manual</title>
<releaseinfo>
for GStreamer Core &GST_API_VERSION; (&GST_VERSION;)
The latest version of this documentation can be found on-line at
<ulink role="online-location" url="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/">http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/</ulink>.
</releaseinfo>
</bookinfo>
<chapter id="gstreamer">
<title>GStreamer Overview</title>
<para>
GStreamer is a streaming media framework.
It uses graphs of elements which operate on data.
The functionality to process media is provided by plug-ins which provide
features like elements, typefinding, and so on.
This allows new functionality to be added simply by installing new plug-ins.
</para>
<para>
GStreamer is cross-platform and works on most UNIX-like platforms as well as
Windows. It is released under the GNU Library General Public License
(GNU LGPL).
</para>
<mediaobject>
<imageobject>
<imagedata fileref="gst-universe.svg" format="SVG"/>
</imageobject>
<caption>
<para>Relation between gstreamer core objects.</para>
</caption>
</mediaobject>
<xi:include href="building.xml" />
<xi:include href="running.xml" />
</chapter>
<chapter id="libgstreamer">
<title>GStreamer Core Library</title>
<para>
libgstreamer-&GST_API_VERSION;.so provides all the core GStreamer services,
including initialization, plugin management and types,
as well as the object hierarchy that defines elements and bins,
along with some more specialized elements.
</para>
<xi:include href="xml/gst.xml" />
<xi:include href="xml/gstallocator.xml" />
<xi:include href="xml/gstatomicqueue.xml" />
<xi:include href="xml/gstbin.xml" />
<xi:include href="xml/gstbuffer.xml" />
<xi:include href="xml/gstbufferlist.xml" />
<xi:include href="xml/gstbufferpool.xml" />
<xi:include href="xml/gstbus.xml" />
<xi:include href="xml/gstcaps.xml" />
<xi:include href="xml/gstcapsfeatures.xml" />
<xi:include href="xml/gstsample.xml" />
<xi:include href="xml/gstchildproxy.xml" />
<xi:include href="xml/gstclock.xml" />
<xi:include href="xml/gstconfig.xml" />
<xi:include href="xml/gstcontext.xml" />
<xi:include href="xml/gstcontrolbinding.xml" />
<xi:include href="xml/gstcontrolsource.xml" />
<xi:include href="xml/gstdatetime.xml" />
<xi:include href="xml/gstdynamictypefactory.xml" />
<xi:include href="xml/gstelement.xml" />
<xi:include href="xml/gstelementfactory.xml" />
<xi:include href="xml/gsterror.xml" />
<xi:include href="xml/gstevent.xml" />
<xi:include href="xml/gstformat.xml" />
<xi:include href="xml/gstghostpad.xml" />
<xi:include href="xml/gstiterator.xml" />
<xi:include href="xml/gstmemory.xml" />
<xi:include href="xml/gstmessage.xml" />
<xi:include href="xml/gstmeta.xml" />
<xi:include href="xml/gstminiobject.xml" />
<xi:include href="xml/gstobject.xml" />
<xi:include href="xml/gstpad.xml" />
<xi:include href="xml/gstpadtemplate.xml" />
<xi:include href="xml/gstparamspec.xml" />
<xi:include href="xml/gstparse.xml" />
<xi:include href="xml/gstpipeline.xml" />
<xi:include href="xml/gstplugin.xml" />
<xi:include href="xml/gstpluginfeature.xml" />
<xi:include href="xml/gstpoll.xml" />
<xi:include href="xml/gstpreset.xml" />
<xi:include href="xml/gstpromise.xml" />
<xi:include href="xml/gstprotection.xml" />
<xi:include href="xml/gstquery.xml" />
<xi:include href="xml/gstregistry.xml" />
<xi:include href="xml/gstsegment.xml" />
<xi:include href="xml/gststreams.xml" />
<xi:include href="xml/gststreamcollection.xml" />
<xi:include href="xml/gststructure.xml" />
<xi:include href="xml/gstsystemclock.xml" />
<xi:include href="xml/gsttaglist.xml" />
<xi:include href="xml/gsttagsetter.xml" />
<xi:include href="xml/gsttask.xml" />
<xi:include href="xml/gsttaskpool.xml" />
<xi:include href="xml/gsttoc.xml" />
<xi:include href="xml/gsttocsetter.xml" />
<xi:include href="xml/gsttypefind.xml" />
<xi:include href="xml/gsttypefindfactory.xml" />
<xi:include href="xml/gsturi.xml" />
<xi:include href="xml/gsturihandler.xml" />
<xi:include href="xml/gstutils.xml" />
<xi:include href="xml/gstvalue.xml" />
<xi:include href="xml/gstversion.xml" />
</chapter>
<chapter id="gstreamer-device-probing">
<title>GStreamer Device Discovery and Device Probing</title>
<xi:include href="xml/gstdevicemonitor.xml" />
<xi:include href="xml/gstdevice.xml" />
<xi:include href="xml/gstdeviceprovider.xml" />
<xi:include href="xml/gstdeviceproviderfactory.xml" />
</chapter>
<chapter id="gstreamer-support">
<title>GStreamer Core Support</title>
<para>
Theses modules support the gstreamer core and plugin development.
Application developers will rarely need to know about it.
</para>
<xi:include href="xml/gstinfo.xml" />
<xi:include href="xml/gsttracer.xml" />
<xi:include href="xml/gsttracerfactory.xml" />
<xi:include href="xml/gsttracerrecord.xml" />
</chapter>
<chapter id="gstreamer-hierarchy">
<title>Object Hierarchy</title>
<xi:include href="xml/tree_index.sgml"/>
</chapter>
<index>
<title>API Index</title>
<xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
</index>
<index role="deprecated">
<title>Index of deprecated API</title>
<xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
</index>
<index>
<title>Index of new API in 1.16</title>
<xi:include href="xml/api-index-1.16.xml"><xi:fallback /></xi:include>
</index>
<index>
<title>Index of new API in 1.14</title>
<xi:include href="xml/api-index-1.14.xml"><xi:fallback /></xi:include>
</index>
<index>
<title>Index of new API in 1.12</title>
<xi:include href="xml/api-index-1.12.xml"><xi:fallback /></xi:include>
</index>
<index>
<title>Index of new API in 1.10</title>
<xi:include href="xml/api-index-1.10.xml"><xi:fallback /></xi:include>
</index>
<index>
<title>Index of new API in 1.8</title>
<xi:include href="xml/api-index-1.8.xml"><xi:fallback /></xi:include>
</index>
<index>
<title>Index of new API in 1.6</title>
<xi:include href="xml/api-index-1.6.xml"><xi:fallback /></xi:include>
</index>
<index>
<title>Index of new API in 1.4</title>
<xi:include href="xml/api-index-1.4.xml"><xi:fallback /></xi:include>
</index>
<index>
<title>Index of new API in 1.2.3</title>
<xi:include href="xml/api-index-1.2.3.xml"><xi:fallback /></xi:include>
</index>
<index>
<title>Index of new API in 1.2</title>
<xi:include href="xml/api-index-1.2.xml"><xi:fallback /></xi:include>
</index>
<index>
<title>Index of new API in 1.0.10</title>
<xi:include href="xml/api-index-1.0.10.xml"><xi:fallback /></xi:include>
</index>
<index>
<title>Index of new API in 1.0.5</title>
<xi:include href="xml/api-index-1.0.5.xml"><xi:fallback /></xi:include>
</index>
<xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
</book>
This diff is collapsed.
% add a _get_type for every GObject whose properties and signals you want
% documented
% add the relevant includes to be able to call those _get_type functions
% adding a get_type here will:
% - change output file name from gstreamer-(whatever).html to (whatever).html
% - document properties and signals
#include <gst/gst.h>
#include <gst/gsttracer.h>
#include <gst/gsttracerrecord.h>
gst_bin_get_type
gst_buffer_pool_get_type
gst_bus_get_type
gst_child_proxy_get_type
gst_clock_get_type
gst_control_binding_get_type
gst_control_source_get_type
gst_element_factory_get_type
gst_element_get_type
gst_ghost_pad_get_type
gst_object_get_type
gst_pad_get_type
gst_pad_template_get_type
gst_pipeline_get_type
gst_plugin_feature_get_type
gst_preset_get_type
gst_promise_get_type
gst_registry_get_type
gst_system_clock_get_type
gst_tag_setter_get_type
gst_task_get_type
gst_tracer_get_type
gst_tracer_factory_get_type
gst_tracer_record_get_type
gst_type_find_factory_get_type
gst_uri_handler_get_type
gst_buffer_get_type
gst_buffer_list_get_type
gst_caps_get_type
gst_context_get_type
gst_event_get_type
gst_memory_get_type
gst_message_get_type
gst_query_get_type
gst_sample_get_type
gst_tag_list_get_type
gst_toc_get_type
gst_toc_entry_get_type
types = configure_file(input : 'gstreamer.types.in',
output : 'gstreamer.types',
copy: true)
gnome.gtkdoc('gstreamer',
main_sgml : 'gstreamer-docs.sgml',
src_dir : '@0@/../../gst'.format(meson.current_source_dir()),
scan_args : ['--deprecated-guards=GST_DISABLE_DEPRECATED',
'--ignore-decorators=GST_API',
'--ignore-headers=gettext.h glib-compat-private.h glib-compat.h gst-i18n-app.h gst-i18n-lib.h gst_private.h gstelementdetails.h gstmacros.h grammar.tab.h grammar.tab.pre.h math-compat.h types.h'
],
scanobjs_args : ['--type-init-func="gst_init(NULL,NULL)"'],
gobject_typesfile : types,
dependencies : [gst_dep],
content_files: ['building.xml', 'running.xml', version_entities],
install : true)
This diff is collapsed.
*.bak
*.stamp
html
xml
doc-registry.xml
Makefile
Makefile.in
gstreamer-libs-decl.txt
gstreamer-libs-decl-list.txt
gstreamer-libs-presed-scan.c
gstreamer-libs-undocumented.txt
gstreamer-libs-unused.txt
gstreamer-libs-undeclared.txt
gstreamer-libs.args
gstreamer-libs.hierarchy
gstreamer-libs.interfaces
gstreamer-libs.prerequisites
gstreamer-libs.signals
gstreamer-libs-scan.gcno
## Process this file with automake to produce Makefile.in
# The name of the module, e.g. 'glib'.
#DOC_MODULE=gstreamer-libs-@GST_API_VERSION@
DOC_MODULE=gstreamer-libs
# don't want $(DOC_MODULE)-scan.c to be built with -Werror
ERROR_CFLAGS=
# for upload-doc.mak
DOC=gstreamer-libs
FORMATS=html
html: html-build.stamp
include $(top_srcdir)/common/upload-doc.mak
# The top-level SGML file. Change it if you want.
DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
# The directory containing the source code.
# gtk-doc will search all .c & .h files beneath here for inline comments
# documenting functions and macros.
DOC_SOURCE_DIR=$(top_srcdir)/libs/gst
# Extra options to supply to gtkdoc-scan.
SCAN_OPTIONS=--deprecated-guards="GST_DISABLE_DEPRECATED" \
--ignore-decorators="GST_API|GST_BASE_API|GST_CHECK_API|GST_CONTROLLER_API|GST_NET_API"
# Extra options to supply to gtkdoc-mkdb.
MKDB_OPTIONS=--sgml-mode --output-format=xml --ignore-files="$(IGNORE_HFILES)"
# Extra options to supply to gtkdoc-fixref.
FIXXREF_OPTIONS=--extra-dir=$(top_builddir)/docs/gst/html \
--extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html \
--extra-dir=$(datadir)/gtk-doc/html
# Used for dependencies.
HFILE_GLOB=$(top_srcdir)/libs/gst/*/*.h
CFILE_GLOB=$(top_srcdir)/libs/gst/*/*.c
# Extra options to pass to gtkdoc-scanobj or gtkdoc-scangobj.
SCANOBJ_OPTIONS=--type-init-func="gst_init(&argc,&argv)"
CHECK_HFILES=$(wildcard $(top_srcdir)/libs/gst/check/libcheck/*.h)
CHECK_HFILES+=$(wildcard $(top_srcdir)/libs/gst/check/libcheck/libcompat/*.h)
# Header files to ignore when scanning.