[glibmm/glibmm-2-54] Gio::Application docs: Add a note to property_resource_base_path()



commit 51258a1c1f7aa82a5ed5934f64329096cfb0e009
Author: Kjell Ahlstedt <kjellahlstedt gmail com>
Date:   Wed Sep 13 17:31:57 2017 +0200

    Gio::Application docs: Add a note to property_resource_base_path()
    
    The type of property_resource_base_path() shall be std::string (is bool).
    Fixing this would break API and ABI. A fix has to wait until the next
    API/ABI break. For now, add a note to the documentation. Bug 787496

 gio/src/application.hg |    7 +++++++
 1 files changed, 7 insertions(+), 0 deletions(-)
---
diff --git a/gio/src/application.hg b/gio/src/application.hg
index f6f8f9c..4faa475 100644
--- a/gio/src/application.hg
+++ b/gio/src/application.hg
@@ -364,6 +364,13 @@ public:
   _WRAP_PROPERTY("inactivity-timeout", guint)
   _WRAP_PROPERTY("is-registered", bool)
   _WRAP_PROPERTY("is-remote", bool)
+  //TODO: Change bool to std::string when we can break API/ABI.
+  /** @note
+   * Don't use %property_resource_base_path(). Use set_resource_base_path() or
+   * get_resource_base_path() instead.
+   * %property_resource_base_path() has got the wrong type.
+   * This bug will be fixed at the next API/ABI break.
+   */
   _WRAP_PROPERTY("resource-base-path", bool, newin "2,44")
   _WRAP_PROPERTY("is-busy", bool)
 


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