mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2025-02-10 08:22:32 +00:00
Misc documentation fixes
Using "#" a in short_description screws the display
This commit is contained in:
parent
c5ad871d1c
commit
67da662276
20 changed files with 38 additions and 30 deletions
|
@ -55,6 +55,7 @@ GES_TYPE_EDGE
|
||||||
ges_edge_get_type
|
ges_edge_get_type
|
||||||
GES_TYPE_EDIT_MODE
|
GES_TYPE_EDIT_MODE
|
||||||
ges_edit_mode_get_type
|
ges_edit_mode_get_type
|
||||||
|
ges_track_type_name
|
||||||
</SECTION>
|
</SECTION>
|
||||||
|
|
||||||
<SECTION>
|
<SECTION>
|
||||||
|
@ -985,6 +986,7 @@ ges_asset_timeline_object_get_supported_formats
|
||||||
<SUBSECTION Standard>
|
<SUBSECTION Standard>
|
||||||
GESAssetTimelineObjectPrivate
|
GESAssetTimelineObjectPrivate
|
||||||
GES_ASSET_TIMELINE_OBJECT
|
GES_ASSET_TIMELINE_OBJECT
|
||||||
|
GES_TYPE_ASSET_TIMELINE_OBJECT
|
||||||
GES_ASSET_TIMELINE_OBJECT_CLASS
|
GES_ASSET_TIMELINE_OBJECT_CLASS
|
||||||
GES_IS_ASSET_TIMELINE_OBJECT
|
GES_IS_ASSET_TIMELINE_OBJECT
|
||||||
GES_IS_ASSET_TIMELINE_OBJECT_CLASS
|
GES_IS_ASSET_TIMELINE_OBJECT_CLASS
|
||||||
|
@ -994,7 +996,7 @@ GES_ASSET_TIMELINE_OBJECT_GET_CLASS
|
||||||
<SECTION>
|
<SECTION>
|
||||||
<FILE>ges-asset-track-object</FILE>
|
<FILE>ges-asset-track-object</FILE>
|
||||||
<TITLE>GESAssetTrackObject</TITLE>
|
<TITLE>GESAssetTrackObject</TITLE>
|
||||||
GESAssetObject
|
GESAssetTrackObject
|
||||||
ges_asset_track_object_get_type
|
ges_asset_track_object_get_type
|
||||||
ges_asset_track_object_get_track_type
|
ges_asset_track_object_get_track_type
|
||||||
ges_asset_track_object_set_track_type
|
ges_asset_track_object_set_track_type
|
||||||
|
@ -1034,8 +1036,9 @@ GES_ASSET_FILESOURCE_GET_CLASS
|
||||||
<TITLE>GESAssetTrackFileSource</TITLE>
|
<TITLE>GESAssetTrackFileSource</TITLE>
|
||||||
GESAssetTrackFileSource
|
GESAssetTrackFileSource
|
||||||
ges_asset_track_filesource_get_type
|
ges_asset_track_filesource_get_type
|
||||||
ges_asset_track_filesource_get_track_type
|
|
||||||
ges_asset_track_filesource_get_filesource_asset
|
ges_asset_track_filesource_get_filesource_asset
|
||||||
|
ges_asset_track_filesource_get_stream_info
|
||||||
|
ges_asset_track_filesource_get_stream_uri
|
||||||
<SUBSECTION Standard>
|
<SUBSECTION Standard>
|
||||||
GESAssetTrackFileSourcePrivate
|
GESAssetTrackFileSourcePrivate
|
||||||
GES_ASSET_TRACK_FILESOURCE
|
GES_ASSET_TRACK_FILESOURCE
|
||||||
|
|
|
@ -20,7 +20,7 @@
|
||||||
*/
|
*/
|
||||||
/**
|
/**
|
||||||
* SECTION: ges-asset-file-source
|
* SECTION: ges-asset-file-source
|
||||||
* @short_description: A #GESAsset subclass specialized in #GESTimelineFileSource extraction
|
* @short_description: A GESAsset subclass specialized in GESTimelineFileSource extraction
|
||||||
*
|
*
|
||||||
* The #GESAssetFileSource is a special #GESAsset that lets you handle
|
* The #GESAssetFileSource is a special #GESAsset that lets you handle
|
||||||
* the media file to use inside the GStreamer Editing Services. It has APIs that
|
* the media file to use inside the GStreamer Editing Services. It has APIs that
|
||||||
|
@ -449,7 +449,7 @@ ges_asset_filesource_set_timeout (GESAssetFileSourceClass * class,
|
||||||
*
|
*
|
||||||
* Get the GESAssetTrackFileSource @self containes
|
* Get the GESAssetTrackFileSource @self containes
|
||||||
*
|
*
|
||||||
* Returns: (transfer-none) (element-type GESAssetTrackFileSource): a
|
* Returns: (transfer none) (element-type GESAssetTrackFileSource): a
|
||||||
* #GList of #GESAssetTrackFileSource
|
* #GList of #GESAssetTrackFileSource
|
||||||
*/
|
*/
|
||||||
const GList *
|
const GList *
|
||||||
|
@ -465,7 +465,7 @@ ges_asset_filesource_get_stream_assets (GESAssetFileSource * self)
|
||||||
*****************************************************************/
|
*****************************************************************/
|
||||||
/**
|
/**
|
||||||
* SECTION: ges-asset-track-file-source
|
* SECTION: ges-asset-track-file-source
|
||||||
* @short_description: A #GESAsset subclass specialized in #GESTrackFileSource extraction
|
* @short_description: A GESAsset subclass specialized in GESTrackFileSource 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
|
||||||
* by #GESAssetFileSource-s.
|
* by #GESAssetFileSource-s.
|
||||||
|
@ -522,6 +522,14 @@ ges_asset_track_filesource_init (GESAssetTrackFileSource * self)
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* ges_asset_track_filesource_get_stream_info:
|
||||||
|
* @asset: A #GESAssetFileSource
|
||||||
|
*
|
||||||
|
* Get the #GstDiscovererStreamInfo user by @asset
|
||||||
|
*
|
||||||
|
* Returns: (transfer none): a #GESAssetFileSource
|
||||||
|
*/
|
||||||
GstDiscovererStreamInfo *
|
GstDiscovererStreamInfo *
|
||||||
ges_asset_track_filesource_get_stream_info (GESAssetTrackFileSource * asset)
|
ges_asset_track_filesource_get_stream_info (GESAssetTrackFileSource * asset)
|
||||||
{
|
{
|
||||||
|
@ -540,7 +548,7 @@ ges_asset_track_filesource_get_stream_uri (GESAssetTrackFileSource * asset)
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* ges_asset_track_filesource_get_filesource_asset:
|
* ges_asset_track_filesource_get_filesource_asset:
|
||||||
* @self: A #GESAssetFileSource
|
* @asset: A #GESAssetFileSource
|
||||||
*
|
*
|
||||||
* Get the #GESAssetFileSource @self is contained in
|
* Get the #GESAssetFileSource @self is contained in
|
||||||
*
|
*
|
||||||
|
|
|
@ -1,5 +1,4 @@
|
||||||
/**
|
/* Gstreamer Editing Services
|
||||||
* Gstreamer Editing Services
|
|
||||||
*
|
*
|
||||||
* Copyright (C) <2011> Thibault Saunier <thibault.saunier@collabora.com>
|
* Copyright (C) <2011> Thibault Saunier <thibault.saunier@collabora.com>
|
||||||
*
|
*
|
||||||
|
@ -20,7 +19,7 @@
|
||||||
*/
|
*/
|
||||||
/**
|
/**
|
||||||
* SECTION: ges-asset-timeline-object
|
* SECTION: ges-asset-timeline-object
|
||||||
* @short_description: A #GESAsset subclass specialized in #GESTimelineObject extraction
|
* @short_description: A GESAsset subclass specialized in GESTimelineObject extraction
|
||||||
*
|
*
|
||||||
* The #GESAssetFileSource is a special #GESAsset specilized in #GESTimelineObject.
|
* The #GESAssetFileSource is a special #GESAsset specilized in #GESTimelineObject.
|
||||||
* it is mostly used to get information about the #GESTrackType-s the objects extracted
|
* it is mostly used to get information about the #GESTrackType-s the objects extracted
|
||||||
|
|
|
@ -1,5 +1,4 @@
|
||||||
/**
|
/* Gstreamer Editing Services
|
||||||
* Gstreamer
|
|
||||||
*
|
*
|
||||||
* Copyright (C) <2012> Thibault Saunier <thibault.saunier@collabora.com>
|
* Copyright (C) <2012> Thibault Saunier <thibault.saunier@collabora.com>
|
||||||
*
|
*
|
||||||
|
@ -112,7 +111,7 @@ ges_asset_track_object_init (GESAssetTrackObject * self)
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* ges_asset_track_object_set_track_type:
|
* ges_asset_track_object_set_track_type:
|
||||||
* @self: A #GESAssetObject
|
* @asset: A #GESAssetObject
|
||||||
* @type: A #GESTrackType
|
* @type: A #GESTrackType
|
||||||
*
|
*
|
||||||
* Set the #GESAssetTrackType the #GESTrackObject extracted from @self
|
* Set the #GESAssetTrackType the #GESTrackObject extracted from @self
|
||||||
|
@ -129,7 +128,7 @@ ges_asset_track_object_set_track_type (GESAssetTrackObject * asset,
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* ges_asset_track_object_get_track_type:
|
* ges_asset_track_object_get_track_type:
|
||||||
* @self: A #GESAssetObject
|
* @asset: A #GESAssetObject
|
||||||
*
|
*
|
||||||
* Get the GESAssetTrackType the #GESTrackObject extracted from @self
|
* Get the GESAssetTrackType the #GESTrackObject extracted from @self
|
||||||
* should get into
|
* should get into
|
||||||
|
|
|
@ -20,7 +20,7 @@
|
||||||
*/
|
*/
|
||||||
/**
|
/**
|
||||||
* SECTION: ges-asset
|
* SECTION: ges-asset
|
||||||
* @short_description: #GESAssets represent usable ressources inside the GStreamer Editing Services
|
* @short_description: Represents usable ressources inside the GStreamer Editing Services
|
||||||
*
|
*
|
||||||
* The Assets in the GStreamer Editing Services represent the ressources
|
* The Assets in the GStreamer Editing Services represent the ressources
|
||||||
* that can be used. You can create assets for any type that implements the #GESExtractable
|
* that can be used. You can create assets for any type that implements the #GESExtractable
|
||||||
|
|
|
@ -20,7 +20,7 @@
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* SECTION:ges-custom-timeline-source
|
* SECTION:ges-custom-timeline-source
|
||||||
* @short_description: Convenience #GESTimelineSource
|
* @short_description: Convenience GESTimelineSource
|
||||||
*
|
*
|
||||||
* #GESCustomTimelineSource allows creating #GESTimelineSource(s) without the
|
* #GESCustomTimelineSource allows creating #GESTimelineSource(s) without the
|
||||||
* need to subclass.
|
* need to subclass.
|
||||||
|
|
|
@ -20,7 +20,7 @@
|
||||||
*/
|
*/
|
||||||
/**
|
/**
|
||||||
* SECTION: ges-extractable
|
* SECTION: ges-extractable
|
||||||
* @short_description: An interface letting an object be extracted from a #GESAsset
|
* @short_description: An interface letting an object be extracted from a GESAsset
|
||||||
*
|
*
|
||||||
* FIXME: Long description needed
|
* FIXME: Long description needed
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -19,7 +19,7 @@
|
||||||
*/
|
*/
|
||||||
/**
|
/**
|
||||||
* SECTION: ges-project
|
* SECTION: ges-project
|
||||||
* @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
|
||||||
* #GESAsset with #GES_TYPE_TIMELINE as @extractable_type itself. That
|
* #GESAsset with #GES_TYPE_TIMELINE as @extractable_type itself. That
|
||||||
|
|
|
@ -20,7 +20,7 @@
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* SECTION:ges-simple-timeline-layer
|
* SECTION:ges-simple-timeline-layer
|
||||||
* @short_description: High-level #GESTimelineLayer
|
* @short_description: High-level GESTimelineLayer
|
||||||
*
|
*
|
||||||
* #GESSimpleTimelineLayer allows using #GESTimelineObject(s) with a list-like
|
* #GESSimpleTimelineLayer allows using #GESTimelineObject(s) with a list-like
|
||||||
* API. Clients can add any type of GESTimelineObject to a
|
* API. Clients can add any type of GESTimelineObject to a
|
||||||
|
|
|
@ -19,7 +19,7 @@
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* SECTION: ges-timeline-effect
|
* SECTION: ges-timeline-effect
|
||||||
* @short_description: An effect in a #GESTimelineLayer
|
* @short_description: An effect in a GESTimelineLayer
|
||||||
*
|
*
|
||||||
* The effect will be applied on the sources that have lower priorities
|
* The effect will be applied on the sources that have lower priorities
|
||||||
* (higher number) between the inpoint and the end of it.
|
* (higher number) between the inpoint and the end of it.
|
||||||
|
|
|
@ -21,7 +21,7 @@
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* SECTION:ges-timeline-layer
|
* SECTION:ges-timeline-layer
|
||||||
* @short_description: Non-overlapping sequence of #GESTimelineObject
|
* @short_description: Non-overlapping sequence of GESTimelineObject
|
||||||
*
|
*
|
||||||
* Responsible for the ordering of the various contained TimelineObject(s). A
|
* Responsible for the ordering of the various contained TimelineObject(s). A
|
||||||
* timeline layer has a "priority" property, which is used to manage the
|
* timeline layer has a "priority" property, which is used to manage the
|
||||||
|
|
|
@ -22,7 +22,7 @@
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* SECTION:ges-timeline-object
|
* SECTION:ges-timeline-object
|
||||||
* @short_description: Base Class for objects in a #GESTimelineLayer
|
* @short_description: Base Class for objects in a GESTimelineLayer
|
||||||
*
|
*
|
||||||
* A #GESTimelineObject is a 'natural' object which controls one or more
|
* A #GESTimelineObject is a 'natural' object which controls one or more
|
||||||
* #GESTrackObject(s) in one or more #GESTrack(s).
|
* #GESTrackObject(s) in one or more #GESTrack(s).
|
||||||
|
@ -476,7 +476,7 @@ ges_timeline_object_create_track_object (GESTimelineObject * object,
|
||||||
*
|
*
|
||||||
* Creates all #GESTrackObjects supported by this object for the track type.
|
* Creates all #GESTrackObjects supported by this object for the track type.
|
||||||
*
|
*
|
||||||
* Returns: (element-type GESTrackObject) (transfer-full): A #GList of
|
* Returns: (element-type GESTrackObject) (transfer full): A #GList of
|
||||||
* newly created #GESTrackObject-s
|
* newly created #GESTrackObject-s
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
|
|
@ -36,7 +36,6 @@ G_BEGIN_DECLS
|
||||||
#define GES_TIMELINE_OBJECT_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GES_TYPE_TIMELINE_OBJECT, GESTimelineObjectClass))
|
#define GES_TIMELINE_OBJECT_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GES_TYPE_TIMELINE_OBJECT, GESTimelineObjectClass))
|
||||||
|
|
||||||
typedef struct _GESTimelineObjectPrivate GESTimelineObjectPrivate;
|
typedef struct _GESTimelineObjectPrivate GESTimelineObjectPrivate;
|
||||||
typedef struct _GESTimelineObjectClassPrivate GESTimelineObjectClassPrivate;
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* GESFillTrackObjectFunc:
|
* GESFillTrackObjectFunc:
|
||||||
|
|
|
@ -20,7 +20,7 @@
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* SECTION:ges-timeline-operation
|
* SECTION:ges-timeline-operation
|
||||||
* @short_description: Base Class for operations in a #GESTimelineLayer
|
* @short_description: Base Class for operations in a GESTimelineLayer
|
||||||
*
|
*
|
||||||
* Operations are any kind of object that both outputs AND consumes data.
|
* Operations are any kind of object that both outputs AND consumes data.
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -20,7 +20,7 @@
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* SECTION:ges-timeline-overlay
|
* SECTION:ges-timeline-overlay
|
||||||
* @short_description: Base Class for overlays in a #GESTimelineLayer
|
* @short_description: Base Class for overlays in a GESTimelineLayer
|
||||||
*
|
*
|
||||||
* Overlays are objects which modify the underlying layer(s).
|
* Overlays are objects which modify the underlying layer(s).
|
||||||
*
|
*
|
||||||
|
|
|
@ -20,7 +20,7 @@
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* SECTION:ges-timeline-pipeline
|
* SECTION:ges-timeline-pipeline
|
||||||
* @short_description: Convenience #GstPipeline for editing.
|
* @short_description: Convenience GstPipeline for editing.
|
||||||
*
|
*
|
||||||
* #GESTimelinePipeline allows developers to view and render #GESTimeline
|
* #GESTimelinePipeline allows developers to view and render #GESTimeline
|
||||||
* in a simple fashion.
|
* in a simple fashion.
|
||||||
|
|
|
@ -20,7 +20,7 @@
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* SECTION:ges-timeline-source
|
* SECTION:ges-timeline-source
|
||||||
* @short_description: Base Class for sources of a #GESTimelineLayer
|
* @short_description: Base Class for sources of a GESTimelineLayer
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#include "ges-internal.h"
|
#include "ges-internal.h"
|
||||||
|
|
|
@ -20,7 +20,7 @@
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* SECTION:ges-timeline-text-overlay
|
* SECTION:ges-timeline-text-overlay
|
||||||
* @short_description: Render text onto another stream in a #GESTimelineLayer
|
* @short_description: Render text onto another stream in a GESTimelineLayer
|
||||||
*
|
*
|
||||||
* Renders text onto the next lower priority stream using textrender.
|
* Renders text onto the next lower priority stream using textrender.
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -19,7 +19,7 @@
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* SECTION:ges-track-effect
|
* SECTION:ges-track-effect
|
||||||
* @short_description: adds an effect to a stream in a #GESTimelineSource or a
|
* @short_description: adds an effect to a stream in a GESTimelineSource or a
|
||||||
* #GESTimelineLayer
|
* #GESTimelineLayer
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
|
|
@ -20,7 +20,7 @@
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* SECTION:ges-track-object
|
* SECTION:ges-track-object
|
||||||
* @short_description: Base Class for objects contained in a #GESTrack
|
* @short_description: Base Class for objects contained in a GESTrack
|
||||||
*
|
*
|
||||||
* #GESTrackObject is the Base Class for any object that can be contained in a
|
* #GESTrackObject is the Base Class for any object that can be contained in a
|
||||||
* #GESTrack.
|
* #GESTrack.
|
||||||
|
|
Loading…
Reference in a new issue