mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2025-03-28 11:55:39 +00:00
docs: try to make the generated docs more useful
Generate the section.txt file. Update the -docs.sgml file with the new sections. If we want to actually see the baseclasses, we should define them with a _get_type() function and have the wrapped types subclass them.
This commit is contained in:
parent
4cb7327752
commit
99943fd040
4 changed files with 22 additions and 41 deletions
|
@ -22,7 +22,7 @@ DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
|
|||
DOC_SOURCE_DIR = $(top_srcdir)/ext/libav
|
||||
|
||||
# Extra options to supply to gtkdoc-scan.
|
||||
SCAN_OPTIONS=
|
||||
SCAN_OPTIONS=--rebuild-sections
|
||||
|
||||
# Extra options to supply to gtkdoc-mkdb.
|
||||
MKDB_OPTIONS=--sgml-mode
|
||||
|
@ -47,9 +47,6 @@ IGNORE_CFILES =
|
|||
# but I'm not sure about that - it might be this Just Works given that
|
||||
# the registry won't have the element
|
||||
|
||||
# huh? thats not a header
|
||||
#EXTRA_HFILES = $(DOC_SOURCE_DIR)/gstffmpegenc.c
|
||||
|
||||
# Images to copy into HTML directory.
|
||||
HTML_IMAGES =
|
||||
|
||||
|
@ -61,8 +58,9 @@ 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) -I$(top_builddir)/gst-libs
|
||||
GTKDOC_LIBS = $(GST_BASE_LIBS)
|
||||
GTKDOC_CFLAGS = $(LIBAV_CFLAGS) $(GST_CFLAGS) -I$(top_builddir) -I$(top_builddir)/ext/libav
|
||||
GTKDOC_LIBS = -L$(top_builddir)/ext/libav -lgstlibav \
|
||||
$(LIBAV_LIBS) $(GST_BASE_LIBS)
|
||||
|
||||
GTKDOC_CC=$(LIBTOOL) --tag=CC --mode=compile $(CC)
|
||||
GTKDOC_LD=$(LIBTOOL) --tag=CC --mode=link $(CC)
|
||||
|
|
|
@ -7,27 +7,34 @@
|
|||
|
||||
<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
|
||||
<bookinfo>
|
||||
<title>GStreamer FFMPeg &GST_API_VERSION; Plugins Reference Manual</title>
|
||||
<title>GStreamer libav &GST_API_VERSION; Plugins Reference Manual</title>
|
||||
<releaseinfo>
|
||||
for GStreamer FFMPeg Plugins &GST_API_VERSION; (&GST_VERSION;)
|
||||
for GStreamer libav Plugins &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/gst-ffmpeg-plugins/html/">http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-ffmpeg-plugins/html/</ulink>.
|
||||
</releaseinfo>
|
||||
</bookinfo>
|
||||
|
||||
<chapter>
|
||||
<title>gst-ffmpeg Element Types</title>
|
||||
<xi:include href="xml/type-ffenc.xml" />
|
||||
<title>gst-libav Base and Support classes</title>
|
||||
<xi:include href="xml/gstav.xml" />
|
||||
<xi:include href="xml/gstavauddec.xml" />
|
||||
<xi:include href="xml/gstavaudenc.xml" />
|
||||
<xi:include href="xml/gstavcfg.xml" />
|
||||
<xi:include href="xml/gstavcodecmap.xml" />
|
||||
<xi:include href="xml/gstavprotocol.xml" />
|
||||
<xi:include href="xml/gstavutils.xml" />
|
||||
<xi:include href="xml/gstavviddec.xml" />
|
||||
<xi:include href="xml/gstavvidenc.xml" />
|
||||
</chapter>
|
||||
|
||||
<chapter>
|
||||
<title>gst-ffmpeg Elements</title>
|
||||
<xi:include href="xml/element-ffenc_h263p.xml" />
|
||||
<xi:include href="xml/element-ffenc_mpeg4.xml" />
|
||||
</chapter>
|
||||
|
||||
<chapter>
|
||||
<title>gst-ffmpeg Plugins</title>
|
||||
<title>gst-libav Plugins</title>
|
||||
<xi:include href="xml/plugin-libav.xml" />
|
||||
</chapter>
|
||||
|
||||
<chapter>
|
||||
<title>Object Hierarchy</title>
|
||||
<xi:include href="xml/tree_index.sgml" />
|
||||
</chapter>
|
||||
</book>
|
||||
|
|
|
@ -1,23 +0,0 @@
|
|||
<SECTION>
|
||||
<FILE>type-ffenc</FILE>
|
||||
<TITLE>ffenc</TITLE>
|
||||
GstFFMpegEnc
|
||||
|
||||
GstFFMpegEncMeMethod
|
||||
|
||||
<SUBSECTION Standard>
|
||||
GstFFMpegEncClass
|
||||
<SUBSECTION Private>
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<FILE>element-ffenc_h263p</FILE>
|
||||
<TITLE>ffenc_h263p</TITLE>
|
||||
ffenc_h263p
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<FILE>element-ffenc_mpeg4</FILE>
|
||||
<TITLE>ffenc_mpeg4</TITLE>
|
||||
ffenc_mpeg4
|
||||
</SECTION>
|
|
@ -438,7 +438,6 @@ GObject
|
|||
GstPlugin
|
||||
GstPluginFeature
|
||||
GstElementFactory
|
||||
GstTracerFactory
|
||||
GstTypeFindFactory
|
||||
GstRegistry
|
||||
GstTask
|
||||
|
|
Loading…
Reference in a new issue