[devhelp] docs: API breaks in reverse chronological order

From: Sébastien Wilmet <swilmet src gnome org>
To: commits-list gnome org
Cc:
Subject: [devhelp] docs: API breaks in reverse chronological order
Date: Fri, 11 May 2018 13:33:26 +0000 (UTC)
commit 739ecc701b8f51553d369c68c7ed29cdb480a3e4
Author: Sébastien Wilmet <swilmet gnome org>
Date:   Fri May 11 14:58:41 2018 +0200

    docs: API breaks in reverse chronological order
    
    The most recent first, to not need to scroll down the page each time.
    Like a NEWS file.

 docs/reference/api-breaks.xml |  244 ++++++++++++++++++++--------------------
 1 files changed, 122 insertions(+), 122 deletions(-)
---
diff --git a/docs/reference/api-breaks.xml b/docs/reference/api-breaks.xml
index eac40f2..9dad980 100644
--- a/docs/reference/api-breaks.xml
+++ b/docs/reference/api-breaks.xml
@@ -28,107 +28,99 @@
   </para>
 
   <refsect1>
-    <title>3.24 -> 3.25.1</title>
+    <title>3.29.1 -> 3.29.2</title>
     <itemizedlist>
       <listitem>
         <para>
-          All deprecated APIs have been removed.
+          <link linkend="DhBookManager">DhBookManager</link> is now completely
+          empty and entirely deprecated, the minimum amount of API is kept to
+          not break Anjuta. It has been replaced by a more flexible
+          infrastructure: <link linkend="DhProfile">DhProfile</link>,
+          <link linkend="DhSettings">DhSettings</link> and
+          <link linkend="DhBookList">DhBookList</link>. If your application uses
+          only the default libdevhelp widgets it will still work fine – even if
+          you don't adapt the code of the application – because in that case it
+          will use the default profile, which contains the same content as how
+          <link linkend="DhBookManager">DhBookManager</link> was implemented.
         </para>
       </listitem>
       <listitem>
         <para>
-          dh-error.h is now private.
+          Whether a <link linkend="DhBook">DhBook</link> is enabled is now
+          decoupled from <link linkend="DhBook">DhBook</link>:
+          <code>dh_book_get_enabled()</code> and
+          <code>dh_book_set_enabled()</code> have been removed, as well as the
+          <code>DhBook::enabled</code> and <code>DhBook::disabled</code>
+          signals. For a book to be enabled it now needs to be part
+          of a <link linkend="DhBookList">DhBookList</link>, which is more
+          flexible because there can be several different
+          <link linkend="DhBookList">DhBookList</link>'s in parallel.
         </para>
       </listitem>
       <listitem>
         <para>
-          The <code>DhApp</code>, <code>DhAssistant</code> and
-          <code>DhWindow</code> classes are now private. <code>DhApp</code> is a
-          subclass of <code>GtkApplication</code>, and an application can have
-          only one <code>GtkApplication</code> instance, so as-is
-          <code>DhApp</code> didn't make sense in the library (what if two
-          different libraries have both a subclass of
-          <code>GtkApplication</code>?). Since <code>DhAssistant</code> and
-          <code>DhWindow</code> depend on <code>DhApp</code>, they are now also
-          private.
+          The last parameter of
+          <link linkend="dh-keyword-model-filter">dh_keyword_model_filter()</link>
+          has been changed, it is no longer the language (a string, that
+          parameter was deprecated), it is a nullable
+          <link linkend="DhProfile">DhProfile</link>.
         </para>
       </listitem>
+    </itemizedlist>
+  </refsect1>
+
+  <refsect1>
+    <title>3.28.0 -> 3.29.1</title>
+    <itemizedlist>
       <listitem>
         <para>
-          The <code>DhLanguage</code> class is now private, it's currently used
-          only internally by <link linkend="DhBookManager">DhBookManager</link>.
+          The <code>DhBookManager:group-by-language</code> property has been
+          replaced by the
+          <link linkend="DhSettings--group-books-by-language">DhSettings:group-books-by-language</link>
+          property.
         </para>
       </listitem>
       <listitem>
         <para>
