[cluttermm] Documentation improvement.
- From: Murray Cumming <murrayc src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [cluttermm] Documentation improvement.
- Date: Wed, 5 May 2010 21:23:33 +0000 (UTC)
commit 10c9cc037dca803dda0725a981c0983032a65214
Author: Murray Cumming <murrayc murrayc com>
Date: Wed May 5 23:23:25 2010 +0200
Documentation improvement.
* clutter/cluttermm.pc.in: Correct htmlrefpub so clutter-gtkmm's documentation
can link to the library.gnome.org cluttermm documentation.
* clutter/src/stage.hg: Added class documentation based on the C docs.
ChangeLog | 10 ++++++++++
clutter/cluttermm.pc.in | 2 +-
clutter/src/actor.hg | 1 +
clutter/src/stage.hg | 15 +++++++++++++++
4 files changed, 27 insertions(+), 1 deletions(-)
---
diff --git a/ChangeLog b/ChangeLog
index 89025b6..c59b4f3 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,13 @@
+2010-05-05 Murray Cumming <murrayc murrayc-x61>
+
+ Documentation improvement.
+
+ * clutter/cluttermm.pc.in: Correct htmlrefpub so clutter-gtkmm's documentation
+ can link to the library.gnome.org cluttermm documentation.
+ * clutter/src/stage.hg: Added class documentation based on the C docs.
+
+0.9.6:
+
2010-05-05 Murray Cumming <murrayc murrayc com>
Small API additions.
diff --git a/clutter/cluttermm.pc.in b/clutter/cluttermm.pc.in
index dc43b21..a3d511b 100644
--- a/clutter/cluttermm.pc.in
+++ b/clutter/cluttermm.pc.in
@@ -9,7 +9,7 @@ gmmprocdir=${datadir}/@CLUTTERMM_MODULE_NAME@/proc
docdir=${datarootdir}/doc/@CLUTTERMM_MODULE_NAME@
doxytagfile=${docdir}/reference/@CLUTTERMM_MODULE_NAME tag
htmlrefdir=${docdir}/reference/html
-htmlrefpub=http://library.gnome.org/@PACKAGE_TARNAME@/unstable/
+htmlrefpub=http://library.gnome.org/devel/@PACKAGE_TARNAME@/unstable/
Name: cluttermm
Description: C++ binding for clutter
diff --git a/clutter/src/actor.hg b/clutter/src/actor.hg
index aa100cf..340dc1b 100644
--- a/clutter/src/actor.hg
+++ b/clutter/src/actor.hg
@@ -53,6 +53,7 @@ public:
_WRAP_ENUM(ActorFlags, ClutterActorFlags)
_WRAP_ENUM(AllocationFlags, ClutterAllocationFlags)
+//TODO: Write a version of the large description from here: http://clutter-project.org/docs/clutter/stable/ClutterActor.html#ClutterActor.description
class Actor : public Glib::Object, public Scriptable
{
_CLASS_GOBJECT(Actor, ClutterActor, CLUTTER_ACTOR, Glib::Object, GObject)
diff --git a/clutter/src/stage.hg b/clutter/src/stage.hg
index 8ebf057..5b54214 100644
--- a/clutter/src/stage.hg
+++ b/clutter/src/stage.hg
@@ -45,6 +45,21 @@ public:
_MEMBER_SET(z_far, z_far, Cogl::Fixed, CoglFixed)
};
+//TODO: Wrap clutter_feature_available(), as mentioned in the class comment.
+
+/** This is a top level 'window' on which child actors are placed and manipulated.
+ *
+ * Clutter creates a default stage upon initialization, which can be retrieved using Stage::get_default(). Clutter always
+ * provides the default stage, unless the backend is unable to create one. The stage returned by Stage::get_default() is
+ * guaranteed to always be the same.
+ *
+ * Backends might provide support for multiple stages. The support for this feature can be checked at run-time using the
+ * clutter_feature_available() function and the CLUTTER_FEATURE_STAGE_MULTIPLE flag. If the backend used supports multiple
+ * stages, new Clutter::Stage instances can be created.
+ *
+ * Clutter::Stage is a proxy actor, wrapping the backend-specific implementation of the windowing system. It is possible
+ * to subclass ClutterStage, as long as every overridden virtual function calls the implementation in the base class.
+ */
class Stage :
public Group
{
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]