docs/libs/: Add the XOverlay interface to documentation.

Original commit message from CVS:
2005-11-26  Julien MOUTTE  <julien@moutte.net>

* docs/libs/gst-plugins-base-libs-docs.sgml:
* docs/libs/gst-plugins-base-libs-sections.txt:
* docs/libs/tmpl/gstcolorbalance.sgml:
* docs/libs/tmpl/gstmixer.sgml:
* docs/libs/tmpl/gstxoverlay.sgml: Add the XOverlay interface
to documentation.
This commit is contained in:
Julien Moutte 2005-11-26 15:38:06 +00:00
parent c5a52004e0
commit 395ead01f2
6 changed files with 97 additions and 9 deletions

View file

@ -1,3 +1,12 @@
2005-11-26 Julien MOUTTE <julien@moutte.net>
* docs/libs/gst-plugins-base-libs-docs.sgml:
* docs/libs/gst-plugins-base-libs-sections.txt:
* docs/libs/tmpl/gstcolorbalance.sgml:
* docs/libs/tmpl/gstmixer.sgml:
* docs/libs/tmpl/gstxoverlay.sgml: Add the XOverlay interface
to documentation.
2005-11-26 Julien MOUTTE <julien@moutte.net>
* docs/plugins/Makefile.am:

View file

@ -11,6 +11,7 @@
<!ENTITY GstMixer SYSTEM "xml/gstmixer.xml">
<!ENTITY GstRingBuffer SYSTEM "xml/gstringbuffer.xml">
<!ENTITY GstTuner SYSTEM "xml/gsttuner.xml">
<!ENTITY GstXOverlay SYSTEM "xml/gstxoverlay.xml">
]>
<book id="index">
@ -48,6 +49,7 @@ This library should be linked to by getting cflags and libs from
&GstColorBalance;
&GstMixer;
&GstTuner;
&GstXOverlay;
</chapter>
<chapter id="gstreamer-gconf">

View file

@ -104,4 +104,14 @@ gst_tuner_frequency_changed
gst_tuner_signal_changed
</SECTION>
<SECTION>
<FILE>gstxoverlay</FILE>
<INCLUDE>gst/interfaces/xoverlay.h</INCLUDE>
GstXOverlay
GstXOverlayClass
gst_x_overlay_set_xwindow_id
gst_x_overlay_got_xwindow_id
gst_x_overlay_prepare_xwindow_id
gst_x_overlay_expose
</SECTION>

View file

@ -23,15 +23,6 @@ gstcolorbalance
</para>
<!-- ##### SIGNAL GstColorBalance::value-changed ##### -->
<para>
</para>
@gstcolorbalance: the object which received the signal.
@arg1:
@arg2:
<!-- ##### STRUCT GstColorBalanceClass ##### -->
<para>

View file

@ -47,12 +47,18 @@ gstmixer
</para>
@parent:
@values:
@_gst_reserved:
<!-- ##### STRUCT GstMixerTrack ##### -->
<para>
</para>
@parent:
@label:
@flags:
<!-- ##### FUNCTION gst_mixer_list_tracks ##### -->
<para>

View file

@ -0,0 +1,70 @@
<!-- ##### SECTION Title ##### -->
gstxoverlay
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT GstXOverlay ##### -->
<para>
</para>
<!-- ##### STRUCT GstXOverlayClass ##### -->
<para>
</para>
@klass:
@set_xwindow_id:
@expose:
<!-- ##### FUNCTION gst_x_overlay_set_xwindow_id ##### -->
<para>
</para>
@overlay:
@xwindow_id:
<!-- ##### FUNCTION gst_x_overlay_got_xwindow_id ##### -->
<para>
</para>
@overlay:
@xwindow_id:
<!-- ##### FUNCTION gst_x_overlay_prepare_xwindow_id ##### -->
<para>
</para>
@overlay:
<!-- ##### FUNCTION gst_x_overlay_expose ##### -->
<para>
</para>
@overlay: