docs: Port all docstring to gtk-doc markdown

This commit is contained in:
Thibault Saunier 2017-03-08 18:13:48 -03:00
parent 8857e004f7
commit 35256b47ff
56 changed files with 64 additions and 23 deletions

View file

@ -20,6 +20,7 @@
*/ */
/** /**
* SECTION: gesasset * SECTION: gesasset
* @title: GESAsset
* @short_description: Represents usable resources inside the GStreamer Editing Services * @short_description: Represents usable resources inside the GStreamer Editing Services
* *
* The Assets in the GStreamer Editing Services represent the resources * The Assets in the GStreamer Editing Services represent the resources

View file

@ -20,12 +20,13 @@
/** /**
* SECTION:gesaudiosource * SECTION:gesaudiosource
* @title: GESAudioSource
* @short_description: Base Class for audio sources * @short_description: Base Class for audio sources
* *
* <refsect1 id="GESVideoSource.children_properties" role="properties"> * <refsect1 id="GESVideoSource.children_properties" role="properties">
* <title role="children_properties.title">Children Properties</title> * <title role="children_properties.title">Children Properties
* <para>You can use the following children properties through the * You can use the following children properties through the
* #ges_track_element_set_child_property and alike set of methods:</para> * #ges_track_element_set_child_property and alike set of methods:
* <informaltable frame="none"> * <informaltable frame="none">
* <tgroup cols="3"> * <tgroup cols="3">
* <colspec colname="properties_type" colwidth="150px"/> * <colspec colname="properties_type" colwidth="150px"/>

View file

@ -20,6 +20,7 @@
/** /**
* SECTION:gesaudiotestsource * SECTION:gesaudiotestsource
* @title: GESAudioTestSource
* @short_description: produce a simple test waveform or silence * @short_description: produce a simple test waveform or silence
* *
* Outputs a test audio stream using audiotestsrc. The default property values * Outputs a test audio stream using audiotestsrc. The default property values

View file

@ -19,6 +19,7 @@
/** /**
* SECTION: gesaudiotrack * SECTION: gesaudiotrack
* @title: GESAudioTrack
* @short_description: A standard GESTrack for raw audio * @short_description: A standard GESTrack for raw audio
* *
* Sane default properties to specify and fixate the output stream are * Sane default properties to specify and fixate the output stream are

View file

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

View file

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

View file

@ -19,6 +19,7 @@
/** /**
* SECTION: gesbaseeffectclip * SECTION: gesbaseeffectclip
* @title: GESBaseEffectClip
* @short_description: An effect in a GESLayer * @short_description: An effect in a GESLayer
* *
* The effect will be applied on the sources that have lower priorities * The effect will be applied on the sources that have lower priorities

View file

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

View file

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

View file

@ -19,6 +19,7 @@
*/ */
/** /**
* SECTION: gesclipasset * SECTION: gesclipasset
* @title: GESClipAsset
* @short_description: A GESAsset subclass specialized in GESClip extraction * @short_description: A GESAsset subclass specialized in GESClip extraction
* *
* The #GESUriClipAsset is a special #GESAsset specilized in #GESClip. * The #GESUriClipAsset is a special #GESAsset specilized in #GESClip.

View file

@ -22,6 +22,7 @@
/** /**
* SECTION:gesclip * SECTION:gesclip
* @title: GESClip
* @short_description: Base Class for objects in a GESLayer * @short_description: Base Class for objects in a GESLayer
* *
* A #GESClip is a 'natural' object which controls one or more * 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 * You might rather use the ges_clip_move_to_layer function to
* move #GESClip-s from a layer to another. * move #GESClip-s from a layer to another.
* *
*
* Returns: %TRUE if @clip is currently moving from its current layer * Returns: %TRUE if @clip is currently moving from its current layer
* %FALSE otherwize * %FALSE otherwize
**/ **/

View file

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

View file

@ -70,7 +70,6 @@ typedef enum
* controlled by this Container. NOTE: Do not modify. * controlled by this Container. NOTE: Do not modify.
* @height: The span of priorities this container occupies * @height: The span of priorities this container occupies
* *
*
* The #GESContainer base class. * The #GESContainer base class.
*/ */
struct _GESContainer struct _GESContainer

View file

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

View file

@ -19,6 +19,7 @@
/** /**
* SECTION:geseffect * SECTION:geseffect
* @title: GESEffect
* @short_description: adds an effect build from a parse-launch style * @short_description: adds an effect build from a parse-launch style
* bin description to a stream in a GESSourceClip or a GESLayer * bin description to a stream in a GESSourceClip or a GESLayer
*/ */

