Commit 35256b47 authored by Thibault Saunier's avatar Thibault Saunier
Browse files

docs: Port all docstring to gtk-doc markdown

parent 8857e004
......@@ -20,6 +20,7 @@
*/
/**
* SECTION: gesasset
* @title: GESAsset
* @short_description: Represents usable resources inside the GStreamer Editing Services
*
* The Assets in the GStreamer Editing Services represent the resources
......
......@@ -20,12 +20,13 @@
/**
* SECTION:gesaudiosource
* @title: GESAudioSource
* @short_description: Base Class for audio sources
*
* <refsect1 id="GESVideoSource.children_properties" role="properties">
* <title role="children_properties.title">Children Properties</title>
* <para>You can use the following children properties through the
* #ges_track_element_set_child_property and alike set of methods:</para>
* <title role="children_properties.title">Children Properties
* You can use the following children properties through the
* #ges_track_element_set_child_property and alike set of methods:
* <informaltable frame="none">
* <tgroup cols="3">
* <colspec colname="properties_type" colwidth="150px"/>
......
......@@ -20,8 +20,9 @@
/**
* SECTION:gesaudiotestsource
* @title: GESAudioTestSource
* @short_description: produce a simple test waveform or silence
*
*
* Outputs a test audio stream using audiotestsrc. The default property values
* output silence. Useful for testing pipelines, or to fill gaps in an audio
* track.
......
......@@ -19,6 +19,7 @@
/**
* SECTION: gesaudiotrack
* @title: GESAudioTrack
* @short_description: A standard GESTrack for raw audio
*
* Sane default properties to specify and fixate the output stream are
......
......@@ -20,6 +20,7 @@
/**
* SECTION:gesaudiotransition
* @title: GESAudioTransition
* @short_description: implements audio crossfade transition
*/
......
......@@ -20,6 +20,7 @@
/**
* SECTION:gesaudiourisource
* @title: GESAudioUriSource
* @short_description: outputs a single audio stream from a given file
*/
......
......@@ -19,6 +19,7 @@
/**
* SECTION: gesbaseeffectclip
* @title: GESBaseEffectClip
* @short_description: An effect in a GESLayer
*
* The effect will be applied on the sources that have lower priorities
......
......@@ -19,6 +19,7 @@
/**
* SECTION:gesbaseeffect
* @title: GESBaseEffect
* @short_description: adds an effect to a stream in a GESSourceClip or a
* GESLayer
*/
......
......@@ -20,6 +20,7 @@
/**
* SECTION: gesbasetransitionclip
* @title: GESBaseTransitionClip
* @short_description: Base classes for transitions
*/
......
......@@ -19,6 +19,7 @@
*/
/**
* SECTION: gesclipasset
* @title: GESClipAsset
* @short_description: A GESAsset subclass specialized in GESClip extraction
*
* The #GESUriClipAsset is a special #GESAsset specilized in #GESClip.
......
......@@ -22,6 +22,7 @@
/**
* SECTION:gesclip
* @title: GESClip
* @short_description: Base Class for objects in a GESLayer
*
* A #GESClip is a 'natural' object which controls one or more
......@@ -1019,7 +1020,6 @@ ges_clip_set_moving_from_layer (GESClip * clip, gboolean is_moving)
* You might rather use the ges_clip_move_to_layer function to
* move #GESClip-s from a layer to another.
*
*
* Returns: %TRUE if @clip is currently moving from its current layer
* %FALSE otherwize
**/
......
......@@ -20,6 +20,7 @@
/**
* SECTION:gescontainer
* @title: GESContainer
* @short_description: Base Class for objects responsible for controlling other
* GESTimelineElement-s
*/
......
......@@ -70,7 +70,6 @@ typedef enum
* controlled by this Container. NOTE: Do not modify.
* @height: The span of priorities this container occupies
*
*
* The #GESContainer base class.
*/
struct _GESContainer
......
......@@ -19,6 +19,7 @@
/**
* SECTION: geseffectclip
* @title: GESEffectClip
* @short_description: An effect created by parse-launch style bin descriptions
* in a GESLayer
*
......
......@@ -19,6 +19,7 @@
/**
* SECTION:geseffect
* @title: GESEffect
* @short_description: adds an effect build from a parse-launch style
* bin description to a stream in a GESSourceClip or a GESLayer
*/
......
......@@ -20,6 +20,7 @@
/**
* SECTION:ges-enums
* @title: GES Enumerations
* @short_description: Various enums for the Gstreamer Editing Services
*/
......
......@@ -20,6 +20,7 @@
*/
/**
* SECTION: gesextractable
* @title: GESExtractable Interface
* @short_description: An interface for objects which can be extracted from a GESAsset
*
* FIXME: Long description needed
......
......@@ -20,6 +20,7 @@
/**
* SECTION:gesformatter
* @title: GESFormatter
* @short_description: Timeline saving and loading.
*
**/
......
......@@ -22,6 +22,7 @@
/**
* SECTION: ges-gerror
* @title: GESErrors
* @short_description: GError — Categorized error messages
*/
......
......@@ -19,6 +19,7 @@
/**
* SECTION:gesgroup
* @title: GESGroup
* @short_description: Class that permits to group GESClip-s in a timeline,
* letting the user manage it a single GESTimelineElement
*
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment