[cluttermm] Added class documentation for the Action abstract base class
- From: Murray Cumming <murrayc src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [cluttermm] Added class documentation for the Action abstract base class
- Date: Mon, 10 Mar 2014 08:36:38 +0000 (UTC)
commit 491dc377a0319cf210cd0f76623691ece9567b68
Author: Ian Martin <martin_id vodafone co nz>
Date: Mon Mar 10 20:43:04 2014 +1300
Added class documentation for the Action abstract base class
clutter/src/action.hg | 15 +++++++++++++--
1 files changed, 13 insertions(+), 2 deletions(-)
---
diff --git a/clutter/src/action.hg b/clutter/src/action.hg
index 38dae2a..9baeb12 100644
--- a/clutter/src/action.hg
+++ b/clutter/src/action.hg
@@ -25,7 +25,18 @@ _PINCLUDE(cluttermm/private/actor-meta_p.h)
namespace Clutter
{
-//TODO: Write a version of the large description from here:
http://clutter-project.org/docs/clutter/stable/ClutterAction.html#ClutterAction.description
+/** Abstract Action (Base class for all actions)
+ *
+ * This is the base class of all actions. It is an abstract class that
+ * can not be instantiated.
+ *
+ * Implementations of Clutter::Action are associated with an actor and can
+ * provide behavioral changes when dealing with user input - for instance
+ * drag and drop capabilities, or scrolling, or panning - by using the
+ * various event-related signals provided by ClutterActor itself.
+ *
+ * ClutterAction is available since Clutter 1.4
+ * */
class Action : public ActorMeta
{
_CLASS_GOBJECT(Action, ClutterAction, CLUTTER_ACTION, ActorMeta, ClutterActorMeta)
@@ -40,7 +51,7 @@ public:
//There are no functions.
- //TODO: Signals, properties, vfuncs
+ //there are no signals, properties, vfuncs
};
} // namespace Clutter
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]