mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2024-10-04 09:42:19 +00:00
docs: Build documentations for libraries
This commit is contained in:
parent
0561c3751c
commit
4ca79463fc
8 changed files with 190 additions and 2 deletions
|
@ -2041,6 +2041,7 @@ ext/zbar/Makefile
|
||||||
po/Makefile.in
|
po/Makefile.in
|
||||||
docs/Makefile
|
docs/Makefile
|
||||||
docs/plugins/Makefile
|
docs/plugins/Makefile
|
||||||
|
docs/libs/Makefile
|
||||||
docs/version.entities
|
docs/version.entities
|
||||||
pkgconfig/Makefile
|
pkgconfig/Makefile
|
||||||
pkgconfig/gstreamer-plugins-bad.pc
|
pkgconfig/gstreamer-plugins-bad.pc
|
||||||
|
|
|
@ -10,8 +10,8 @@ else
|
||||||
GTK_DOC_DIRS =
|
GTK_DOC_DIRS =
|
||||||
endif
|
endif
|
||||||
|
|
||||||
SUBDIRS = $(GTK_DOC_DIRS)
|
SUBDIRS = libs $(GTK_DOC_DIRS)
|
||||||
DIST_SUBDIRS = plugins
|
DIST_SUBDIRS = libs plugins
|
||||||
|
|
||||||
EXTRA_DIST = \
|
EXTRA_DIST = \
|
||||||
random/ChangeLog-0.8 \
|
random/ChangeLog-0.8 \
|
||||||
|
|
97
docs/libs/Makefile.am
Normal file
97
docs/libs/Makefile.am
Normal file
|
@ -0,0 +1,97 @@
|
||||||
|
## Process this file with automake to produce Makefile.in
|
||||||
|
|
||||||
|
# FIXME: fix the docs then remove this variable
|
||||||
|
DOCS_ARE_INCOMPLETE_PLEASE_FIXME=yespleasedo
|
||||||
|
|
||||||
|
# The name of the module, e.g. 'glib'.
|
||||||
|
#DOC_MODULE=gst-plugins-libs-@GST_MAJORMINOR@
|
||||||
|
DOC_MODULE=gst-plugins-bad-libs
|
||||||
|
|
||||||
|
# for upload-doc.mak
|
||||||
|
DOC=gst-plugins-bad-libs
|
||||||
|
FORMATS=html
|
||||||
|
html: html-build.stamp
|
||||||
|
include $(top_srcdir)/common/upload-doc.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)/gst-libs/gst
|
||||||
|
DOC_BUILD_DIR=$(top_builddir)/gst-libs/gst
|
||||||
|
|
||||||
|
# Extra options to supply to gtkdoc-scan.
|
||||||
|
SCAN_OPTIONS=--deprecated-guards="GST_DISABLE_DEPRECATED"
|
||||||
|
|
||||||
|
# FIXME :
|
||||||
|
# there's something wrong with gstreamer-sections.txt not being in the dist
|
||||||
|
# maybe it doesn't resolve; we're adding it below for now
|
||||||
|
#EXTRA_DIST = gstreamer.types.in gstreamer.hierarchy $(DOC_MODULE)-sections.txt gstreamer-sections.txt $(DOC_MAIN_SGML_FILE)
|
||||||
|
|
||||||
|
# Extra options to supply to gtkdoc-mkdb.
|
||||||
|
MKDB_OPTIONS=--sgml-mode --output-format=xml
|
||||||
|
|
||||||
|
# Extra options to supply to gtkdoc-fixref.
|
||||||
|
FIXXREF_OPTIONS=--extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html \
|
||||||
|
--extra-dir=$(GST_PREFIX)/share/gtk-doc/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 = \
|
||||||
|
$(top_builddir)/gst-libs/gst/codecparsers/libgstcodecparsers-@GST_MAJORMINOR@.la
|
||||||
|
|
||||||
|
# Header files to ignore when scanning.
|
||||||
|
IGNORE_HFILES =
|
||||||
|
|
||||||
|
# Images to copy into HTML directory.
|
||||||
|
HTML_IMAGES =
|
||||||
|
|
||||||
|
# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
|
||||||
|
content_files = compiling.sgml
|
||||||
|
|
||||||
|
# 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_PLUGINS_BAD_CFLAGS) $(GST_BAD_CFLAGS) $(GST_PLUGINS_BASE_CFLAGS) $(GST_BASE_CFLAGS)
|
||||||
|
GTKDOC_LIBS = $(SCANOBJ_DEPS) $(GST_BASE_LIBS) $(GST_BAD_LIBS)
|
||||||
|
|
||||||
|
GTKDOC_CC=$(LIBTOOL) --tag=CC --mode=compile $(CC)
|
||||||
|
GTKDOC_LD=$(LIBTOOL) --tag=CC --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.mak
|
||||||
|
|
48
docs/libs/compiling.sgml
Normal file
48
docs/libs/compiling.sgml
Normal file
|
@ -0,0 +1,48 @@
|
||||||
|
<?xml version="1.0"?>
|
||||||
|
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
|
||||||
|
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
|
||||||
|
<!ENTITY % version-entities SYSTEM "version.entities">
|
||||||
|
%version-entities;
|
||||||
|
]>
|
||||||
|
<refentry id="compiling" revision="17 Jan 2002">
|
||||||
|
<refmeta>
|
||||||
|
<refentrytitle>Compiling</refentrytitle>
|
||||||
|
<manvolnum>3</manvolnum>
|
||||||
|
<refmiscinfo>GStreamer-Bad Library</refmiscinfo>
|
||||||
|
</refmeta>
|
||||||
|
|
||||||
|
<refnamediv>
|
||||||
|
<refname>Compiling against the bad plugins libraries</refname>
|
||||||
|
<refpurpose>
|
||||||
|
How to compile against the bad plugins libraries
|
||||||
|
</refpurpose>
|
||||||
|
</refnamediv>
|
||||||
|
|
||||||
|
<refsect1>
|
||||||
|
<title>Compiling against the bad plugins libraries</title>
|
||||||
|
|
||||||
|
<para>
|
||||||
|
To compile against these libraries, you need to tell the compiler where to
|
||||||
|
find the header files and libraries. This is done with the
|
||||||
|
<application>pkg-config</application> utility.
|
||||||
|
</para>
|
||||||
|
<para>
|
||||||
|
The following interactive shell session demonstrates how
|
||||||
|
<application>pkg-config</application> is used:
|
||||||
|
<programlisting>
|
||||||
|
$ pkg-config --cflags gstreamer-plugins-bad-&GST_MAJORMINOR;
|
||||||
|
-D_LARGEFILE_SOURCE -D_FILE_OFFSET_BITS=64 -pthread -I/usr/include/gstreamer-&GST_MAJORMINOR; -I/usr/include/glib-2.0 -I/usr/lib/glib-2.0/include -I/usr/include/libxml2
|
||||||
|
$ pkg-config --libs gstreamer-plugins-bad-&GST_MAJORMINOR;
|
||||||
|
-Wl,--export-dynamic -pthread -lgstreamer-&GST_MAJORMINOR; -lgobject-2.0 -lgmodule-2.0 -ldl -lgthread-2.0 -lxml2 -lpthread -lz -lm -lglib-2.0
|
||||||
|
</programlisting>
|
||||||
|
</para>
|
||||||
|
|
||||||
|
<para>
|
||||||
|
Note that, because of the number of libraries provided in this package,
|
||||||
|
the pkg-config information <emphasis>does not add -l flags</emphasis> itself
|
||||||
|
to choose the libraries to link to. You must add these yourself to select
|
||||||
|
which of the libraries you want to use.
|
||||||
|
</para>
|
||||||
|
</refsect1>
|
||||||
|
|
||||||
|
</refentry>
|
41
docs/libs/gst-plugins-bad-libs-docs.sgml
Normal file
41
docs/libs/gst-plugins-bad-libs-docs.sgml
Normal file
|
@ -0,0 +1,41 @@
|
||||||
|
<?xml version="1.0"?>
|
||||||
|
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
|
||||||
|
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
|
||||||
|
<!ENTITY % version-entities SYSTEM "version.entities">
|
||||||
|
%version-entities;
|
||||||
|
]>
|
||||||
|
<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
|
||||||
|
<bookinfo>
|
||||||
|
<title>GStreamer Bad Plugins &GST_MAJORMINOR; Library Reference Manual</title>
|
||||||
|
<releaseinfo>
|
||||||
|
for GStreamer Bad Library &GST_MAJORMINOR; (&GST_VERSION;)
|
||||||
|
<ulink role="online-location" url="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-bad-libs/html/">http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-bad-libs/html/</ulink>.
|
||||||
|
</releaseinfo>
|
||||||
|
</bookinfo>
|
||||||
|
|
||||||
|
<part id="gstreamer-plugins-bad">
|
||||||
|
<title>GStreamer Bad Plugins Libraries</title>
|
||||||
|
<para>
|
||||||
|
This manual describes the libraries provided by the GStreamer Bad Plugins
|
||||||
|
package.
|
||||||
|
</para>
|
||||||
|
<xi:include href="compiling.sgml" />
|
||||||
|
</part>
|
||||||
|
|
||||||
|
<part id="gstreamer-libs-hierarchy">
|
||||||
|
<title>Object Hierarchy</title>
|
||||||
|
<xi:include href="xml/tree_index.sgml" />
|
||||||
|
</part>
|
||||||
|
|
||||||
|
<index id="api-index-full">
|
||||||
|
<title>Index</title>
|
||||||
|
<xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
|
||||||
|
</index>
|
||||||
|
<index id="api-index-deprecated" role="deprecated">
|
||||||
|
<title>Index of deprecated API</title>
|
||||||
|
<xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
|
||||||
|
</index>
|
||||||
|
|
||||||
|
<xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
|
||||||
|
</book>
|
||||||
|
|
0
docs/libs/gst-plugins-bad-libs-overrides.txt
Normal file
0
docs/libs/gst-plugins-bad-libs-overrides.txt
Normal file
0
docs/libs/gst-plugins-bad-libs-sections.txt
Normal file
0
docs/libs/gst-plugins-bad-libs-sections.txt
Normal file
1
docs/libs/gst-plugins-bad-libs.types
Normal file
1
docs/libs/gst-plugins-bad-libs.types
Normal file
|
@ -0,0 +1 @@
|
||||||
|
#include <gst/gst.h>
|
Loading…
Reference in a new issue