summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat
-rw-r--r--ChangeLog22
-rw-r--r--gio/src/dbusaddress.hg8
-rw-r--r--gio/src/dbusauthobserver.hg1
-rw-r--r--gio/src/dbusconnection.hg3
-rw-r--r--gio/src/dbuserror.hg3
-rw-r--r--gio/src/dbusintrospection.hg7
-rw-r--r--gio/src/dbusmessage.hg1
-rw-r--r--gio/src/dbusmethodinvocation.hg1
-rw-r--r--gio/src/dbusownname.hg4
-rw-r--r--gio/src/dbusproxy.ccg9
-rw-r--r--gio/src/dbusproxy.hg1
-rw-r--r--gio/src/dbusserver.hg1
-rw-r--r--gio/src/dbusutils.hg6
-rw-r--r--gio/src/dbuswatchname.hg5
-rw-r--r--glib/glibmm.h1
15 files changed, 69 insertions, 4 deletions
diff --git a/ChangeLog b/ChangeLog
index f1f812cd..37bb3621 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,25 @@
+2010-12-13 José Alburquerque <jaalburqu@svn.gnome.org>
+
+ Add a DBus Doxygen group.
+
+ * gio/src/dbusconnection.hg: Add a DBus Doxygen group in which to
+ include all the D-Bus docs.
+ * gio/src/dbusaddress.hg:
+ * gio/src/dbusauthobserver.hg:
+ * gio/src/dbuserror.hg:
+ * gio/src/dbusintrospection.hg:
+ * gio/src/dbusmessage.hg:
+ * gio/src/dbusmethodinvocation.hg:
+ * gio/src/dbusownname.hg:
+ * gio/src/dbusproxy.hg:
+ * gio/src/dbusserver.hg:
+ * gio/src/dbusutils.hg:
+ * gio/src/dbuswatchname.hg: Include all the D-Bus classes, functions
+ and slots in the new group.
+ * glib/glibmm.h: Mention the new group in the list of giomm features.
+
+ * gio/src/dbusproxy.ccg: Typos.
+
2010-12-12 José Alburquerque <jaalburqu@svn.gnome.org>
glibmm: Add a MatchInfo class for use with the existing Regex class.
diff --git a/gio/src/dbusaddress.hg b/gio/src/dbusaddress.hg
index 42a2e24d..d91e53e8 100644
--- a/gio/src/dbusaddress.hg
+++ b/gio/src/dbusaddress.hg
@@ -39,6 +39,7 @@ namespace Address
* @return <tt>true</tt> if @a string is a valid D-Bus address, <tt>false</tt>
* otherwise.
* @newin{2,28}
+ * @ingroup DBus
*/
bool is_address(const Glib::ustring& string);
@@ -50,6 +51,7 @@ bool is_address(const Glib::ustring& string);
* supported by this library, <tt>false</tt> otherwise.
* @throw Glib::Error.
* @newin{2,28}
+ * @ingroup DBus
*/
bool is_supported(const Glib::ustring& address);
@@ -67,6 +69,7 @@ bool is_supported(const Glib::ustring& address);
* @param cancellable A Cancellable.
* @param slot A SlotAsyncReady to call when the request is satisfied.
* @newin{2,28}
+ * @ingroup DBus
*/
void get_stream(const Glib::ustring& address, const SlotAsyncReady slot,
const Glib::RefPtr<Cancellable>& cancellable);
@@ -83,6 +86,7 @@ void get_stream(const Glib::ustring& address, const SlotAsyncReady slot);
* @return A IOStream.
* @throw Glib::Error.
* @newin{2,28}
+ * @ingroup DBus
*/
Glib::RefPtr<IOStream> get_stream_finish(const Glib::RefPtr<AsyncResult>& res,
Glib::ustring& out_guid);
@@ -94,6 +98,7 @@ Glib::RefPtr<IOStream> get_stream_finish(const Glib::RefPtr<AsyncResult>& res,
* @return A IOStream.
* @throw Glib::Error.
* @newin{2,28}
+ * @ingroup DBus
*/
Glib::RefPtr<IOStream> get_stream_finish(const Glib::RefPtr<AsyncResult>& res);
@@ -111,6 +116,7 @@ Glib::RefPtr<IOStream> get_stream_finish(const Glib::RefPtr<AsyncResult>& res);
* @param Returns A IOStream.
* @throw Glib::Error.
* @newin{2,28}
+ * @ingroup DBus
*/
Glib::RefPtr<IOStream> get_stream_sync(const Glib::ustring& address,
const Glib::RefPtr<Cancellable>& cancellable, Glib::ustring& out_guid);
@@ -131,6 +137,7 @@ Glib::RefPtr<IOStream> get_stream_sync(const Glib::ustring& address,
* @param Returns A IOStream.
* @throw Glib::Error.
* @newin{2,28}
+ * @ingroup DBus
*/
Glib::RefPtr<IOStream> get_stream_sync(const Glib::ustring& address,
const Glib::RefPtr<Cancellable>& cancellable);
@@ -147,6 +154,7 @@ Glib::RefPtr<IOStream> get_stream_sync(const Glib::ustring& address);
* @return A valid D-Bus address string for @a bus_type.
* @throw Glib::Error.
* @newin{2,28}
+ * @ingroup DBus
*/
Glib::ustring get_for_bus_sync(BusType bus_type,
const Glib::RefPtr<Cancellable>& cancellable);
diff --git a/gio/src/dbusauthobserver.hg b/gio/src/dbusauthobserver.hg
index 5f9937ff..52dba4c4 100644
--- a/gio/src/dbusauthobserver.hg
+++ b/gio/src/dbusauthobserver.hg
@@ -35,6 +35,7 @@ namespace Gio
* interested in. Note that new signals may be added in the future.
*
* @newin{2,28}
+ * @ingroup DBus
*/
class DBusAuthObserver : public Glib::Object
{
diff --git a/gio/src/dbusconnection.hg b/gio/src/dbusconnection.hg
index 6d9752f3..e10119f1 100644
--- a/gio/src/dbusconnection.hg
+++ b/gio/src/dbusconnection.hg
@@ -40,6 +40,8 @@ _WRAP_ENUM(DBusSignalFlags, GDBusSignalFlags, NO_GTYPE)
class DBusAuthObserver;
+/// @defgroup DBus D-Bus Access Functionality
+
//TODO: Add example from C API in class docs.
/** DBusConnection - D-Bus Connections.
* The DBusConnection type is used for D-Bus connections to remote peers such
@@ -52,6 +54,7 @@ class DBusAuthObserver;
* Gio::DBus::watch_name() or DBusProxy::create_for_bus() APIs.
*
* @newin{2,28}
+ * @ingroup DBus
*/
class DBusConnection
: public Glib::Object, public Initable, public AsyncInitable
diff --git a/gio/src/dbuserror.hg b/gio/src/dbuserror.hg
index 3b26f3d8..87536923 100644
--- a/gio/src/dbuserror.hg
+++ b/gio/src/dbuserror.hg
@@ -37,6 +37,7 @@ _WRAP_ENUM(DBusError, GDBusError, NO_GTYPE)
* @return <tt>true</tt> if error represents an error from a remote peer,
* <tt>false</tt> otherwise.
* @newin{2,28}
+ * @ingroup DBus
*/
bool is_remote_error(const Glib::Error& error);
@@ -51,6 +52,7 @@ bool is_remote_error(const Glib::Error& error);
* @return An allocated string or <tt>0</tt> if the D-Bus error name could not
* be found.
* @newin{2,28}
+ * @ingroup DBus
*/
Glib::ustring get_remote_error(const Glib::Error& error);
@@ -64,6 +66,7 @@ Glib::ustring get_remote_error(const Glib::Error& error);
* @return <tt>true</tt> if information was stripped, <tt>false</tt>
* otherwise.
* @newin{2,28}
+ * @ingroup DBus
*/
bool strip_remote_error(Glib::Error& error);
diff --git a/gio/src/dbusintrospection.hg b/gio/src/dbusintrospection.hg
index 25223f35..0bea10b0 100644
--- a/gio/src/dbusintrospection.hg
+++ b/gio/src/dbusintrospection.hg
@@ -30,6 +30,7 @@ _WRAP_ENUM(DBusPropertyInfoFlags, GDBusPropertyInfoFlags, NO_GTYPE)
/** DBusAnnotationInfo - Stores information about an annotation.
*
* @newin{2,28}
+ * @ingroup DBus
*/
class DBusAnnotationInfo
{
@@ -44,6 +45,7 @@ public:
* signal.
*
* @newin{2,28}
+ * @ingroup DBus
*/
class DBusArgInfo
{
@@ -55,6 +57,7 @@ public:
/** DBusMethodInfo - Stores information about a method on an D-Bus interface.
*
* @newin{2,28}
+ * @ingroup DBus
*/
class DBusMethodInfo
{
@@ -66,6 +69,7 @@ public:
/** Stores information about a signal on a D-Bus interface.
*
* @newin{2,28}
+ * @ingroup DBus
*/
class DBusSignalInfo
{
@@ -77,6 +81,7 @@ public:
/** Stores information about a property on a D-Bus interface.
*
* @newin{2,28}
+ * @ingroup DBus
*/
class DBusPropertyInfo
{
@@ -88,6 +93,7 @@ public:
/** DBusInterfaceInfo - Stores information about a D-Bus interface.
*
* @newin{2,28}
+ * @ingroup DBus
*/
class DBusInterfaceInfo
{
@@ -110,6 +116,7 @@ public:
* hierarchy.
*
* @newin{2,28}
+ * @ingroup DBus
*/
class DBusNodeInfo
{
diff --git a/gio/src/dbusmessage.hg b/gio/src/dbusmessage.hg
index 2295711c..2f346693 100644
--- a/gio/src/dbusmessage.hg
+++ b/gio/src/dbusmessage.hg
@@ -39,6 +39,7 @@ class UnixFDList;
* DBusConnection.
*
* @newin{2,28}
+ * @ingroup DBus
*/
class DBusMessage : public Glib::Object
{
diff --git a/gio/src/dbusmethodinvocation.hg b/gio/src/dbusmethodinvocation.hg
index e5b126b3..319f9e31 100644
--- a/gio/src/dbusmethodinvocation.hg
+++ b/gio/src/dbusmethodinvocation.hg
@@ -40,6 +40,7 @@ class DBusMethodInfo;
* Gio::DBusConnection::register_object().
*
* @newin{2,28}
+ * @ingroup DBus
*/
class DBusMethodInvocation : public Glib::Object
{
diff --git a/gio/src/dbusownname.hg b/gio/src/dbusownname.hg
index 220d9a9a..7ef61aa9 100644
--- a/gio/src/dbusownname.hg
+++ b/gio/src/dbusownname.hg
@@ -33,18 +33,21 @@ _WRAP_ENUM(BusNameOwnerFlags, GBusNameOwnerFlags)
* void on_bus_acquired(const Glib::RefPtr<Gio::DBusConnection>& connection,
* const Glib::ustring& name);
* @newin{2,28}
+ * @ingroup DBus
*/
typedef sigc::slot<void, const Glib::RefPtr<Gio::DBusConnection>&, Glib::ustring> SlotBusAcquired;
/** For example,
* void on_name_acquired(const Glib::RefPtr<Gio::DBusConnection>& connection,
* const Glib::ustring& name);
+ * @ingroup DBus
*/
typedef sigc::slot<void, const Glib::RefPtr<Gio::DBusConnection>&, Glib::ustring> SlotNameAcquired;
/** For example,
* void on_name_lost(const Glib::RefPtr<Gio::DBusConnection>& connection,
* const Glib::ustring& name);
+ * @ingroup DBus
*/
typedef sigc::slot<void, const Glib::RefPtr<Gio::DBusConnection>&, Glib::ustring> SlotNameLost;
@@ -104,6 +107,7 @@ typedef sigc::slot<void, const Glib::RefPtr<Gio::DBusConnection>&, Glib::ustring
* owning the name.
*
* @newin{2,28}
+ * @ingroup DBus
*/
guint own_name(BusType bus_type, const Glib::ustring& name,
BusNameOwnerFlags flags, const SlotBusAcquired& bus_acquired_slot,
diff --git a/gio/src/dbusproxy.ccg b/gio/src/dbusproxy.ccg
index e597e0c2..eac89aff 100644
--- a/gio/src/dbusproxy.ccg
+++ b/gio/src/dbusproxy.ccg
@@ -333,7 +333,7 @@ void DBusProxy::call(const Glib::ustring& method_name,
void DBusProxy::call_finish(Glib::VariantBase& ret, const Glib::RefPtr<AsyncResult>& res)
{
- GError *g_error = 0;
+ GError* g_error = 0;
GVariant* const g_variant =
g_dbus_proxy_call_finish(gobj(), Glib::unwrap(res), &g_error);
@@ -352,7 +352,7 @@ void DBusProxy::call_sync(Glib::VariantBase& result,
DBusCallFlags flags
)
{
- GError *g_error = 0;
+ GError* g_error = 0;
GVariant* const g_variant =
g_dbus_proxy_call_sync(gobj(), method_name.c_str(),
@@ -366,14 +366,15 @@ void DBusProxy::call_sync(Glib::VariantBase& result,
result.init(g_variant, false /* don't take extra reference */);
}
-void DBusProxy::call_sync(Glib::VariantBase& result,
+void DBusProxy::call_sync(
+ Glib::VariantBase& result,
const Glib::ustring& method_name,
const Glib::VariantBase& parameters,
int timeout_msec,
DBusCallFlags flags
)
{
- GError *g_error = 0;
+ GError* g_error = 0;
GVariant* const g_variant =
g_dbus_proxy_call_sync(gobj(), method_name.c_str(),
diff --git a/gio/src/dbusproxy.hg b/gio/src/dbusproxy.hg
index cd27199d..74a2a2f1 100644
--- a/gio/src/dbusproxy.hg
+++ b/gio/src/dbusproxy.hg
@@ -61,6 +61,7 @@ class DBusInterfaceInfo;
* The C API docs has more information and an example.
*
* @newin{2,28}
+ * @ingroup DBus
*/
class DBusProxy
: public Glib::Object,
diff --git a/gio/src/dbusserver.hg b/gio/src/dbusserver.hg
index 0c1da014..c561425e 100644
--- a/gio/src/dbusserver.hg
+++ b/gio/src/dbusserver.hg
@@ -38,6 +38,7 @@ class DBusConnection;
* throw an exception if construction fails.
*
* @newin{2,28}
+ * @ingroup DBus
*/
class DBusServer : public Glib::Object, public Initable
{
diff --git a/gio/src/dbusutils.hg b/gio/src/dbusutils.hg
index 17357ef5..11185fe6 100644
--- a/gio/src/dbusutils.hg
+++ b/gio/src/dbusutils.hg
@@ -33,6 +33,7 @@ namespace DBus
*
* @return A valid D-Bus GUID.
* @newin{2,28}
+ * @ingroup DBus
*/
Glib::ustring generate_guid();
@@ -44,6 +45,7 @@ Glib::ustring generate_guid();
* @param string The string to check.
* @return <tt>true</tt> if string is a guid, <tt>false</tt> otherwise.
* @newin{2,28}
+ * @ingroup DBus
*/
bool is_guid(const Glib::ustring& string);
@@ -53,6 +55,7 @@ bool is_guid(const Glib::ustring& string);
* @param string The string to check.
* @return <tt>true</tt> if valid, <tt>false</tt> otherwise.
* @newin{2,28}
+ * @ingroup DBus
*/
bool is_name(const Glib::ustring& string);
@@ -61,6 +64,7 @@ bool is_name(const Glib::ustring& string);
* @param string The string to check.
* @return <tt>true</tt> if valid, <tt>false</tt> otherwise.
* @newin{2,28}
+ * @ingroup DBus
*/
bool is_unique_name(const Glib::ustring& string);
@@ -69,6 +73,7 @@ bool is_unique_name(const Glib::ustring& string);
* @param string The string to check.
* @return <tt>true</tt> if valid, <tt>false</tt> otherwise.
* @newin{2,28}
+ * @ingroup DBus
*/
bool is_member_name(const Glib::ustring& string);
@@ -77,6 +82,7 @@ bool is_member_name(const Glib::ustring& string);
* @param string The string to check.
* @return <tt>true</tt> if valid, <tt>false</tt> otherwise.
* @newin{2,28}
+ * @ingroup DBus
*/
bool is_interface_name(const Glib::ustring& string);
diff --git a/gio/src/dbuswatchname.hg b/gio/src/dbuswatchname.hg
index f940a089..edd0f2fa 100644
--- a/gio/src/dbuswatchname.hg
+++ b/gio/src/dbuswatchname.hg
@@ -32,12 +32,14 @@ _WRAP_ENUM(BusNameWatcherFlags, GBusNameWatcherFlags)
/** For example,
* void on_name_appeared(const Glib::RefPtr<Gio::DBusConnection>& connection,
* const Glib::ustring& name, const Glib::ustring& name_owner);
+ * @ingroup DBus
*/
typedef sigc::slot<void, const Glib::RefPtr<Gio::DBusConnection>&, Glib::ustring, const Glib::ustring&> SlotNameAppeared;
/** For example,
* void on_name_vanished(const Glib::RefPtr<Gio::DBusConnection>& connection,
* const Glib::ustring& name);
+ * @ingroup DBus
*/
typedef sigc::slot<void, const Glib::RefPtr<Gio::DBusConnection>&, Glib::ustring> SlotNameVanished;
@@ -80,6 +82,7 @@ typedef sigc::slot<void, const Glib::RefPtr<Gio::DBusConnection>&, Glib::ustring
* stop watching the name.
*
* @newin{2,28}
+ * @ingroup DBus
*/
guint watch_name(BusType bus_type, const Glib::ustring& name,
BusNameWatcherFlags flags, const SlotNameAppeared& name_appeared_slot,
@@ -100,6 +103,7 @@ _IGNORE(g_bus_watch_name)
* stop watching the name.
*
* @newin{2,28}
+ * @ingroup DBus
*/
guint watch_name(const Glib::RefPtr<DBusConnection>& connection,
const Glib::ustring& name, BusNameWatcherFlags flags,
@@ -111,6 +115,7 @@ _IGNORE(g_bus_watch_name_on_connection)
/** Stops watching a name.
* @param watcher_id An identifier obtained from watch_name().
+ * @ingroup DBus
*/
void unwatch_name(guint watcher_id);
_IGNORE(g_bus_unwatch_name)
diff --git a/glib/glibmm.h b/glib/glibmm.h
index 7dfe4fa2..ae4ee0cf 100644
--- a/glib/glibmm.h
+++ b/glib/glibmm.h
@@ -50,6 +50,7 @@
* giomm (part of the glibmm project) also contains:
* - Asynchronous IO. See Gio::File and the @ref Streams.
* - @ref NetworkIO
+ * - @ref DBus
*
* @section basics Basic Usage
*
View Lorry Controller Status