[devhelp] NEWS: write summary of latest changes and document API breaks



commit 08eaa04ef78cbd8ab05cf9f0f936b60e0b4a8549
Author: Sébastien Wilmet <swilmet gnome org>
Date:   Sat May 13 17:14:43 2017 +0200

    NEWS: write summary of latest changes and document API breaks

 NEWS                          |   13 ++++++++++---
 docs/reference/api-breaks.xml |   24 +++++++++++++++++++-----
 2 files changed, 29 insertions(+), 8 deletions(-)
---
diff --git a/NEWS b/NEWS
index 96b419f..1801481 100644
--- a/NEWS
+++ b/NEWS
@@ -2,19 +2,26 @@
 Version 3.25.x (not yet released)
 ==============
 
-- Several fixes in the GTK-Doc comments and GObject Introspection annotations.
+- Book tree in the side panel: add context menu with Collapse All action.
+- Update GUI when system fonts change.
 - Lots of code clean-up and refactorings.
 - Clean up the GSettings schema.
-- Update GUI when system fonts change.
+- Use GIO to load the index files.
+- Several bug fixes in the parser.
 - Build system:
        - Disable -Werror by default.
        - Use git.mk.
        - Check for gsettings-desktop-schemas with pkg-config.
 
-API changes:
+API:
 - There has been some API breaks documented in the reference manual, but both
   Anjuta and gnome-builder should still compile and work fine.
+- Several fixes in the GTK-Doc comments and GObject Introspection annotations.
+- Improve documentation, write class descriptions for public classes.
+- DhBookManager is now a singleton.
 - Deprecate dh_link_get_page_name().
+- dh_init() now initializes the i18n.
+- New function: dh_free_resources().
 
 
 ==============
diff --git a/docs/reference/api-breaks.xml b/docs/reference/api-breaks.xml
index c132d8a..38baba3 100644
--- a/docs/reference/api-breaks.xml
+++ b/docs/reference/api-breaks.xml
@@ -42,16 +42,30 @@
       </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.
+        </para>
+      </listitem>
+      <listitem>
+        <para>
+          The <code>DhLanguage</code> class is now private, it's currently used
+          only internally by <link linkend="DhBookManager">DhBookManager</link>.
+        </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_app_peek_book_manager()</code> has been removed.
-              </para>
-            </listitem>
-            <listitem>
-              <para>
                 <code>dh_assistant_view_set_book_manager()</code> has been
                 removed.
               </para>


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