summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMurray Cumming <murrayc@murrayc.com>2011-03-24 10:13:18 +0100
committerMurray Cumming <murrayc@murrayc.com>2011-03-24 10:13:18 +0100
commita88cba4913276302646a45574f03463aa9be668c (patch)
tree768f14901688260dc10ec5a9273577d67171fb54
parent82b6e49bd75b044069cb4d953de9bdcf3dc9ae01 (diff)
downloadglibmm-a88cba4913276302646a45574f03463aa9be668c.tar.gz
More minor documentation corrections.
* gio/src/dbusauthobserver.hg: * gio/src/dbusconnection.hg: * gio/src/dbusmessage.hg: * gio/src/dbusmethodinvocation.hg: * gio/src/dbusproxy.hg: * gio/src/dbusserver.hg: * gio/src/dbussubtreevtable.hg: * glib/src/varianttype.hg: More fixes since the change from DBus* to DBus::.
-rw-r--r--ChangeLog13
-rw-r--r--gio/src/dbusauthobserver.hg8
-rw-r--r--gio/src/dbusconnection.hg12
-rw-r--r--gio/src/dbusmessage.hg3
-rw-r--r--gio/src/dbusmethodinvocation.hg6
-rw-r--r--gio/src/dbusproxy.hg2
-rw-r--r--gio/src/dbusserver.hg5
-rw-r--r--gio/src/dbussubtreevtable.hg2
-rw-r--r--glib/src/varianttype.hg8
9 files changed, 35 insertions, 24 deletions
diff --git a/ChangeLog b/ChangeLog
index 4970af67..161c9ee7 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,16 @@
+2011-03-24 Murray Cumming <murrayc@murrayc.com>>
+
+ More minor documentation corrections.
+
+ * gio/src/dbusauthobserver.hg:
+ * gio/src/dbusconnection.hg:
+ * gio/src/dbusmessage.hg:
+ * gio/src/dbusmethodinvocation.hg:
+ * gio/src/dbusproxy.hg:
+ * gio/src/dbusserver.hg:
+ * gio/src/dbussubtreevtable.hg:
+ * glib/src/varianttype.hg: More fixes since the change from DBus* to DBus::.
+
2011-03-24 Murray Cumming <murrayc@murrayc.com>
Documentation: Change DBus to D-Bus.
diff --git a/gio/src/dbusauthobserver.hg b/gio/src/dbusauthobserver.hg
index 7723e4de..fdcc11d8 100644
--- a/gio/src/dbusauthobserver.hg
+++ b/gio/src/dbusauthobserver.hg
@@ -33,10 +33,10 @@ namespace DBus
_GMMPROC_EXTRA_NAMESPACE(DBus)
//TODO: Add example from the C API docs in class docs.
-/** DBusAuthObserver - Object used for authenticating connections.
- * The DBusAuthObserver type provides a mechanism for participating in how a
- * DBusServer (or a DBus::Connection) authenticates remote peers. Simply
- * instantiate a DBusAuthObserver and connect to the signals you are
+/** Ah object used for authenticating connections.
+ * The AuthObserver type provides a mechanism for participating in how a
+ * Server (or a Connection) authenticates remote peers. Simply
+ * instantiate an AuthObserver and connect to the signals you are
* interested in. Note that new signals may be added in the future.
*
* @newin{2,28}
diff --git a/gio/src/dbusconnection.hg b/gio/src/dbusconnection.hg
index 102624b2..7a5c19e3 100644
--- a/gio/src/dbusconnection.hg
+++ b/gio/src/dbusconnection.hg
@@ -177,8 +177,8 @@ public:
* message, bool incoming);.
* @endcode
*
- * A filter function is passed a DBusMessage and expected to return a
- * DBusMessage too. Passive filter functions that don't modify the message
+ * A filter function is passed a Message and expected to return a
+ * Message too. Passive filter functions that don't modify the message
* can simply return the message object. Filter functions that wants to
* drop a message can simply return <tt>0</tt>. And filter function may
* modify a message by copying it and return the copy.
@@ -528,7 +528,7 @@ public:
*
* See the C API docs for examples.
*
- * @param message A DBusMessage.
+ * @param message A Message.
* @param timeout_msec The timeout in milliseconds or -1 to use the default
* timeout.
* @param slot A SlotAsyncReady to call when the request is satisfied.
@@ -567,7 +567,7 @@ public:
* operation fails with Gio::IO_ERROR_INVALID_ARGUMENT.
*
* Note that a Glib::Error is thrown if a local in-process error occured.
- * That is to say that the returned DBusMessage object may be of type
+ * That is to say that the returned Message object may be of type
* G_DBUS_MESSAGE_TYPE_ERROR. Use Gio::DBus::Message::to_exception() to
* transcode this to a Glib::Error.
*
@@ -576,11 +576,11 @@ public:
* Note that message must be unlocked, unless flags contain the
* Gio::DBus::SEND_MESSAGE_FLAGS_PRESERVE_SERIAL flag.
*
- * @param message A DBusMessage.
+ * @param message A Message.
* @param cancellable A Cancellable.
* @param timeout_msec The timeout in milliseconds or -1 to use the default
* timeout.
- * @return A locked DBusMessage that is the reply to @a message or
+ * @return A locked Message that is the reply to @a message or
* <tt>0</tt> if a Glib::Error is thrown.
* @throw Glib::Error.
* @newin{2,28}
diff --git a/gio/src/dbusmessage.hg b/gio/src/dbusmessage.hg
index 48b4d43b..2c5972af 100644
--- a/gio/src/dbusmessage.hg
+++ b/gio/src/dbusmessage.hg
@@ -38,8 +38,7 @@ _WRAP_ENUM(CapabilityFlags, GDBusCapabilityFlags, s#^DBUS_##, NO_GTYPE)
_GMMPROC_EXTRA_NAMESPACE(DBus)
-/** DBusMessage - D-Bus Message.
- * A type for representing D-Bus messages that can be sent or received on a
+/** A type for representing D-Bus messages that can be sent or received on a
* Connection.
*
* @newin{2,28}
diff --git a/gio/src/dbusmethodinvocation.hg b/gio/src/dbusmethodinvocation.hg
index bbe84db7..dde86857 100644
--- a/gio/src/dbusmethodinvocation.hg
+++ b/gio/src/dbusmethodinvocation.hg
@@ -36,12 +36,12 @@ class Connection;
_GMMPROC_EXTRA_NAMESPACE(DBus)
-/** DBusMethodInvocation - Object for handling remote calls.
- * Instances of the DBusMethodInvocation class are used when handling D-Bus
+/** An Object for handling remote calls.
+ * Instances of the MethodInvocation class are used when handling D-Bus
* method calls. It provides a way to asynchronously return results and
* errors.
*
- * The normal way to obtain a DBusMethodInvocation object is to receive it as
+ * The normal way to obtain a MethodInvocation object is to receive it as
* an argument to the SlotMethodCall that was passed to
* Gio::DBus::Connection::register_object().
*
diff --git a/gio/src/dbusproxy.hg b/gio/src/dbusproxy.hg
index 9010a91b..7924e262 100644
--- a/gio/src/dbusproxy.hg
+++ b/gio/src/dbusproxy.hg
@@ -297,7 +297,7 @@ public:
* @param method_name Name of method to invoke.
* @param timeout_msec The timeout in milliseconds or -1 to use the proxy
* default timeout.
- * @param flags Flags from the DBus::CallFlags enumeration.
+ * @param flags Flags from the CallFlags enumeration.
* @param parameters A Glib::VariantBase tuple with parameters for the
* signal.
* @param cancellable A Cancellable.
diff --git a/gio/src/dbusserver.hg b/gio/src/dbusserver.hg
index fcfc5ba0..540f1a2b 100644
--- a/gio/src/dbusserver.hg
+++ b/gio/src/dbusserver.hg
@@ -36,9 +36,8 @@ _WRAP_ENUM(ServerFlags, GDBusServerFlags, s#^DBUS_##, NO_GTYPE)
_GMMPROC_EXTRA_NAMESPACE(DBus)
//TODO: Add example from the C API in class docs.
-/** DBusServer - Helper for accepting connections.
- * DBusServer is a helper for listening to and accepting D-Bus connections.
- * Since DBusServer implements the Initable interface, its constructors can
+/** This is a helper for listening to and accepting D-Bus connections.
+ * Since Server derives from Initiable, its constructors can
* throw an exception if construction fails.
*
* @newin{2,28}
diff --git a/gio/src/dbussubtreevtable.hg b/gio/src/dbussubtreevtable.hg
index e3fde65f..ec519eda 100644
--- a/gio/src/dbussubtreevtable.hg
+++ b/gio/src/dbussubtreevtable.hg
@@ -82,7 +82,7 @@ public:
* object at this node.
*
* If this function returns a non-empty vector, the return value is expected
- * to be a list of DBusInterfaceInfo structures describing the interfaces
+ * to be a list of InterfaceInfo structures describing the interfaces
* implemented by node.
*
* for example,
diff --git a/glib/src/varianttype.hg b/glib/src/varianttype.hg
index f59e018a..c94ee287 100644
--- a/glib/src/varianttype.hg
+++ b/glib/src/varianttype.hg
@@ -43,7 +43,7 @@ namespace Glib
*
* The second major change is that the VariantBase type system supports
* the concept of "indefinite types" -- types that are less specific than the
- * normal types found in DBus. For example, it is possible to speak of "an
+ * normal types found in D-Bus. For example, it is possible to speak of "an
* array of any type" in VariantBase, where the D-Bus type system would
* require you to speak of "an array of integers" or "an array of strings".
* Indefinite types have been added by introducing the characters "*", "?" and
@@ -53,9 +53,9 @@ namespace Glib
* lifted along with the restriction that dictionary entries may only appear
* nested inside of arrays.
*
- * Just as in DBus, VariantBase types are described with strings ("type
+ * Just as in D-Bus, VariantBase types are described with strings ("type
* strings"). Subject to the differences mentioned above, these strings are of
- * the same form as those found in DBus. Note, however: D-Bus always works in
+ * the same form as those found in D-Bus. Note, however: D-Bus always works in
* terms of messages and therefore individual type strings appear nowhere in
* its interface. Instead, "signatures" are a concatenation of the strings of
* the type of each argument in a message. VariantBase deals with single
@@ -69,7 +69,7 @@ namespace Glib
* as its type, but values can exist that have types that are subtypes of
* indefinite types. That is to say, VariantBase::get_type() will never
* return an indefinite type, but calling VariantBase::is_of_type() with
- * an indefinite type may return <tt>true</tt>. For example, you can not have a
+ * an indefinite type may return <tt>true</tt>. For example, you cannot have a
* value that represents "an array of no particular type", but you can have an
* "array of integers" which certainly matches the type of "an array of no
* particular type", since "array of integers" is a subtype of "array of no