[glibmm] giomm: Correct docs of newly added methods that throw a Glib::Error.
- From: José Alburquerque <jaalburqu src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [glibmm] giomm: Correct docs of newly added methods that throw a Glib::Error.
- Date: Wed, 8 Dec 2010 07:12:36 +0000 (UTC)
commit f15b975622eaf6534994d0fda91003df8619c002
Author: José Alburquerque <jaalburqu svn gnome org>
Date: Wed Dec 8 02:09:12 2010 -0500
giomm: Correct docs of newly added methods that throw a Glib::Error.
* gio/src/dbusconnection.hg:
* gio/src/dbusproxy.hg:
* gio/src/dbusintrospection.hg: Use _WRAP_METHOD_DOCS_ONLY together
with a Doxygen @throw directive in methods that throw a Glib::Error to
get the C docs and then make it clear that the methods throw a
Glib::Error.
(new_for_xml): Rename to create_for_xml().
ChangeLog | 12 ++++++++++++
gio/src/dbusconnection.hg | 13 +++++++------
gio/src/dbusintrospection.hg | 6 +++---
gio/src/dbusproxy.hg | 8 ++++----
4 files changed, 26 insertions(+), 13 deletions(-)
---
diff --git a/ChangeLog b/ChangeLog
index ea5617e..7b8e683 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,17 @@
2010-12-08 José Alburquerque <jaalburqu svn gnome org>
+ giomm: Correct docs of newly added methods that throw a Glib::Error.
+
+ * gio/src/dbusconnection.hg:
+ * gio/src/dbusproxy.hg:
+ * gio/src/dbusintrospection.hg: Use _WRAP_METHOD_DOCS_ONLY together
+ with a Doxygen @throw directive in methods that throw a Glib::Error to
+ get the C docs and then make it clear that the methods throw a
+ Glib::Error.
+ (new_for_xml): Rename to create_for_xml().
+
+2010-12-08 José Alburquerque <jaalburqu svn gnome org>
+
DBusConnection: Use static keyword for create methods.
* gio/src/dbusconnection.{ccg,hg}: Add the forgotten 'static' keyword
diff --git a/gio/src/dbusconnection.hg b/gio/src/dbusconnection.hg
index 2a71767..7504c56 100644
--- a/gio/src/dbusconnection.hg
+++ b/gio/src/dbusconnection.hg
@@ -167,8 +167,8 @@ public:
/// A Non-cancellable version of get_sync().
static Glib::RefPtr<DBusConnection> get_sync(BusType bus_type);
- /** @throw Glib::Error.
- */
+ _WRAP_METHOD_DOCS_ONLY( g_bus_get_finish, errthrow)
+ /// @throw Glib::Error.
_WRAP_METHOD(static Glib::RefPtr<DBusConnection> get_finish(const Glib::RefPtr<AsyncResult>& res), g_bus_get_finish, errthrow)
_WRAP_METHOD_DOCS_ONLY(g_dbus_connection_new)
@@ -186,6 +186,7 @@ public:
const SlotAsyncReady& slot,
DBusConnectionFlags flags = Gio::DBUS_CONNECTION_FLAGS_NONE);
+ _WRAP_METHOD_DOCS_ONLY(g_dbus_connection_new_finish)
/// @throw Glib::Error.
_WRAP_METHOD(static Glib::RefPtr<DBusConnection> create_finish(const Glib::RefPtr<AsyncResult>& res), g_dbus_connection_new_finish, errthrow)
@@ -202,12 +203,12 @@ public:
const SlotAsyncReady& slot,
DBusConnectionFlags flags = Gio::DBUS_CONNECTION_FLAGS_NONE);
+ _WRAP_METHOD_DOCS_ONLY(g_dbus_connection_new_for_address_finish)
/// @throw Glib::Error.
_WRAP_METHOD(static Glib::RefPtr<DBusConnection> create_for_address_finish(const Glib::RefPtr<AsyncResult>& res), g_dbus_connection_new_for_address_finish, errthrow)
_WRAP_METHOD_DOCS_ONLY(g_dbus_connection_new_sync)
- /** @throw Glib::Error.
- */
+ /// @throw Glib::Error.
static Glib::RefPtr<DBusConnection> create_sync(
const Glib::RefPtr<IOStream>& stream,
const Glib::ustring& guid,
@@ -224,8 +225,7 @@ public:
DBusConnectionFlags flags = Gio::DBUS_CONNECTION_FLAGS_NONE);
_WRAP_METHOD_DOCS_ONLY(g_dbus_connection_new_for_address_sync)
- /** @throw Glib::Error.
- */
+ /// @throw Glib::Error.
static Glib::RefPtr<DBusConnection> create_for_address_sync(
const Glib::ustring& address,
const Glib::RefPtr<DBusAuthObserver>& observer,
@@ -449,6 +449,7 @@ public:
int timeout_msec,
const SlotAsyncReady& slot);
+ _WRAP_METHOD_DOCS_ONLY(g_dbus_connection_send_message_with_reply_finish)
/// @throw Glib::Error.
_WRAP_METHOD(Glib::RefPtr<DBusMessage> send_message_with_reply_finish(const Glib::RefPtr<AsyncResult>& result), g_dbus_connection_send_message_with_reply_finish, errthrow)
diff --git a/gio/src/dbusintrospection.hg b/gio/src/dbusintrospection.hg
index 915346c..d0021b4 100644
--- a/gio/src/dbusintrospection.hg
+++ b/gio/src/dbusintrospection.hg
@@ -116,9 +116,9 @@ class DBusNodeInfo
_CLASS_OPAQUE_REFCOUNTED(DBusNodeInfo, GDBusNodeInfo, NONE, g_dbus_node_info_ref, g_dbus_node_info_unref)
public:
- /** @throw Glib::Error.
- */
- _WRAP_METHOD(static Glib::RefPtr<DBusNodeInfo> new_for_xml(const Glib::ustring& xml_data), g_dbus_node_info_new_for_xml, errthrow)
+ _WRAP_METHOD_DOCS_ONLY(g_dbus_node_info_new_for_xml)
+ /// @throw Glib::Error.
+ _WRAP_METHOD(static Glib::RefPtr<DBusNodeInfo> create_for_xml(const Glib::ustring& xml_data), g_dbus_node_info_new_for_xml, errthrow)
_WRAP_METHOD(Glib::RefPtr<DBusInterfaceInfo> lookup_interface(const Glib::ustring& name), g_dbus_node_info_lookup_interface)
_WRAP_METHOD(Glib::RefPtr<const DBusInterfaceInfo> lookup_interface(const Glib::ustring& name) const, g_dbus_node_info_lookup_interface, constversion)
diff --git a/gio/src/dbusproxy.hg b/gio/src/dbusproxy.hg
index 73202fb..c03dd54 100644
--- a/gio/src/dbusproxy.hg
+++ b/gio/src/dbusproxy.hg
@@ -156,8 +156,8 @@ public:
const Glib::RefPtr<DBusInterfaceInfo>& info = Glib::RefPtr<DBusInterfaceInfo>(),
DBusProxyFlags flags = DBUS_PROXY_FLAGS_NONE);
- /** @throw Glib::Error.
- */
+ _WRAP_METHOD_DOCS_ONLY(g_dbus_proxy_new_finish)
+ /// @throw Glib::Error.
_WRAP_METHOD(static Glib::RefPtr<DBusProxy> create_finish(const Glib::RefPtr<AsyncResult>& result), g_dbus_proxy_new_finish, errthrow)
_WRAP_METHOD_DOCS_ONLY(g_dbus_proxy_new_sync)
@@ -198,8 +198,8 @@ public:
const Glib::RefPtr<DBusInterfaceInfo>& info = Glib::RefPtr<DBusInterfaceInfo>(),
DBusProxyFlags flags = DBUS_PROXY_FLAGS_NONE);
- /** @throw Glib::Error.
- */
+ _WRAP_METHOD_DOCS_ONLY(g_dbus_proxy_new_for_bus_finish)
+ /// @throw Glib::Error.
_WRAP_METHOD(static Glib::RefPtr<DBusProxy> create_for_bus_finish(const Glib::RefPtr<AsyncResult>& result), g_dbus_proxy_new_for_bus_finish, errthrow)
_WRAP_METHOD_DOCS_ONLY(g_dbus_proxy_new_for_bus_sync)
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]