docs: Minor fixes

This commit is contained in:
Thibault Saunier 2018-10-22 11:39:03 +02:00
parent 297ee7b4a0
commit 5caf822526
8 changed files with 20 additions and 13 deletions

View file

@ -1340,7 +1340,7 @@ ges_asset_request_finish (GAsyncResult * res, GError ** error)
/** /**
* ges_list_assets: * ges_list_assets:
* @filter: Type of assets to list, #GES_TYPE_EXTRACTABLE will list * @filter: Type of assets to list, `GES_TYPE_EXTRACTABLE` will list
* all assets * all assets
* *
* List all @asset filtering per filter as defined by @filter. * List all @asset filtering per filter as defined by @filter.

View file

@ -43,7 +43,7 @@ typedef struct _GESPitiviFormatterPrivate GESPitiviFormatterPrivate;
/** /**
* GESPitiviFormatter: * GESPitiviFormatter: (attributes doc.skip=true):
* *
* Serializes a #GESTimeline to a file using the xptv Pitivi file format * Serializes a #GESTimeline to a file using the xptv Pitivi file format
*/ */

View file

@ -23,7 +23,7 @@
* @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
* means that you can extract #GESTimeline from a project as followed: * means that you can extract #GESTimeline from a project as followed:
* *
* |[ * |[
@ -824,7 +824,7 @@ ges_project_create_asset_sync (GESProject * project, const gchar * id,
* @project: A #GESProject * @project: A #GESProject
* @asset: (transfer none): A #GESAsset to add to @project * @asset: (transfer none): A #GESAsset to add to @project
* *
* Adds a #Asset to @project, the project will keep a reference on * Adds a #GESAsset to @project, the project will keep a reference on
* @asset. * @asset.
* *
* Returns: %TRUE if the asset could be added %FALSE it was already * Returns: %TRUE if the asset could be added %FALSE it was already
@ -901,7 +901,7 @@ ges_project_get_asset (GESProject * project, const gchar * id,
/** /**
* ges_project_list_assets: * ges_project_list_assets:
* @project: A #GESProject * @project: A #GESProject
* @filter: Type of assets to list, #GES_TYPE_EXTRACTABLE will list * @filter: Type of assets to list, `GES_TYPE_EXTRACTABLE` will list
* all assets * all assets
* *
* List all @asset contained in @project filtering per extractable_type * List all @asset contained in @project filtering per extractable_type

View file

@ -111,10 +111,10 @@ ges_track_element_asset_init (GESTrackElementAsset * self)
/** /**
* ges_track_element_asset_set_track_type: * ges_track_element_asset_set_track_type:
* @asset: A #GESAssetObject * @asset: A #GESAsset
* @type: A #GESTrackType * @type: A #GESTrackType
* *
* Set the #GESAssetTrackType the #GESTrackElement extracted from @self * Set the #GESTrackType the #GESTrackElement extracted from @self
* should get into * should get into
*/ */
void void
@ -128,7 +128,7 @@ ges_track_element_asset_set_track_type (GESTrackElementAsset * asset,
/** /**
* ges_track_element_asset_get_track_type: * ges_track_element_asset_get_track_type:
* @asset: A #GESAssetObject * @asset: A #GESAsset
* *
* Get the GESAssetTrackType the #GESTrackElement extracted from @self * Get the GESAssetTrackType the #GESTrackElement extracted from @self
* should get into * should get into

View file

@ -827,7 +827,7 @@ ges_track_element_set_track (GESTrackElement * object, GESTrack * track)
/** /**
* ges_track_element_get_all_control_bindings * ges_track_element_get_all_control_bindings
* @trackelement: The #TrackElement from which to get all set bindings * @trackelement: The #GESTrackElement from which to get all set bindings
* *
* Returns: (element-type gchar* GstControlBinding)(transfer none): A * Returns: (element-type gchar* GstControlBinding)(transfer none): A
* #GHashTable containing all property_name: GstControlBinding * #GHashTable containing all property_name: GstControlBinding

View file

@ -467,8 +467,7 @@ ges_uri_clip_asset_get_duration (GESUriClipAsset * self)
/** /**
* ges_uri_clip_asset_is_image: * ges_uri_clip_asset_is_image:
* @self: a #indent: Standard input:311: Error:Unexpected end of file * @self: a #GESUriClipAsset
GESUriClipAsset
* *
* Gets Whether the file represented by @self is an image or not * Gets Whether the file represented by @self is an image or not
* *

View file

@ -18,6 +18,14 @@
* Boston, MA 02110-1301, USA. * Boston, MA 02110-1301, USA.
*/ */
/**
* SECTION: ges.h
* @title: Initialization
* @short_description: GStreamer editing services initialization functions
*
* GES needs to be initialized after GStreamer itself. This section
* contains the various functions to do so.
*/
/* TODO /* TODO
* Add a deinit function * Add a deinit function
* *

View file

@ -126,8 +126,8 @@ ges_headers = [
] ]
if libxml_dep.found() if libxml_dep.found()
ges_sources += ['ges-pitivi-formatter.c'] ges_sources += files(['ges-pitivi-formatter.c'])
ges_headers += ['ges-pitivi-formatter.h'] ges_headers += files(['ges-pitivi-formatter.h'])
endif endif
version_data = configuration_data() version_data = configuration_data()