[glibmm] giomm: Add class docs to recently added Application related classes.



commit f97840c840fc99507f6e91123f88456a3900b589
Author: Josà Alburquerque <jaalburqu svn gnome org>
Date:   Fri Feb 24 00:25:26 2012 -0500

    giomm: Add class docs to recently added Application related classes.
    
    	* gio/src/actionmap.hg:
    	* gio/src/dbusactiongroup.hg:
    	* gio/src/dbusmenumodel.hg:
    	* gio/src/menuattributeiter.hg:
    	* gio/src/menulinkiter.hg:
    	* gio/src/remoteactiongroup.hg:

 ChangeLog                    |   11 +++++++++++
 gio/src/actionmap.hg         |    8 +++++++-
 gio/src/dbusactiongroup.hg   |   11 +++++++----
 gio/src/dbusmenumodel.hg     |    6 +++++-
 gio/src/menuattributeiter.hg |    3 ++-
 gio/src/menulinkiter.hg      |    3 ++-
 gio/src/remoteactiongroup.hg |   21 ++++++++++++++++++++-
 7 files changed, 54 insertions(+), 9 deletions(-)
---
diff --git a/ChangeLog b/ChangeLog
index 8dbe766..b1c1187 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,16 @@
 2012-02-24  Josà Alburquerque  <jaalburquerque gmail com>
 
+	giomm: Add class docs to recently added Application related classes.
+
+	* gio/src/actionmap.hg:
+	* gio/src/dbusactiongroup.hg:
+	* gio/src/dbusmenumodel.hg:
+	* gio/src/menuattributeiter.hg:
+	* gio/src/menulinkiter.hg:
+	* gio/src/remoteactiongroup.hg:
+
+2012-02-24  Josà Alburquerque  <jaalburquerque gmail com>
+
 	MenuModel: Add the attribute and link constants.
 
 	* gio/src/dbusmenumodel.hg:
diff --git a/gio/src/actionmap.hg b/gio/src/actionmap.hg
index d2c6fb3..97c96f1 100644
--- a/gio/src/actionmap.hg
+++ b/gio/src/actionmap.hg
@@ -32,8 +32,14 @@ namespace Gio
 
 class Action;
 
-/** TODO (When the C API has docs is available).
+/** ActionMap - Interface for action containers.
+ * The ActionMap interface is implemented by ActionGroup implementations that
+ * operate by containing a number of named Action instances, such as
+ * SimpleActionGroup.
  *
+ * One useful application of this interface is to map the names of actions from
+ * various action groups to unique, prefixed names (e.g. by prepending "app."
+ * or "win."). This is the motivation for the 'Map' part of the interface name.
  * @newin{2,32}
  */
 class ActionMap : public Glib::Interface
diff --git a/gio/src/dbusactiongroup.hg b/gio/src/dbusactiongroup.hg
index b985a60..43e7a00 100644
--- a/gio/src/dbusactiongroup.hg
+++ b/gio/src/dbusactiongroup.hg
@@ -32,11 +32,14 @@ class Connection;
 
 _GMMPROC_EXTRA_NAMESPACE(DBus)
 
-/** TODO (When there is documentation available in the C API).
+/** ActionGroup - A D-Bus Gio::ActionGroup implementation.
+ * ActionGroup is an implementation of the Gio::ActionGroup interface that can
+ * be used as a proxy for an action group that is exported over D-Bus with
+ * Gio::DBus::Connection::export_action_group().
+ * @newin{2,32}
  */
-class ActionGroup : public Glib::Object,
-                    public ::Gio::ActionGroup,
-                    public RemoteActionGroup
+class ActionGroup
+: public Glib::Object, public ::Gio::ActionGroup, public RemoteActionGroup
 {
   _CLASS_GOBJECT(ActionGroup, GDBusActionGroup, G_DBUS_ACTION_GROUP, Glib::Object, GObject)
   _IMPLEMENTS_INTERFACE(::Gio::ActionGroup)
diff --git a/gio/src/dbusmenumodel.hg b/gio/src/dbusmenumodel.hg
index d0db8b1..3a902bb 100644
--- a/gio/src/dbusmenumodel.hg
+++ b/gio/src/dbusmenumodel.hg
@@ -30,7 +30,11 @@ class Connection;
 
 _GMMPROC_EXTRA_NAMESPACE(DBus)
 
-/** TODO (When the docs is available from the C API).
+/** MenuModel - A D-Bus Gio::MenuModel implementation.
+ * MenuModel is an implementation of Gio::MenuModel that can be used as a proxy
+ * for a menu model that is exported over D-Bus with
+ * Gio::DBus::Connection::export_menu_model().
+ * @newin{2,32}
  */
 class MenuModel : public ::Gio::MenuModel
 {
diff --git a/gio/src/menuattributeiter.hg b/gio/src/menuattributeiter.hg
index 087be76..b6ef95d 100644
--- a/gio/src/menuattributeiter.hg
+++ b/gio/src/menuattributeiter.hg
@@ -23,7 +23,8 @@ _PINCLUDE(glibmm/private/object_p.h)
 namespace Gio
 {
 
-/** TODO (When the docs is available from the C API).
+/** MenuAttributeIter - A menu attribute iterator.
+ * @newin{2,32}
  */
 class MenuAttributeIter : public Glib::Object
 {
diff --git a/gio/src/menulinkiter.hg b/gio/src/menulinkiter.hg
index d2b406a..b3606d0 100644
--- a/gio/src/menulinkiter.hg
+++ b/gio/src/menulinkiter.hg
@@ -25,7 +25,8 @@ namespace Gio
 
 class MenuModel;
 
-/** TODO (When the docs is available from the C API).
+/** MenuLinkIter - A menu link iterator.
+ * @newin{2,32}
  */
 class MenuLinkIter : public Glib::Object
 {
diff --git a/gio/src/remoteactiongroup.hg b/gio/src/remoteactiongroup.hg
index 13a3b73..4dda8af 100644
--- a/gio/src/remoteactiongroup.hg
+++ b/gio/src/remoteactiongroup.hg
@@ -30,7 +30,26 @@ typedef struct _GRemoteActionGroupInterface GRemoteActionGroupInterface;
 namespace Gio
 {
 
-/** TODO (When the C API docs is available).
+/** RemoteActionGroup - a ActionGroup that interacts with other processes.
+ * The RemoteActionGroup interface is implemented by ActionGroup instances that
+ * either transmit action invocations to other processes or receive action
+ * invocations in the local process from other processes.
+ *
+ * The interface has variants of the two methods on ActionGroup used to
+ * activate actions: Gio::ActionGroup::activate_action() and
+ * Gio::ActionGroup::change_action_state(). These variants allow a "platform
+ * data" Glib::VariantBase to be specified: a dictionary providing context for
+ * the action invocation (for example: timestamps, startup notification IDs,
+ * etc).
+ *
+ * Gio::DBus::ActionGroup implements RemoteActionGroup. This provides a
+ * mechanism to send platform data for action invocations over D-Bus.
+ *
+ * Additionally, Gio::DBus::Connection::export_action_group() will check if the
+ * exported ActionGroup implements RemoteActionGroup and use the variants of
+ * the calls if available. This provides a mechanism by which to receive
+ * platform data for action invocations that arrive by way of D-Bus.
+ * @newin{2,32}
  */
 class RemoteActionGroup : public Glib::Interface
 {



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