Misc documentation fixing

docs/libs/ges-sections.txt

@@ -11,6 +11,9 @@ GES_VERSION_MINOR
 GES_VERSION_NANO
 <SUBSECTION Standard>
 GES_PADDING
+GES_ERROR_DOMAIN
+GES_PADDING_LARGE
+GESAssetLoadingReturn
 </SECTION>
 
 <SECTION>
@@ -275,7 +278,6 @@ ges_timeline_enable_update
 ges_timeline_is_updating
 <SUBSECTION usage>
 ges_timeline_get_tracks
-ges_timeline_get_layer
 ges_timeline_get_layers
 ges_timeline_get_track_for_pad
 ges_timeline_get_duration
@@ -299,7 +301,7 @@ GES_TYPE_TIMELINE
 GESTimelineLayer
 GESTimelineLayerClass
 ges_timeline_layer_add_object
-ges_timeline_layer_add_material
+ges_timeline_layer_add_asset
 ges_timeline_layer_new
 ges_timeline_layer_remove_object
 ges_timeline_layer_set_priority
@@ -309,6 +311,10 @@ ges_timeline_layer_get_timeline
 ges_timeline_layer_get_auto_transition
 ges_timeline_layer_set_auto_transition
 ges_timeline_layer_is_empty
+
+GES_TIMELINE_GET_LAYERS
+GES_TIMELINE_GET_TRACKS
+
 <SUBSECTION Standard>
 GESTimelineLayerPrivate
 ges_timeline_layer_set_timeline
@@ -431,14 +437,12 @@ GES_TYPE_TIMELINE_SOURCE
 GESTimelineFileSource
 ges_timeline_filesource_new
 ges_timeline_filesource_get_max_duration
-ges_timeline_filesource_get_supported_formats
 ges_timeline_filesource_get_uri
 ges_timeline_filesource_is_image
 ges_timeline_filesource_is_muted
 ges_timeline_filesource_set_is_image
 ges_timeline_filesource_set_max_duration
 ges_timeline_filesource_set_mute
-ges_timeline_filesource_set_supported_formats
 <SUBSECTION Standard>
 GESTimelineFileSourceClass
 GESTimelineFileSourcePrivate
@@ -793,19 +797,20 @@ GES_TYPE_TRACK_TEXT_OVERLAY
 <TITLE>GESFormatter</TITLE>
 GESFormatter
 GESFormatterClass
+
 GESFormatterLoadFromURIMethod
 GESFormatterSaveToURIMethod
-GESFormatterSourceMovedMethod
-GESFormatterLoadedMethod
-ges_default_formatter_new
+GESFormatterCanLoadURIMethod
+GESFormatterCanSaveURIMethod
+
+ges_formatter_class_register_metas
+
 ges_formatter_load_from_uri
 ges_formatter_save_to_uri
 ges_formatter_can_load_uri
 ges_formatter_can_save_uri
-GESFormatterCanLoadURIMethod
-GESFormatterCanSaveURIMethod
-<SUBSECTION>
-ges_formatter_emit_loaded
+ges_formatter_get_default
+
 <SUBSECTION Standard>
 GES_FORMATTER
 GES_FORMATTER_CLASS
@@ -886,7 +891,6 @@ ges_meta_container_get_int64
 ges_meta_container_get_string
 ges_meta_container_get_uint
 ges_meta_container_get_uint64
-ges_meta_container_set_meta
 ges_meta_container_set_boolean
 ges_meta_container_set_date
 ges_meta_container_set_date_time
@@ -912,6 +916,7 @@ ges_meta_container_register_meta
 ges_meta_container_metas_to_string
 ges_meta_container_add_metas_from_string
 ges_meta_container_get_type
+ges_meta_container_check_meta_registered
 
 GES_META_FORMATTER_NAME
 GES_META_FORMATTER_MIMETYPE
@@ -920,6 +925,8 @@ GES_META_FORMATTER_VERSION
 GES_META_FORMATTER_RANK
 GES_META_DESCRIPTION
 