View file

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

View file

@ -20,6 +20,7 @@
*/ */
/** /**
* SECTION: gesextractable * SECTION: gesextractable
* @title: GESExtractable Interface
* @short_description: An interface for objects which can be extracted from a GESAsset * @short_description: An interface for objects which can be extracted from a GESAsset
* *
* FIXME: Long description needed * FIXME: Long description needed

View file

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

View file

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

View file

@ -19,6 +19,7 @@
/** /**
* SECTION:gesgroup * SECTION:gesgroup
* @title: GESGroup
* @short_description: Class that permits to group GESClip-s in a timeline, * @short_description: Class that permits to group GESClip-s in a timeline,
* letting the user manage it a single GESTimelineElement * letting the user manage it a single GESTimelineElement
* *

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

@ -20,6 +20,7 @@
/** /**
* SECTION:gesoverlayclip * SECTION:gesoverlayclip
* @title: GESOverlayClip
* @short_description: Base Class for overlays in a GESLayer * @short_description: Base Class for overlays in a GESLayer
* *
* Overlays are objects which modify the underlying layer(s). * Overlays are objects which modify the underlying layer(s).

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

@ -20,15 +20,16 @@
/** /**
* SECTION:gestitlesource * SECTION:gestitlesource
* @title: GESTitleSource
* @short_description: render stand-alone text titles * @short_description: render stand-alone text titles
* *
* #GESTitleSource is a GESTimelineElement that implements the notion * #GESTitleSource is a GESTimelineElement that implements the notion
* of titles in GES. * of titles in GES.
* *
* <refsect1 id="GESTileSource.children_properties" role="properties"> * <refsect1 id="GESTileSource.children_properties" role="properties">
* <title role="children_properties.title">Children Properties</title> * <title role="children_properties.title">Children Properties
* <para>You can use the following children properties through the * You can use the following children properties through the
* #ges_track_element_set_child_property and alike set of methods:</para> * #ges_track_element_set_child_property and alike set of methods:
* <informaltable frame="none"> * <informaltable frame="none">
* <tgroup cols="3"> * <tgroup cols="3">
* <colspec colname="properties_type" colwidth="150px"/> * <colspec colname="properties_type" colwidth="150px"/>

View file

@ -64,7 +64,6 @@ struct _GESTitleSource {
* GESTitleSourceClass: * GESTitleSourceClass:
* @parent_class: parent class * @parent_class: parent class
*/ */
struct _GESTitleSourceClass { struct _GESTitleSourceClass {
GESVideoSourceClass parent_class; GESVideoSourceClass parent_class;

View file

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

View file

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

View file

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

View file

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

View file

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

View file

@ -20,6 +20,7 @@
*/ */
/** /**
* SECTION: gesuriclipasset * SECTION: gesuriclipasset
* @title: GESUriClipAsset
* @short_description: A GESAsset subclass specialized in GESUriClip extraction * @short_description: A GESAsset subclass specialized in GESUriClip extraction
* *
* The #GESUriClipAsset is a special #GESAsset that lets you handle * 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 * SECTION: gesurisourceasset
* @title: GESUriClipAsset
* @short_description: A GESAsset subclass specialized in GESUriSource extraction * @short_description: A GESAsset subclass specialized in GESUriSource extraction
* *
* NOTE: You should never request such a #GESAsset as they will be created automatically * NOTE: You should never request such a #GESAsset as they will be created automatically

View file

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

View file

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

View file

@ -20,12 +20,13 @@
/** /**
* SECTION:gesvideosource * SECTION:gesvideosource
* @title: GESVideoSource
* @short_description: Base Class for video sources * @short_description: Base Class for video sources
* *
* <refsect1 id="GESVideoSource.children_properties" role="properties"> * <refsect1 id="GESVideoSource.children_properties" role="properties">
* <title role="children_properties.title">Children Properties</title> * # Children Properties
* <para>You can use the following children properties through the * You can use the following children properties through the
* #ges_track_element_set_child_property and alike set of methods:</para> * #ges_track_element_set_child_property and alike set of methods:
* <informaltable frame="none"> * <informaltable frame="none">
* <tgroup cols="3"> * <tgroup cols="3">
* <colspec colname="properties_type" colwidth="150px"/> * <colspec colname="properties_type" colwidth="150px"/>

View file

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

View file

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

View file

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

View file

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