-          Due to <link linkend="DhBookManager">DhBookManager</link> being now a
-          singleton, there has been the following API changes:
-          <itemizedlist>
-            <listitem>
-              <para>
-                <code>dh_assistant_view_set_book_manager()</code> has been
-                removed.
-              </para>
-            </listitem>
-            <listitem>
-              <para>
-                <code>dh_keyword_model_set_words()</code> has been removed.
-              </para>
-            </listitem>
-            <listitem>
-              <para>
-                The <code>DhBookTree:book-manager</code> property has been
-                removed.
-              </para>
-            </listitem>
-            <listitem>
-              <para>
-                API break for
-                <link linkend="dh-book-tree-new">dh_book_tree_new()</link>.
-              </para>
-            </listitem>
-            <listitem>
-              <para>
-                The <code>DhSidebar:book-manager</code> property has been
-                removed.
-              </para>
-            </listitem>
-            <listitem>
-              <para>
-                The <code>book_manager</code> parameter of
-                <link linkend="dh-sidebar-new">dh_sidebar_new()</link> is now
-                deprecated.
-              </para>
-            </listitem>
-          </itemizedlist>
+          <link linkend="dh-book-tree-new">dh_book_tree_new()</link> now takes a
+          <link linkend="DhProfile">DhProfile</link> parameter.
         </para>
       </listitem>
     </itemizedlist>
   </refsect1>
 
   <refsect1>
-    <title>3.25.1 -> 3.25.2</title>
+    <title>3.27.1 -> 3.27.2</title>
     <itemizedlist>
       <listitem>
         <para>
-          The <code>page</code> parameter of <link linkend="dh-link-new">dh_link_new()</link>
-          has been removed because it was broken in <code>dh-parser.c</code>.
-          The <code>book</code> parameter has also been moved, to group related
-          parameters together.
+          <code>dh_book_cmp_by_path()</code> has been removed (dead code).
         </para>
       </listitem>
       <listitem>
         <para>
-          The <code>dh_link_get_page_name()</code> function has been removed
-          because it was broken and used nowhere.
+          The <code>DhBookManager::language-enabled</code> and
+          <code>DhBookManager::language-disabled</code> signals have been
+          removed (dead code).
         </para>
       </listitem>
       <listitem>
         <para>
-          The <code>dh_link_get_type_as_string()</code> function (which took a
-          <link linkend="DhLink">DhLink</link> parameter) has been removed, it
-          has been replaced by <link linkend="dh-link-type-to-string">dh_link_type_to_string()</link>
-          which takes a <link linkend="DhLinkType">DhLinkType</link> parameter.
+          <link linkend="DhSidebar">DhSidebar</link> is now a subclass of
+          <link linkend="GtkGrid">GtkGrid</link>, not
+          <link linkend="GtkBox">GtkBox</link>.
+        </para>
+      </listitem>
+      <listitem>
+        <para>
+          <code>dh_sidebar_get_selected_book()</code> has been removed (it was
+          used only inside DhSidebar).
+        </para>
+      </listitem>
+      <listitem>
+        <para>
+          <code>dh_book_get_completions()</code> has been replaced by
+          <link linkend="dh-book-get-completion">dh_book_get_completion()</link>.
         </para>
       </listitem>
     </itemizedlist>
@@ -198,99 +190,107 @@
   </refsect1>
 
   <refsect1>
-    <title>3.27.1 -> 3.27.2</title>
+    <title>3.25.1 -> 3.25.2</title>
     <itemizedlist>
       <listitem>
         <para>
-          <code>dh_book_cmp_by_path()</code> has been removed (dead code).
-        </para>
-      </listitem>
-      <listitem>
-        <para>
-          The <code>DhBookManager::language-enabled</code> and
-          <code>DhBookManager::language-disabled</code> signals have been
-          removed (dead code).
-        </para>
-      </listitem>
-      <listitem>
-        <para>
-          <link linkend="DhSidebar">DhSidebar</link> is now a subclass of
-          <link linkend="GtkGrid">GtkGrid</link>, not
-          <link linkend="GtkBox">GtkBox</link>.
+          The <code>page</code> parameter of <link linkend="dh-link-new">dh_link_new()</link>
+          has been removed because it was broken in <code>dh-parser.c</code>.
+          The <code>book</code> parameter has also been moved, to group related
+          parameters together.
         </para>
       </listitem>
       <listitem>
         <para>
-          <code>dh_sidebar_get_selected_book()</code> has been removed (it was
-          used only inside DhSidebar).
+          The <code>dh_link_get_page_name()</code> function has been removed
+          because it was broken and used nowhere.
         </para>
       </listitem>
       <listitem>
         <para>
-          <code>dh_book_get_completions()</code> has been replaced by
-          <link linkend="dh-book-get-completion">dh_book_get_completion()</link>.
+          The <code>dh_link_get_type_as_string()</code> function (which took a
+          <link linkend="DhLink">DhLink</link> parameter) has been removed, it
+          has been replaced by <link linkend="dh-link-type-to-string">dh_link_type_to_string()</link>
+          which takes a <link linkend="DhLinkType">DhLinkType</link> parameter.
         </para>
       </listitem>
     </itemizedlist>
   </refsect1>
 
   <refsect1>
