docs: Port all docstring to gtk-doc markdown

ges/ges-asset.c

@@ -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

ges/ges-audio-source.c

@@ -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"/>

ges/ges-audio-test-source.c

@@ -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.

ges/ges-audio-track.c

@@ -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

ges/ges-audio-transition.c

@@ -20,6 +20,7 @@
 
 /**
  * SECTION:gesaudiotransition
+ * @title: GESAudioTransition
  * @short_description: implements audio crossfade transition
  */
 

ges/ges-audio-uri-source.c

@@ -20,6 +20,7 @@
 
 /**
  * SECTION:gesaudiourisource
+ * @title: GESAudioUriSource
  * @short_description: outputs a single audio stream from a given file
  */
 

ges/ges-base-effect-clip.c

@@ -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

ges/ges-base-effect.c

@@ -19,6 +19,7 @@
 
 /**
  * SECTION:gesbaseeffect
+ * @title: GESBaseEffect
  * @short_description: adds an effect to a stream in a GESSourceClip or a
  * GESLayer
  */

ges/ges-base-transition-clip.c

@@ -20,6 +20,7 @@
 
 /**
  * SECTION: gesbasetransitionclip
+ * @title: GESBaseTransitionClip
  * @short_description: Base classes for transitions
  */
 

ges/ges-clip-asset.c

@@ -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.

ges/ges-clip.c

@@ -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
  **/

ges/ges-container.c

@@ -20,6 +20,7 @@
 
 /**
  * SECTION:gescontainer
+ * @title: GESContainer
  * @short_description: Base Class for objects responsible for controlling other
  * GESTimelineElement-s
  */

ges/ges-container.h

@@ -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

ges/ges-effect-clip.c

@@ -19,6 +19,7 @@
 
 /**
  * SECTION: geseffectclip
+ * @title: GESEffectClip
  * @short_description: An effect created by parse-launch style bin descriptions
  * in a GESLayer
  *

ges/ges-effect.c

@@ -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
  */

ges/ges-enums.c

@@ -20,6 +20,7 @@
 
 /**
  * SECTION:ges-enums
+ * @title: GES Enumerations
  * @short_description: Various enums for the Gstreamer Editing Services
  */
 

ges/ges-extractable.c

@@ -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

ges/ges-formatter.c

@@ -20,6 +20,7 @@
 
 /**
  * SECTION:gesformatter
+ * @title: GESFormatter
  * @short_description: Timeline saving and loading.
  *
  **/

ges/ges-gerror.h

@@ -22,6 +22,7 @@
 
 /**
  * SECTION: ges-gerror
+ * @title: GESErrors
  * @short_description: GError — Categorized error messages
  */
 

ges/ges-group.c

@@ -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
  *

ges/ges-image-source.c

@@ -20,6 +20,7 @@
 
 /**
  * SECTION:gesimagesource
+ * @title: GESImageSource
  * @short_description: outputs the video stream from a media file as a still
  * image.
  *

ges/ges-layer.c

@@ -22,6 +22,7 @@
 
 /**
  * SECTION:geslayer
+ * @title: GESLayer
  * @short_description: Non-overlapping sequence of GESClip
  *
  * Responsible for the ordering of the various contained Clip(s). A

ges/ges-layer.h

@@ -129,4 +129,3 @@ GstClockTime ges_layer_get_duration (GESLayer *layer);
 G_END_DECLS
 
 #endif /* _GES_LAYER */
-

ges/ges-multi-file-source.c

@@ -19,6 +19,7 @@
 
 /**
  * SECTION:gesmultifilesource
+ * @title: GESMultiFileSource
  * @short_description: outputs the video stream from a sequence of images.
  *
  * Outputs the video stream from a given image sequence. The start frame

ges/ges-operation-clip.c

@@ -20,6 +20,7 @@
 
 /**
  * SECTION:gesoperationclip
+ * @title: GESOperationClip
  * @short_description: Base Class for operations in a GESLayer
  *
  * Operations are any kind of object that both outputs AND consumes data.

ges/ges-operation.c

@@ -20,6 +20,7 @@
 
 /**
  * SECTION:gesoperation
+ * @title: GESOperation
  * @short_description: Base Class for effects and overlays
  */
 

ges/ges-overlay-clip.c

@@ -20,6 +20,7 @@
 
 /**
  * SECTION:gesoverlayclip
+ * @title: GESOverlayClip
  * @short_description: Base Class for overlays in a GESLayer
  *
  * Overlays are objects which modify the underlying layer(s).
@@ -27,7 +28,7 @@
  * Examples of overlays include text, image watermarks, or audio dubbing.
  *
  * Transitions, which change from one source to another over time, are
- * not considered overlays. 
+ * not considered overlays.
  */
 
 #include "ges-internal.h"

