atkmisc: Deprecate atkmisc

Also include it on the documentation to clearly state that
is deprecated.

https://bugzilla.gnome.org/show_bug.cgi?id=652798

diff --git a/atk/atkmisc.c b/atk/atkmisc.c
index 484b9fd..b6aaeea 100755 (executable)
--- a/atk/atkmisc.c
+++ b/atk/atkmisc.c
@@ -19,6 +19,15 @@
 
 #include "atkmisc.h"
 
+/**
+ * SECTION:atkmisc
+ * @Short_description: A set of ATK utility functions for thread locking
+ * @Title:AtkMisc
+ *
+ * A set of utility functions for thread locking. This interface and
+ * all his related methods are deprecated since 2.12.
+ */
+
 static void atk_misc_class_init (AtkMiscClass *klass);
 
 GType
@@ -61,6 +70,8 @@ atk_misc_class_init (AtkMiscClass *klass)
  * (This method is implemented by the toolkit ATK implementation layer;
  *  for instance, for GTK+, GAIL implements this via GDK_THREADS_ENTER).
  *
+ * Deprecated: Since 2.12.
+ *
  * Since: 1.13
  *
  **/
@@ -94,6 +105,8 @@ atk_misc_threads_enter (AtkMisc *misc)
  * (This method is implemented by the toolkit ATK implementation layer;
  *  for instance, for GTK+, GAIL implements this via GDK_THREADS_LEAVE).
  *
+ * Deprecated: Since 2.12.
+ *
  * Since: 1.13
  *
  **/
@@ -122,6 +135,8 @@ AtkMisc *atk_misc_instance = NULL;
  * 
  * Since: 1.13
  *
+ * Deprecated: Since 2.12.
+ *
  * Returns: The singleton instance of AtkMisc for this application.
  *
  **/

diff --git a/atk/atkmisc.h b/atk/atkmisc.h
index 2fad4aa..269e4d2 100755 (executable)
--- a/atk/atkmisc.h
+++ b/atk/atkmisc.h
@@ -74,9 +74,20 @@ struct _AtkMisc
  * Singleton instance - only the ATK implementation layer for
  * a given GUI toolkit/application instance should touch this
  * symbol directly.
+ *
+ * Deprecated: Since 2.12.
  */
 ATK_VAR AtkMisc *atk_misc_instance;
 
+/**
+ * AtkMiscClass:
+ * @threads_enter: This virtual function is deprecated since 2.12 and
+ *   it should not be overriden.
+ * @threads_leave: This virtual function is deprecated sice 2.12 and
+ *   it should not be overriden.
+ *
+ * Usage of AtkMisc is deprecated since 2.12 and heavily discouraged.
+ */
 struct _AtkMiscClass
 {
    GObjectClass parent;
@@ -86,25 +97,11 @@ struct _AtkMiscClass
 };
 GType atk_misc_get_type (void);
 
-/*
- * Wrapper for thread lock, i.e. take the thread mutex for the GUI toolkit, 
- * if one exists.  
- * (This method is implemented by the toolkit ATK implementation layer;
- *  for instance, for GTK+, GAIL implements this via GDK_THREADS_ENTER).
- */
+G_DEPRECATED
 void     atk_misc_threads_enter  (AtkMisc *misc);
-
-/*
- * Wrapper for thread lock, i.e. release the thread mutex for the GUI toolkit, 
- * if one exists.  
- * (This method is implemented by the toolkit ATK implementation layer;
- *  for instance, for GTK+, GAIL implements this via GDK_THREADS_LEAVE).
- */
+G_DEPRECATED
 void     atk_misc_threads_leave  (AtkMisc *misc);
-
-/*
- * Obtain (singleton) instance of AtkMisc.
- */
+G_DEPRECATED
 const AtkMisc *atk_misc_get_instance (void);
 
 G_END_DECLS

diff --git a/docs/atk-docs.sgml b/docs/atk-docs.sgml
index c7d8b21..cf63cda 100644 (file)
--- a/docs/atk-docs.sgml
+++ b/docs/atk-docs.sgml
@@ -10,6 +10,7 @@
   <!ENTITY atk-AtkHyperlinkImpl SYSTEM "xml/atkhyperlinkimpl.xml">
   <!ENTITY atk-AtkHypertext SYSTEM "xml/atkhypertext.xml">
   <!ENTITY atk-AtkImage SYSTEM "xml/atkimage.xml">
+  <!ENTITY atk-AtkMisc SYSTEM "xml/atkmisc.xml">
   <!ENTITY atk-AtkNoOpObject SYSTEM "xml/atknoopobject.xml">
   <!ENTITY atk-AtkNoOpObjectFactory SYSTEM "xml/atknoopobjectfactory.xml">
   <!ENTITY atk-AtkPlug SYSTEM "xml/atkplug.xml">
@@ -75,6 +76,11 @@
     &atk-AtkVersion;
   </chapter>
 
+  <chapter id="deprecated">
+    <title>Deprecated Interfaces</title>
+    &atk-AtkMisc;
+  </chapter>
+
   <index id="api-index-full">
     <title>Index of all symbols</title>
   </index>

diff --git a/docs/atk.types b/docs/atk.types
index ceb2f82..bdbd870 100644 (file)
--- a/docs/atk.types
+++ b/docs/atk.types
@@ -9,6 +9,7 @@ atk_hyperlink_get_type
 atk_hypertext_get_type
 atk_image_get_type
 atk_implementor_get_type
+atk_misc_get_type
 atk_no_op_object_get_type
 atk_no_op_object_factory_get_type
 atk_object_get_type