From 67da6622766d38cc5a0621eba72e8259bcda3aba Mon Sep 17 00:00:00 2001 From: Thibault Saunier Date: Fri, 21 Dec 2012 20:17:41 -0300 Subject: [PATCH] Misc documentation fixes Using "#" a in short_description screws the display --- docs/libs/ges-sections.txt | 7 +++++-- ges/ges-asset-file-source.c | 16 ++++++++++++---- ges/ges-asset-timeline-object.c | 5 ++--- ges/ges-asset-track-object.c | 7 +++---- ges/ges-asset.c | 2 +- ges/ges-custom-timeline-source.c | 2 +- ges/ges-extractable.c | 2 +- ges/ges-project.c | 2 +- ges/ges-simple-timeline-layer.c | 2 +- ges/ges-timeline-effect.c | 2 +- ges/ges-timeline-layer.c | 2 +- ges/ges-timeline-object.c | 4 ++-- ges/ges-timeline-object.h | 1 - ges/ges-timeline-operation.c | 2 +- ges/ges-timeline-overlay.c | 2 +- ges/ges-timeline-pipeline.c | 2 +- ges/ges-timeline-source.c | 2 +- ges/ges-timeline-text-overlay.c | 2 +- ges/ges-track-effect.c | 2 +- ges/ges-track-object.c | 2 +- 20 files changed, 38 insertions(+), 30 deletions(-) diff --git a/docs/libs/ges-sections.txt b/docs/libs/ges-sections.txt index b20453c6083..7d34af32c87 100644 --- a/docs/libs/ges-sections.txt +++ b/docs/libs/ges-sections.txt @@ -55,6 +55,7 @@ GES_TYPE_EDGE ges_edge_get_type GES_TYPE_EDIT_MODE ges_edit_mode_get_type +ges_track_type_name
@@ -985,6 +986,7 @@ ges_asset_timeline_object_get_supported_formats GESAssetTimelineObjectPrivate GES_ASSET_TIMELINE_OBJECT +GES_TYPE_ASSET_TIMELINE_OBJECT GES_ASSET_TIMELINE_OBJECT_CLASS GES_IS_ASSET_TIMELINE_OBJECT GES_IS_ASSET_TIMELINE_OBJECT_CLASS @@ -994,7 +996,7 @@ GES_ASSET_TIMELINE_OBJECT_GET_CLASS
ges-asset-track-object GESAssetTrackObject -GESAssetObject +GESAssetTrackObject ges_asset_track_object_get_type ges_asset_track_object_get_track_type ges_asset_track_object_set_track_type @@ -1034,8 +1036,9 @@ GES_ASSET_FILESOURCE_GET_CLASS GESAssetTrackFileSource GESAssetTrackFileSource 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_stream_info +ges_asset_track_filesource_get_stream_uri GESAssetTrackFileSourcePrivate GES_ASSET_TRACK_FILESOURCE diff --git a/ges/ges-asset-file-source.c b/ges/ges-asset-file-source.c index baf62f7d267..be39ff2d5e7 100644 --- a/ges/ges-asset-file-source.c +++ b/ges/ges-asset-file-source.c @@ -20,7 +20,7 @@ */ /** * 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 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 * - * Returns: (transfer-none) (element-type GESAssetTrackFileSource): a + * Returns: (transfer none) (element-type GESAssetTrackFileSource): a * #GList of #GESAssetTrackFileSource */ const GList * @@ -465,7 +465,7 @@ ges_asset_filesource_get_stream_assets (GESAssetFileSource * self) *****************************************************************/ /** * 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 * 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 * 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: - * @self: A #GESAssetFileSource + * @asset: A #GESAssetFileSource * * Get the #GESAssetFileSource @self is contained in * diff --git a/ges/ges-asset-timeline-object.c b/ges/ges-asset-timeline-object.c index 635766dda0a..11157173dc7 100644 --- a/ges/ges-asset-timeline-object.c +++ b/ges/ges-asset-timeline-object.c @@ -1,5 +1,4 @@ -/** - * Gstreamer Editing Services +/* Gstreamer Editing Services * * Copyright (C) <2011> Thibault Saunier * @@ -20,7 +19,7 @@ */ /** * 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. * it is mostly used to get information about the #GESTrackType-s the objects extracted diff --git a/ges/ges-asset-track-object.c b/ges/ges-asset-track-object.c index 09aa834fc7b..794736ab042 100644 --- a/ges/ges-asset-track-object.c +++ b/ges/ges-asset-track-object.c @@ -1,5 +1,4 @@ -/** - * Gstreamer +/* Gstreamer Editing Services * * Copyright (C) <2012> Thibault Saunier * @@ -112,7 +111,7 @@ ges_asset_track_object_init (GESAssetTrackObject * self) /** * ges_asset_track_object_set_track_type: - * @self: A #GESAssetObject + * @asset: A #GESAssetObject * @type: A #GESTrackType * * 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: - * @self: A #GESAssetObject + * @asset: A #GESAssetObject * * Get the GESAssetTrackType the #GESTrackObject extracted from @self * should get into diff --git a/ges/ges-asset.c b/ges/ges-asset.c index 48fddcb6f9d..cb417df0b5e 100644 --- a/ges/ges-asset.c +++ b/ges/ges-asset.c @@ -20,7 +20,7 @@ */ /** * 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 * that can be used. You can create assets for any type that implements the #GESExtractable diff --git a/ges/ges-custom-timeline-source.c b/ges/ges-custom-timeline-source.c index a6dcfe484fa..22a96b5bf79 100644 --- a/ges/ges-custom-timeline-source.c +++ b/ges/ges-custom-timeline-source.c @@ -20,7 +20,7 @@ /** * SECTION:ges-custom-timeline-source - * @short_description: Convenience #GESTimelineSource + * @short_description: Convenience GESTimelineSource * * #GESCustomTimelineSource allows creating #GESTimelineSource(s) without the * need to subclass. diff --git a/ges/ges-extractable.c b/ges/ges-extractable.c index 8be5a37819f..128ffaabce4 100644 --- a/ges/ges-extractable.c +++ b/ges/ges-extractable.c @@ -20,7 +20,7 @@ */ /** * 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 */ diff --git a/ges/ges-project.c b/ges/ges-project.c index e5b91ab17dd..ea22990a8da 100644 --- a/ges/ges-project.c +++ b/ges/ges-project.c @@ -19,7 +19,7 @@ */ /** * 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 * #GESAsset with #GES_TYPE_TIMELINE as @extractable_type itself. That diff --git a/ges/ges-simple-timeline-layer.c b/ges/ges-simple-timeline-layer.c index 1d24be8373c..6c22214bed6 100644 --- a/ges/ges-simple-timeline-layer.c +++ b/ges/ges-simple-timeline-layer.c @@ -20,7 +20,7 @@ /** * SECTION:ges-simple-timeline-layer - * @short_description: High-level #GESTimelineLayer + * @short_description: High-level GESTimelineLayer * * #GESSimpleTimelineLayer allows using #GESTimelineObject(s) with a list-like * API. Clients can add any type of GESTimelineObject to a diff --git a/ges/ges-timeline-effect.c b/ges/ges-timeline-effect.c index 21d7a69d333..245c1a9ca1e 100644 --- a/ges/ges-timeline-effect.c +++ b/ges/ges-timeline-effect.c @@ -19,7 +19,7 @@ /** * 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 * (higher number) between the inpoint and the end of it. diff --git a/ges/ges-timeline-layer.c b/ges/ges-timeline-layer.c index dd63aef0138..1f4edd6bfd5 100644 --- a/ges/ges-timeline-layer.c +++ b/ges/ges-timeline-layer.c @@ -21,7 +21,7 @@ /** * 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 * timeline layer has a "priority" property, which is used to manage the diff --git a/ges/ges-timeline-object.c b/ges/ges-timeline-object.c index 5a1d3da6160..d027f6afa01 100644 --- a/ges/ges-timeline-object.c +++ b/ges/ges-timeline-object.c @@ -22,7 +22,7 @@ /** * 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 * #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. * - * Returns: (element-type GESTrackObject) (transfer-full): A #GList of + * Returns: (element-type GESTrackObject) (transfer full): A #GList of * newly created #GESTrackObject-s */ diff --git a/ges/ges-timeline-object.h b/ges/ges-timeline-object.h index 4b6dbe02e9d..d955cfe5aa5 100644 --- a/ges/ges-timeline-object.h +++ b/ges/ges-timeline-object.h @@ -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)) typedef struct _GESTimelineObjectPrivate GESTimelineObjectPrivate; -typedef struct _GESTimelineObjectClassPrivate GESTimelineObjectClassPrivate; /** * GESFillTrackObjectFunc: diff --git a/ges/ges-timeline-operation.c b/ges/ges-timeline-operation.c index 3fc2396a6c9..27a8c432674 100644 --- a/ges/ges-timeline-operation.c +++ b/ges/ges-timeline-operation.c @@ -20,7 +20,7 @@ /** * 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. */ diff --git a/ges/ges-timeline-overlay.c b/ges/ges-timeline-overlay.c index 7bab868eea5..aaffcaf1388 100644 --- a/ges/ges-timeline-overlay.c +++ b/ges/ges-timeline-overlay.c @@ -20,7 +20,7 @@ /** * 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). * diff --git a/ges/ges-timeline-pipeline.c b/ges/ges-timeline-pipeline.c index 37a5fdb0be2..95fedece51d 100644 --- a/ges/ges-timeline-pipeline.c +++ b/ges/ges-timeline-pipeline.c @@ -20,7 +20,7 @@ /** * SECTION:ges-timeline-pipeline - * @short_description: Convenience #GstPipeline for editing. + * @short_description: Convenience GstPipeline for editing. * * #GESTimelinePipeline allows developers to view and render #GESTimeline * in a simple fashion. diff --git a/ges/ges-timeline-source.c b/ges/ges-timeline-source.c index 323acc08c9b..d353414b1bb 100644 --- a/ges/ges-timeline-source.c +++ b/ges/ges-timeline-source.c @@ -20,7 +20,7 @@ /** * 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" diff --git a/ges/ges-timeline-text-overlay.c b/ges/ges-timeline-text-overlay.c index 405452f7e95..7adeb082838 100644 --- a/ges/ges-timeline-text-overlay.c +++ b/ges/ges-timeline-text-overlay.c @@ -20,7 +20,7 @@ /** * 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. */ diff --git a/ges/ges-track-effect.c b/ges/ges-track-effect.c index bbe33b8a959..6a5752301bb 100644 --- a/ges/ges-track-effect.c +++ b/ges/ges-track-effect.c @@ -19,7 +19,7 @@ /** * 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 */ diff --git a/ges/ges-track-object.c b/ges/ges-track-object.c index b53f7876623..a23e129360f 100644 --- a/ges/ges-track-object.c +++ b/ges/ges-track-object.c @@ -20,7 +20,7 @@ /** * 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 * #GESTrack.