-    <title>3.28.0 -> 3.29.1</title>
+    <title>3.24 -> 3.25.1</title>
     <itemizedlist>
       <listitem>
         <para>
-          The <code>DhBookManager:group-by-language</code> property has been
-          replaced by the
-          <link linkend="DhSettings--group-books-by-language">DhSettings:group-books-by-language</link>
-          property.
+          All deprecated APIs have been removed.
         </para>
       </listitem>
       <listitem>
         <para>
-          <link linkend="dh-book-tree-new">dh_book_tree_new()</link> now takes a
-          <link linkend="DhProfile">DhProfile</link> parameter.
+          dh-error.h is now private.
         </para>
       </listitem>
-    </itemizedlist>
-  </refsect1>
-
-  <refsect1>
-    <title>3.29.1 -> 3.29.2</title>
-    <itemizedlist>
       <listitem>
         <para>
-          <link linkend="DhBookManager">DhBookManager</link> is now completely
-          empty and entirely deprecated, the minimum amount of API is kept to
-          not break Anjuta. It has been replaced by a more flexible
-          infrastructure: <link linkend="DhProfile">DhProfile</link>,
-          <link linkend="DhSettings">DhSettings</link> and
-          <link linkend="DhBookList">DhBookList</link>. If your application uses
-          only the default libdevhelp widgets it will still work fine – even if
-          you don't adapt the code of the application – because in that case it
-          will use the default profile, which contains the same content as how
-          <link linkend="DhBookManager">DhBookManager</link> was implemented.
+          The <code>DhApp</code>, <code>DhAssistant</code> and
+          <code>DhWindow</code> classes are now private. <code>DhApp</code> is a
+          subclass of <code>GtkApplication</code>, and an application can have
+          only one <code>GtkApplication</code> instance, so as-is
+          <code>DhApp</code> didn't make sense in the library (what if two
+          different libraries have both a subclass of
+          <code>GtkApplication</code>?). Since <code>DhAssistant</code> and
+          <code>DhWindow</code> depend on <code>DhApp</code>, they are now also
+          private.
         </para>
       </listitem>
       <listitem>
         <para>
-          Whether a <link linkend="DhBook">DhBook</link> is enabled is now
-          decoupled from <link linkend="DhBook">DhBook</link>:
-          <code>dh_book_get_enabled()</code> and
-          <code>dh_book_set_enabled()</code> have been removed, as well as the
-          <code>DhBook::enabled</code> and <code>DhBook::disabled</code>
-          signals. For a book to be enabled it now needs to be part
-          of a <link linkend="DhBookList">DhBookList</link>, which is more
-          flexible because there can be several different
-          <link linkend="DhBookList">DhBookList</link>'s in parallel.
+          The <code>DhLanguage</code> class is now private, it's currently used
+          only internally by <link linkend="DhBookManager">DhBookManager</link>.
         </para>
       </listitem>
       <listitem>
         <para>
-          The last parameter of
-          <link linkend="dh-keyword-model-filter">dh_keyword_model_filter()</link>
-          has been changed, it is no longer the language (a string, that
-          parameter was deprecated), it is a nullable
-          <link linkend="DhProfile">DhProfile</link>.
+          Due to <link linkend="DhBookManager">DhBookManager</link> being now a
+          singleton, there has been the following API changes:
+          <itemizedlist>
+            <listitem>
+              <para>
+                <code>dh_assistant_view_set_book_manager()</code> has been
+                removed.
+              </para>
+            </listitem>
+            <listitem>
+              <para>
+                <code>dh_keyword_model_set_words()</code> has been removed.
+              </para>
+            </listitem>
+            <listitem>
+              <para>
+                The <code>DhBookTree:book-manager</code> property has been
+                removed.
+              </para>
+            </listitem>
+            <listitem>
+              <para>
+                API break for
+                <link linkend="dh-book-tree-new">dh_book_tree_new()</link>.
+              </para>
+            </listitem>
+            <listitem>
+              <para>
+                The <code>DhSidebar:book-manager</code> property has been
+                removed.
+              </para>
+            </listitem>
+            <listitem>
+              <para>
+                The <code>book_manager</code> parameter of
+                <link linkend="dh-sidebar-new">dh_sidebar_new()</link> is now
+                deprecated.
+              </para>
+            </listitem>
+          </itemizedlist>
         </para>
       </listitem>
     </itemizedlist>
[Date Prev][Date Next] [Thread Prev][Thread Next] [Thread Index] [Date Index] [Author Index]