docs: Minor fixes
authorThibault Saunier <tsaunier@igalia.com>
Mon, 22 Oct 2018 09:39:03 +0000 (11:39 +0200)
committerThibault Saunier <tsaunier@igalia.com>
Mon, 13 May 2019 14:30:19 +0000 (10:30 -0400)
ges/ges-asset.c
ges/ges-pitivi-formatter.h
ges/ges-project.c
ges/ges-track-element-asset.c
ges/ges-track-element.c
ges/ges-uri-asset.c
ges/ges.c
ges/meson.build

index 0bd1d33..cd0e16c 100644 (file)
@@ -1340,7 +1340,7 @@ ges_asset_request_finish (GAsyncResult * res, GError ** error)
 
 /**
  * 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
  *
  * List all @asset filtering per filter as defined by @filter.
index f32af5d..c872b88 100644 (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
  */
index 278fb6e..5f5baab 100644 (file)
@@ -23,7 +23,7 @@
  * @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
+ * #GESAsset with `GES_TYPE_TIMELINE` as @extractable_type itself. That
  * 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
  * @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.
  *
  * 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:
  * @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
  *
  * List all @asset contained in @project filtering per extractable_type
index d6ed7a2..97d4fcf 100644 (file)
@@ -111,10 +111,10 @@ ges_track_element_asset_init (GESTrackElementAsset * self)
 
 /**
  * ges_track_element_asset_set_track_type:
- * @asset: A #GESAssetObject
+ * @asset: A #GESAsset
  * @type: A #GESTrackType
  *
- * Set the #GESAssetTrackType the #GESTrackElement extracted from @self
+ * Set the #GESTrackType the #GESTrackElement extracted from @self
  * should get into
  */
 void
@@ -128,7 +128,7 @@ ges_track_element_asset_set_track_type (GESTrackElementAsset * asset,
 
 /**
  * ges_track_element_asset_get_track_type:
- * @asset: A #GESAssetObject
+ * @asset: A #GESAsset
  *
  * Get the GESAssetTrackType the #GESTrackElement extracted from @self
  * should get into
index c0b7098..d7a8b37 100644 (file)
@@ -827,7 +827,7 @@ ges_track_element_set_track (GESTrackElement * object, GESTrack * track)
 
 /**
  * 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
  * #GHashTable containing all property_name: GstControlBinding
index e5cf547..fea512d 100644 (file)
@@ -467,8 +467,7 @@ ges_uri_clip_asset_get_duration (GESUriClipAsset * self)
 
 /**
  * ges_uri_clip_asset_is_image:
- * @self: a #indent: Standard input:311: Error:Unexpected end of file
-GESUriClipAsset
+ * @self: a #GESUriClipAsset
  *
  * Gets Whether the file represented by @self is an image or not
  *
index 0d2e09a..78df326 100644 (file)
--- a/ges/ges.c
+++ b/ges/ges.c
  * 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
  * Add a deinit function
  *
index 8b57f61..7688a03 100644 (file)
@@ -126,8 +126,8 @@ ges_headers = [
 ]
 
 if libxml_dep.found()
-  ges_sources += ['ges-pitivi-formatter.c']
-  ges_headers += ['ges-pitivi-formatter.h']
+  ges_sources += files(['ges-pitivi-formatter.c'])
+  ges_headers += files(['ges-pitivi-formatter.h'])
 endif
 
 version_data = configuration_data()