ges/ges-pipeline.c

@@ -20,6 +20,7 @@
 
 /**
  * SECTION:gespipeline
+ * @title: GESPipeline
  * @short_description: Convenience GstPipeline for editing.
  *
  * #GESPipeline allows developers to view and render #GESTimeline

ges/ges-pitivi-formatter.c

@@ -19,6 +19,7 @@
 
 /**
  * SECTION: gespitiviformatter
+ * @title: GESPitiviFormatter
  * @short_description: A formatter for the obsolete Pitivi xptv project file format
  *
  * This is a legacy format and you should avoid to use it. The formatter

ges/ges-project.c

@@ -19,6 +19,7 @@
  */
 /**
  * SECTION: gesproject
+ * @title: GESProject
  * @short_description: A GESAsset that is used to manage projects
  *
  * The #GESProject is used to control a set of #GESAsset and is a

ges/ges-source-clip.c

@@ -20,6 +20,7 @@
 
 /**
  * SECTION:gessourceclip
+ * @title: GESSourceClip
  * @short_description: Base Class for sources of a GESLayer
  */
 

ges/ges-source.c

@@ -20,6 +20,7 @@
 
 /**
  * SECTION:gessource
+ * @title: GESSource
  * @short_description: Base Class for single-media sources
  */
 

ges/ges-test-clip.c

