mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2024-12-19 23:06:49 +00:00
doc: remove xml from comments
This commit is contained in:
Mathieu Duponchelle
parent
3635a6a98b
commit
ca17a6c791
10 changed files with 29 additions and 82 deletions
|
|
@ -36,7 +36,7 @@
|
|||
* GStreamer covers a wide range of use cases including: playback, recording,
|
||||
* editing, serving streams, voice over ip and video calls.
|
||||
*
|
||||
* The <application>GStreamer</application> library should be initialized with
|
||||
* The `GStreamer` library should be initialized with
|
||||
* gst_init() before it can be used. You should pass pointers to the main argc
|
||||
* and argv variables so that GStreamer can process its own command line
|
||||
* options, as shown in the following example.
|
||||
|
|
|
|||
|
|
@ -1304,9 +1304,9 @@ gst_bus_sync_signal_handler (GstBus * bus, GstMessage * message, gpointer data)
|
|||
* as this function is called.
|
||||
*
|
||||
* While this function looks similar to gst_bus_add_signal_watch(), it is not
|
||||
* exactly the same -- this function enables <emphasis>synchronous</emphasis> emission of
|
||||
* exactly the same -- this function enables *synchronous* emission of
|
||||
* signals when messages arrive; gst_bus_add_signal_watch() adds an idle callback
|
||||
* to pop messages off the bus <emphasis>asynchronously</emphasis>. The sync-message signal
|
||||
* to pop messages off the bus *asynchronously*. The sync-message signal
|
||||
* comes from the thread of whatever object posted the message; the "message"
|
||||
* signal is marshalled to the main thread via the main loop.
|
||||
*
|
||||
|
|
|
|||
|
|
@ -37,14 +37,12 @@
|
|||
*
|
||||
* If a subsystem is disabled in GStreamer, a value is defined in
|
||||
* <gst/gst.h>. You can check this if you do subsystem-specific stuff.
|
||||
* <example id="example-gstconfig">
|
||||
* <title>Doing subsystem specific things</title>
|
||||
* <programlisting>
|
||||
* &hash;ifndef GST_DISABLE_GST_DEBUG
|
||||
*
|
||||
* ``` C
|
||||
* #ifndef GST_DISABLE_GST_DEBUG
|
||||
* // do stuff specific to the debugging subsystem
|
||||
* &hash;endif // GST_DISABLE_GST_DEBUG
|
||||
* </programlisting>
|
||||
* </example>
|
||||
* #endif // GST_DISABLE_GST_DEBUG
|
||||
* ```
|
||||
*/
|
||||
|
||||
#ifndef __GST_CONFIG_H__
|
||||
|
|
|
|||
|
|
@ -829,9 +829,10 @@ gst_debug_bin_to_dot_data (GstBin * bin, GstDebugGraphDetails details)
|
|||
* To aid debugging applications one can use this method to write out the whole
|
||||
* network of gstreamer elements that form the pipeline into an dot file.
|
||||
* This file can be processed with graphviz to get an image.
|
||||
* <informalexample><programlisting>
|
||||
*
|
||||
* ``` shell
|
||||
* dot -Tpng -oimage.png graph_lowlevel.dot
|
||||
* </programlisting></informalexample>
|
||||
* ```
|
||||
*/
|
||||
void
|
||||
gst_debug_bin_to_dot_file (GstBin * bin, GstDebugGraphDetails details,
|
||||
|
|
|
|||
|
|
@ -34,7 +34,7 @@
|
|||
* the ones they are interested in or can recover from,
|
||||
* and have a default handler handle the rest of them.
|
||||
*
|
||||
* The rest of this section will use the term <quote>error</quote>
|
||||
* The rest of this section will use the term "error"
|
||||
* to mean both (non-fatal) warnings and (fatal) errors; they are treated
|
||||
* similarly.
|
||||
*
|
||||
|
|
|
|||
|
|
@ -27,15 +27,15 @@
|
|||
* @see_also: #GstPluginFeature, #GstElementFactory
|
||||
*
|
||||
* GStreamer is extensible, so #GstElement instances can be loaded at runtime.
|
||||
* A plugin system can provide one or more of the basic
|
||||
* <application>GStreamer</application> #GstPluginFeature subclasses.
|
||||
* A plugin system can provide one or more of the basic GStreamer
|
||||
* #GstPluginFeature subclasses.
|
||||
*
|
||||
* A plugin should export a symbol <symbol>gst_plugin_desc</symbol> that is a
|
||||
* A plugin should export a symbol `gst_plugin_desc` that is a
|
||||
* struct of type #GstPluginDesc.
|
||||
* the plugin loader will check the version of the core library the plugin was
|
||||
* linked against and will create a new #GstPlugin. It will then call the
|
||||
* #GstPluginInitFunc function that was provided in the
|
||||
* <symbol>gst_plugin_desc</symbol>.
|
||||
* `gst_plugin_desc`.
|
||||
*
|
||||
* Once you have a handle to a #GstPlugin (e.g. from the #GstRegistry), you
|
||||
* can add any object that subclasses #GstPluginFeature.
|
||||
|
|
|
|||
|
|
@ -49,65 +49,16 @@ G_BEGIN_DECLS
|
|||
* In the table below this is shown for the cases that a tag exists in the list
|
||||
* (A) or does not exists (!A) and combinations thereof.
|
||||
*
|
||||
* <table frame="all" colsep="1" rowsep="1">
|
||||
* <title>merge mode</title>
|
||||
* <tgroup cols='5' align='left'>
|
||||
* <thead>
|
||||
* <row>
|
||||
* <entry>merge mode</entry>
|
||||
* <entry>A + B</entry>
|
||||
* <entry>A + !B</entry>
|
||||
* <entry>!A + B</entry>
|
||||
* <entry>!A + !B</entry>
|
||||
* </row>
|
||||
* </thead>
|
||||
* <tbody>
|
||||
* <row>
|
||||
* <entry>REPLACE_ALL</entry>
|
||||
* <entry>B</entry>
|
||||
* <entry>-</entry>
|
||||
* <entry>B</entry>
|
||||
* <entry>-</entry>
|
||||
* </row>
|
||||
* <row>
|
||||
* <entry>REPLACE</entry>
|
||||
* <entry>B</entry>
|
||||
* <entry>A</entry>
|
||||
* <entry>B</entry>
|
||||
* <entry>-</entry>
|
||||
* </row>
|
||||
* <row>
|
||||
* <entry>APPEND</entry>
|
||||
* <entry>A, B</entry>
|
||||
* <entry>A</entry>
|
||||
* <entry>B</entry>
|
||||
* <entry>-</entry>
|
||||
* </row>
|
||||
* <row>
|
||||
* <entry>PREPEND</entry>
|
||||
* <entry>B, A</entry>
|
||||
* <entry>A</entry>
|
||||
* <entry>B</entry>
|
||||
* <entry>-</entry>
|
||||
* </row>
|
||||
* <row>
|
||||
* <entry>KEEP</entry>
|
||||
* <entry>A</entry>
|
||||
* <entry>A</entry>
|
||||
* <entry>B</entry>
|
||||
* <entry>-</entry>
|
||||
* </row>
|
||||
* <row>
|
||||
* <entry>KEEP_ALL</entry>
|
||||
* <entry>A</entry>
|
||||
* <entry>A</entry>
|
||||
* <entry>-</entry>
|
||||
* <entry>-</entry>
|
||||
* </row>
|
||||
* </tbody>
|
||||
* </tgroup>
|
||||
* </table>
|
||||
* | merge mode | A + B | A + !B | !A + B | !A + !B |
|
||||
* | ----------- | ----- | ------ | ------ | ------- |
|
||||
* | REPLACE_ALL | B | ∅ | B | ∅ |
|
||||
* | REPLACE | B | A | B | ∅ |
|
||||
* | APPEND | A, B | A | B | ∅ |
|
||||
* | PREPEND | B, A | A | B | ∅ |
|
||||
* | KEEP | A | A | B | ∅ |
|
||||
* | KEEP_ALL | A | A | ∅ | ∅ |
|
||||
*/
|
||||
|
||||
typedef enum {
|
||||
GST_TAG_MERGE_UNDEFINED,
|
||||
GST_TAG_MERGE_REPLACE_ALL,
|
||||
|
|
|
|||
|
|
@ -41,13 +41,10 @@
|
|||
* allocated filename.
|
||||
*
|
||||
* When the downloadbuffer has completely downloaded the media, it will
|
||||
* post an application message named <classname>"GstCacheDownloadComplete"</classname>
|
||||
* post an application message named `GstCacheDownloadComplete`
|
||||
* with the following information:
|
||||
*
|
||||
* *
|
||||
* G_TYPE_STRING
|
||||
* <classname>"location"</classname>:
|
||||
* the location of the completely downloaded file.
|
||||
* * G_TYPE_STRING `location`: the location of the completely downloaded file.
|
||||
*
|
||||
*/
|
||||
|
||||
|
|
|
|||
|
|
@ -28,7 +28,7 @@
|
|||
* a wide range of buffers and can operate in various scheduling modes.
|
||||
*
|
||||
* It is mostly used as a testing element, one trivial example for testing
|
||||
* basic <application>GStreamer</application> core functionality is:
|
||||
* basic GStreamer core functionality is:
|
||||
*
|
||||
* ## Example launch line
|
||||
* |[
|
||||
|
|
|
|||
|
|
@ -31,7 +31,7 @@
|
|||
* The above mentioned pipeline should dump data packets to the console.
|
||||
*
|
||||
* If the #GstFdSrc:timeout property is set to a value bigger than 0, fdsrc will
|
||||
* generate an element message named <classname>"GstFdSrcTimeout"</classname>
|
||||
* generate an element message named `GstFdSrcTimeout`
|
||||
* if no data was received in the given timeout.
|
||||
*
|
||||
* The message's structure contains one field:
|
||||
|
|
|
|||
Loading…
Reference in a new issue