+GES_META_TIMELINE_OBJECT_SUPPORTED_FORMATS
+
 <SUBSECTION Standard>
 GESMetaContainerInterface
 GES_IS_META_CONTAINER
@@ -994,6 +1001,7 @@ GES_ASSET_FILESOURCE_GET_CLASS
 <FILE>ges-project</FILE>
 <TITLE>GESProject</TITLE>
 GESProject
+ges_project_load
 ges_project_add_asset
 ges_project_remove_asset
 ges_project_list_assets
@@ -1005,7 +1013,6 @@ ges_project_get_uri
 ges_project_new
 ges_project_add_encoding_profile
 ges_project_list_encoding_profiles
-GESProjectFindNewUriFunction
 <SUBSECTION Standard>
 GESProjectPrivate
 GES_PROJECT

ges/ges-base-xml-formatter.h

@@ -30,18 +30,27 @@ G_BEGIN_DECLS
 #define GES_IS_BASE_XML_FORMATTER(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GES_TYPE_BASE_XML_FORMATTER))
 #define GES_IS_BASE_XML_FORMATTER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GES_TYPE_BASE_XML_FORMATTER))
 #define GES_BASE_XML_FORMATTER_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GES_TYPE_BASE_XML_FORMATTER, GESBaseXmlFormatterClass))
-typedef struct _GESBaseXmlFormatterPrivate GESBaseXmlFormatterPrivate;
 
-typedef struct
+typedef struct _GESBaseXmlFormatterPrivate GESBaseXmlFormatterPrivate;
+typedef struct _GESBaseXmlFormatter GESBaseXmlFormatter;
+typedef struct _GESBaseXmlFormatterClass GESBaseXmlFormatterClass;
+
+/**
+ * GESBaseXmlFormatter:
+ */
+struct _GESBaseXmlFormatter
 {
   GESFormatter parent;
 
   /* <private> */
   GESBaseXmlFormatterPrivate *priv;
 
-} GESBaseXmlFormatter;
+};
 
-typedef struct
+/**
+ * GESBaseXmlFormatterClass:
+ */
+struct _GESBaseXmlFormatterClass
 {
   GESFormatterClass parent;
 
@@ -50,7 +59,7 @@ typedef struct
 
   GString * (*save) (GESFormatter *formatter, GESTimeline *timeline, GError **error);
 
-} GESBaseXmlFormatterClass;
+};
 
 GType ges_base_xml_formatter_get_type    (void);
 

ges/ges-enums.h

@@ -288,6 +288,9 @@ GType ges_text_halign_get_type (void);
  * @GES_VIDEO_TEST_PATTERN_CIRCULAR: Circular pattern
  * @GES_VIDEO_TEST_PATTERN_SOLID: Solid color
  * @GES_VIDEO_TEST_PATTERN_BLINK: Alternate between black and white
+ * @GES_VIDEO_TEST_ZONE_PLATE: Zone plate
+ * @GES_VIDEO_TEST_GAMUT: Gamut checkers
+ * @GES_VIDEO_TEST_CHROMA_ZONE_PLATE: Chroma zone plate
  * @GES_VIDEO_TEST_PATTERN_SMPTE75: SMPTE test pattern (75% color bars)
  *
  * The test pattern to produce

ges/ges-extractable.h