@@ -20,6 +20,7 @@
 
 /**
  * SECTION:gestestclip
+ * @title: GESTestClip
  * @short_description: Render video and audio test patterns in a GESLayer
  *
  * Useful for testing purposes.

ges/ges-test-clip.h

@@ -50,7 +50,6 @@ typedef struct _GESTestClipPrivate GESTestClipPrivate;
 
 /**
  * GESTestClip:
- * 
  */
 
 struct _GESTestClip {

ges/ges-text-overlay-clip.c

@@ -20,6 +20,7 @@
 
 /**
  * SECTION:gestextoverlayclip
+ * @title: GESTextOverlayClip
  * @short_description: Render text onto another stream in a GESLayer
  *
  * Renders text onto the next lower priority stream using textrender.

ges/ges-text-overlay-clip.h

@@ -42,7 +42,6 @@ typedef struct _GESTextOverlayClipPrivate GESTextOverlayClipPrivate;
 
 /**
  * GESTextOverlayClip:
- * 
  */
 
 struct _GESTextOverlayClip

ges/ges-text-overlay.c

@@ -20,6 +20,7 @@
 
 /**
  * SECTION:gestextoverlay
+ * @title: GESTextOverlay
  * @short_description: render text onto another video stream in a GESLayer
  *
  */

ges/ges-timeline-element.c

@@ -18,6 +18,7 @@
 
 /**
  * SECTION:gestimelineelement
+ * @title: GESTimelineElement
  * @short_description: Base Class for all elements that will be in a way or
  * another inside a GESTimeline.
  *
@@ -1177,7 +1178,6 @@ ges_timeline_element_get_toplevel_parent (GESTimelineElement * self)
  * ges_timeline_element_get_name:
  * @self: a #GESTimelineElement
  *
- *
  * Returns a copy of the name of @self.
  * Caller should g_free() the return value after usage.
  *
@@ -1196,7 +1196,6 @@ ges_timeline_element_get_name (GESTimelineElement * self)
  * @self: a #GESTimelineElement
  * @name: (allow-none): The name @self should take (if avalaible<)
  *
- *
  * Sets the name of object, or gives @self a guaranteed unique name (if name is NULL).
  * This function makes a copy of the provided name, so the caller retains ownership
  * of the name it sent.

ges/ges-timeline-element.h

@@ -289,4 +289,3 @@ GESTrackType ges_timeline_element_get_track_types  (GESTimelineElement * self);
 G_END_DECLS
 
 #endif /* _GES_TIMELINE_ELEMENT_H_ */
-

ges/ges-timeline.c

@@ -23,6 +23,7 @@
 
 /**
  * SECTION:gestimeline
+ * @title: GESTimeline
  * @short_description: Multimedia timeline
  *
  * #GESTimeline is the central object for any multimedia timeline.

ges/ges-title-clip.c

@@ -20,6 +20,7 @@
 
 /**
  * SECTION:gestitleclip
+ * @title: GESTitleClip
  * @short_description: Render stand-alone titles in  GESLayer.
  *
  * Renders the given text in the specified font, at specified position, and

ges/ges-title-source.c

@@ -20,15 +20,16 @@
 
 /**
  * SECTION:gestitlesource
+ * @title: GESTitleSource
  * @short_description: render stand-alone text titles
  *
  * #GESTitleSource is a GESTimelineElement that implements the notion
  * of titles in GES.
  *
  * <refsect1 id="GESTileSource.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"/>

ges/ges-title-source.h

@@ -46,7 +46,7 @@ G_BEGIN_DECLS
 
 typedef struct _GESTitleSourcePrivate GESTitleSourcePrivate;
 
-/** 
+/**
  * GESTitleSource:
  *
  */
@@ -64,7 +64,6 @@ struct _GESTitleSource {
  * GESTitleSourceClass:
  * @parent_class: parent class
  */
-
 struct _GESTitleSourceClass {
   GESVideoSourceClass parent_class;
 

ges/ges-track-element-asset.c

@@ -20,6 +20,7 @@
 
 /**
  * SECTION: gestrackelementasset
+ * @title: GESTrackElementAsset
  * @short_description: A GESAsset subclass specialized in GESTrackElement extraction
  */
 

ges/ges-track-element.c

@@ -20,6 +20,7 @@
 
 /**
  * SECTION:gestrackelement
+ * @title: GESTrackElement
  * @short_description: Base Class for objects contained in a GESTrack
  *
  * #GESTrackElement is the Base Class for any object that can be contained in a

ges/ges-track.c

@@ -20,6 +20,7 @@
 
 /**
  * SECTION:gestrack
+ * @title: GESTrack
  * @short_description: Composition of objects
  *
  * Corresponds to one output format (i.e. audio OR video).

ges/ges-transition-clip.c

@@ -20,6 +20,7 @@
 
 /**
  * SECTION: gestransitionclip
+ * @title: GESTransitionClip
  * @short_description: Transition from one clip to another in a GESLayer
  *
  * Creates an object that mixes together the two underlying objects, A and B.

ges/ges-transition.c

@@ -17,9 +17,9 @@
  * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
  * Boston, MA 02110-1301, USA.
  */
-
-/** 
+/**
  * SECTION:gestransition
+ * @title: GESTransition
  * @short_description: base class for audio and video transitions
  *
  */

ges/ges-uri-asset.c

@@ -20,6 +20,7 @@
  */
 /**
  * SECTION: gesuriclipasset
+ * @title: GESUriClipAsset
  * @short_description: A GESAsset subclass specialized in GESUriClip extraction
  *
  * The #GESUriClipAsset is a special #GESAsset that lets you handle
@@ -648,6 +649,7 @@ ges_uri_clip_asset_get_stream_assets (GESUriClipAsset * self)
  *****************************************************************/
 /**
  * SECTION: gesurisourceasset
+ * @title: GESUriClipAsset
  * @short_description: A GESAsset subclass specialized in GESUriSource extraction
  *
  * NOTE: You should never request such a #GESAsset as they will be created automatically

ges/ges-uri-clip.c

@@ -20,6 +20,7 @@
 
 /**
  * SECTION: gesuriclip
+ * @title: GESUriClip
  * @short_description: An object for manipulating media files in a GESTimeline
  *
  * Represents all the output streams from a particular uri. It is assumed that

ges/ges-utils.c

@@ -19,6 +19,7 @@
 
 /**
  * SECTION:ges-utils
+ * @title: GES utilities
  * @short_description: Convenience methods
  *
  */

ges/ges-video-source.c

@@ -20,12 +20,13 @@
 
 /**
  * SECTION:gesvideosource
+ * @title: GESVideoSource
  * @short_description: Base Class for video 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>
+ * # 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"/>

ges/ges-video-test-source.c

@@ -20,6 +20,7 @@
 
 /**
  * SECTION:gesvideotestsource
+ * @title: GESVideoTestSource
  * @short_description: produce solid colors and patterns
  */
 

ges/ges-video-track.c

@@ -19,6 +19,7 @@
 
 /**
  * SECTION: gesvideotrack
+ * @title: GESVideoTrack
  * @short_description: A standard GESTrack for raw video
  */
 

ges/ges-video-transition.c

@@ -20,6 +20,7 @@
 
 /**
  * SECTION:gesvideotransition
+ * @title: GESVideoTransition
  * @short_description: implements video crossfade transition
  */
 

ges/ges-video-uri-source.c

@@ -20,6 +20,7 @@
 
 /**
  * SECTION:gesvideourisource
+ * @title: GESVideoUriSource
  * @short_description: outputs a single video stream from a given file
  */