[tepl] docs: document Tepl 4 -> Tepl 5 API breaks



commit 2181414a40b69b4add42142c45c4c63d6b9cef6a
Author: Sébastien Wilmet <swilmet gnome org>
Date:   Sun Apr 19 01:18:38 2020 +0200

    docs: document Tepl 4 -> Tepl 5 API breaks

 docs/reference/api-breaks.xml | 33 +++++++++++++++++++++++++++++++++
 1 file changed, 33 insertions(+)
---
diff --git a/docs/reference/api-breaks.xml b/docs/reference/api-breaks.xml
index 98a933c..ea73e9f 100644
--- a/docs/reference/api-breaks.xml
+++ b/docs/reference/api-breaks.xml
@@ -120,4 +120,37 @@
       </listitem>
     </itemizedlist>
   </chapter>
+
+  <chapter id="api-breaks-4-to-5-tepl">
+    <title>Tepl 4 -> Tepl 5</title>
+
+    <itemizedlist>
+      <listitem>
+        <para>
+          The <link linkend="TeplMetadataManager">TeplMetadataManager</link> API
+          has been re-worked.
+        </para>
+      </listitem>
+      <listitem>
+        <para>
+          The <code>TeplFileMetadata</code> class has been replaced by
+          <link linkend="TeplMetadata">TeplMetadata</link>, the latter no longer
+          depends on <link linkend="TeplFile">TeplFile</link>.
+        </para>
+      </listitem>
+      <listitem>
+        <para>
+          The <code>tepl_file_get_file_metadata()</code> function has been
+          removed.
+        </para>
+      </listitem>
+      <listitem>
+        <para>
+          The <link linkend="tepl-tab-load-file">tepl_tab_load_file()</link>
+          function no longer loads the file metadata (but it was anyway an
+          implementation detail).
+        </para>
+      </listitem>
+    </itemizedlist>
+  </chapter>
 </part>


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]