@@ -50,7 +50,6 @@ typedef gchar* (*GESExtractableCheckId) (GType type, const gchar *id,
 
 /**
  * GESExtractable:
- * @get_asset: A #GESExtractableGetAsset function
  */
 struct _GESExtractableInterface
 {

ges/ges-formatter.h

@@ -71,6 +71,7 @@ typedef gboolean (*GESFormatterCanSaveURIMethod) (GESFormatterClass *class, cons
  * @formatter: a #GESFormatter
  * @timeline: a #GESTimeline
  * @uri: the URI to load from
+ * @error: (out) (allow-none): An error to be set in case something wrong happens or %NULL
  *
  * Virtual method for loading a timeline from a given URI.
  *
@@ -90,6 +91,7 @@ typedef gboolean (*GESFormatterLoadFromURIMethod) (GESFormatter *formatter,
  * @timeline: a #GESTimeline
  * @uri: the URI to save to
  * @overwrite: Whether the file should be overwritten in case it exists
+ * @error: (out) (allow-none): An error to be set in case something wrong happens or %NULL
  *
  * Virtual method for saving a timeline to a uri.
  *
@@ -109,8 +111,6 @@ typedef gboolean (*GESFormatterSaveToURIMethod) (GESFormatter *formatter,
  * @can_save_uri: Whether the URI can be saved
  * @load_from_uri: class method to deserialize data from a URI
  * @save_to_uri: class method to serialize data to a URI
- * @update_source_uri: virtual method to specify that a source has moved, and thus its URI
- * must be set to its new location (specified by the user)
  *
  * GES Formatter class. Override the vmethods to implement the formatter functionnality.
  */

ges/ges-meta-container.c

@@ -422,6 +422,7 @@ ges_meta_container_metas_to_string (GESMetaContainer * container)
 /**
  * ges_meta_container_add_metas_from_string:
  * @str: a string created with ges_meta_container_metas_to_string()
+ * @container: Target container
  *
  * Deserializes a meta container.
  *
@@ -851,6 +852,7 @@ ges_meta_container_get_string (GESMetaContainer * container,
 /**
  * ges_meta_container_get_meta:
  * @container: Target container
+ * @key: Get the key name of the meta to retrieve
  *
  * Gets the value of a given meta item, returns NULL if @meta_item
  * can not be found.

ges/ges-timeline-object.c

@@ -1447,7 +1447,6 @@ ges_timeline_object_edit (GESTimelineObject * object, GList * layers,
  * ges_timeline_object_split:
  * @object: the #GESTimelineObject to split
  * @position: a #GstClockTime representing the position at which to split
- * @object
  *
  * The function modifies @object, and creates another #GESTimelineObject so
  * we have two clips at the end, splitted at the time specified by @position.
@@ -1962,8 +1961,7 @@ ges_timeline_object_trim_start (GESTimelineObject * object, guint64 start)
  */
 
 gboolean
-ges_timeline_object_add_asset (GESTimelineObject * object,
-    GESAsset * asset)
+ges_timeline_object_add_asset (GESTimelineObject * object, GESAsset * asset)
 {
   g_return_val_if_fail (GES_IS_TIMELINE_OBJECT (object), FALSE);
   g_return_val_if_fail (GES_IS_ASSET (asset), FALSE);

ges/ges-timeline.c

@@ -1645,6 +1645,7 @@ ges_timeline_new (void)
 /**
  * ges_timeline_new_from_uri:
  * @uri: the URI to load from
+ * @error: (out) (allow-none): An error to be set in case something wrong happens or %NULL
  *
  * Creates a timeline from the given URI.
  *
@@ -1667,6 +1668,7 @@ ges_timeline_new_from_uri (const gchar * uri, GError ** error)
  * ges_timeline_load_from_uri:
  * @timeline: an empty #GESTimeline into which to load the formatter
  * @uri: The URI to load from
+ * @error: (out) (allow-none): An error to be set in case something wrong happens or %NULL
  *
  * Loads the contents of URI into the given timeline.
  *

ges/ges-timeline.h

@@ -50,6 +50,7 @@ G_BEGIN_DECLS
 
 /**
  * ges_timeline_get_project:
+ * @obj: The #GESTimelineObject from which to retrieve the project
  *
  * Helper macro to retrieve the project from which a #GESTimeline as been extracted
  */

ges/ges-types.h

@@ -134,9 +134,6 @@ typedef struct _GESTrackTextOverlayClass
 typedef struct _GESFormatter GESFormatter;
 typedef struct _GESFormatterClass GESFormatterClass;
 
-typedef struct _GESKeyfileFormatter GESKeyfileFormatter;
-typedef struct _GESKeyfileFormatterClass GESKeyfileFormatterClass;
-
 typedef struct _GESPitiviFormatter GESPitiviFormatter;
 typedef struct _GESPitiviFormatterClass GESPitiviFormatterClass;