docs: Add a pitivi-formatter documentation

Move the API to the API section of the pitivi-formatter file

diff --git a/docs/libs/ges-docs.sgml b/docs/libs/ges-docs.sgml
index b64ca85260ccf4aa44d3a2c71557a682d20e34f3..ce0a2f5a782b3caa2a1679036bc9a59ada1ff1ab 100644 (file)
--- a/docs/libs/ges-docs.sgml
+++ b/docs/libs/ges-docs.sgml
@@ -88,6 +88,7 @@ platform as well as Windows. It is released under the GNU Library General Public
     <title>Serialization Classes</title>
     <xi:include href="xml/ges-formatter.xml"/>
     <xi:include href="xml/ges-keyfile-formatter.xml"/>
+    <xi:include href="xml/ges-pitivi-formatter.xml"/>
   </chapter>
 
   <chapter id="ges-hierarchy">

diff --git a/docs/libs/ges-sections.txt b/docs/libs/ges-sections.txt
index 6a0f8cae8b1204357bdfda5445e2fadf07d9a2b4..6e990455fb124349cd361f3597b6a9b9d3287be0 100644 (file)
--- a/docs/libs/ges-sections.txt
+++ b/docs/libs/ges-sections.txt
@@ -796,6 +796,24 @@ GES_TYPE_KEYFILE_FORMATTER
 ges_keyfile_formatter_get_type
 </SECTION>
 
+<SECTION>
+<FILE>ges-pitivi-formatter</FILE>
+<TITLE>GESPitiviFormatter</TITLE>
+GESPitiviFormatter
+ges_pitivi_formatter_new
+ges_pitivi_formatter_set_sources
+ges_pitivi_formatter_get_sources
+<SUBSECTION Standard>
+GESPitiviFormatterClass
+GES_IS_PITIVI_FORMATTER
+GES_IS_PITIVI_FORMATTER_CLASS
+GES_PITIVI_FORMATTER
+GES_PITIVI_FORMATTER_CLASS
+GES_PITIVI_FORMATTER_GET_CLASS
+GES_TYPE_PITIVIFORMATTER
+ges_pitivi_formatter_get_type
+</SECTION>
+
 <SECTION>
 <FILE>ges-track-effect</FILE>
 <TITLE>GESTrackEffect</TITLE>

diff --git a/ges/ges-pitivi-formatter.c b/ges/ges-pitivi-formatter.c
index 85fb6ed343d253af4490b11ee47b2b67f0b67f5b..e2f7131ce0190603314eab895cd99f35f13c3ba2 100644 (file)
--- a/ges/ges-pitivi-formatter.c
+++ b/ges/ges-pitivi-formatter.c
@@ -488,21 +488,6 @@ save_pitivi_timeline_to_uri (GESFormatter * formatter,
   return TRUE;
 }
 
-GList *
-ges_pitivi_formatter_get_sources (GESPitiviFormatter * formatter)
-{
-  GList *sources = NULL;
-  GHashTableIter iter;
-  gpointer key, value;
-
-  g_hash_table_iter_init (&iter, formatter->priv->source_uris);
-  while (g_hash_table_iter_next (&iter, &key, &value)) {
-    sources = g_list_prepend (sources, g_strdup (value));
-  }
-
-  return sources;
-}
-
 /* Project loading functions */
 
 /* Return: a GHashTable containing:
@@ -1082,7 +1067,19 @@ pitivi_formatter_update_source_uri (GESFormatter * formatter,
   return ret;
 }
 
-/*  API  */
+/* API */
+
+/**
+ * ges_pitivi_formatter_set_sources:
+ * @formatter: The #GESPitiviFormatter to set sources on
+ * @infos: (transfer none): (element-type GstDiscovererInfo):
+ *        The #GstDiscovererInfo infos to add as sources.
+ *
+ * Add @infos as the formatter sources so we can save sources that are
+ * not in the timeline when saving.
+ *
+ * Returns: %TRUE if everything wen fine, %FALSE otherwise
+ */
 gboolean
 ges_pitivi_formatter_set_sources (GESPitiviFormatter * formatter, GList * infos)
 {
@@ -1105,3 +1102,25 @@ ges_pitivi_formatter_set_sources (GESPitiviFormatter * formatter, GList * infos)
 
   return TRUE;
 }
+
+/**
+ * ges_pitivi_formatter_get_sources:
+ * @formatter: The #GESPitiviFormatter to get sources from
+ *
+ * Returns: (transfer full): (element-type utf8): %TRUE if everything went
+ * fine, %FALSE otherwise
+ */
+GList *
+ges_pitivi_formatter_get_sources (GESPitiviFormatter * formatter)
+{
+  GList *sources = NULL;
+  GHashTableIter iter;
+  gpointer key, value;
+
+  g_hash_table_iter_init (&iter, formatter->priv->source_uris);
+  while (g_hash_table_iter_next (&iter, &key, &value)) {
+    sources = g_list_prepend (sources, g_strdup (value));
+  }
+
+  return sources;
+}

diff --git a/ges/ges-pitivi-formatter.h b/ges/ges-pitivi-formatter.h
index 092114ab4cf518a34327383a41253c8f3107956e..50fac437bca5d8b2b87343cbe9e61d038479ccda 100644 (file)
--- a/ges/ges-pitivi-formatter.h
+++ b/ges/ges-pitivi-formatter.h
@@ -56,7 +56,7 @@ GType ges_pitivi_formatter_get_type (void);
 
 GESPitiviFormatter *ges_pitivi_formatter_new (void);
 
-gboolean ges_pitivi_formatter_set_sources (GESPitiviFormatter * formatter, GList * uris);
+gboolean ges_pitivi_formatter_set_sources (GESPitiviFormatter * formatter, GList * infos);
 
 GList * ges_pitivi_formatter_get_sources(GESPitiviFormatter * formatter);