[cluttermm] Add extra .defs for documentation generation.



commit 4e53a70bbd7a276eaa221decf9aea0260bd8f64f
Author: Murray Cumming <murrayc murrayc com>
Date:   Thu Apr 10 10:18:26 2014 +0200

    Add extra .defs for documentation generation.
    
    * clutter/src/clutter_extra_objects.defs:
    * clutter/src/filelist.am: Add this extra .defs file just to tell
      the documentation generator about interfaces that otherwise
      would not show up in the .defs files.
    * clutter/src/clutter.defs: Include the new .defs file.
    * codegen/extradefs/generate_extra_defs_clutter.cc: Add a type
      here too, also for the documentation generator.
    * clutter/src/clutter_signals.defs: Regenerate, keeping the
      hand-coded changes.

 clutter/src/clutter.defs                         |    1 +
 clutter/src/clutter_extra_objects.defs           |   33 ++++++++++++++++++++++
 clutter/src/clutter_signals.defs                 |   29 +++++++++++++++++++
 clutter/src/filelist.am                          |    1 +
 codegen/extradefs/generate_extra_defs_clutter.cc |    1 +
 5 files changed, 65 insertions(+), 0 deletions(-)
---
diff --git a/clutter/src/clutter.defs b/clutter/src/clutter.defs
index 1ae66e9..b51733d 100644
--- a/clutter/src/clutter.defs
+++ b/clutter/src/clutter.defs
@@ -3,3 +3,4 @@
 (include clutter_vfuncs.defs)
 (include clutter_enums.defs)
 (include clutter_others.defs)
+(include clutter_extra_objects.defs)
diff --git a/clutter/src/clutter_extra_objects.defs b/clutter/src/clutter_extra_objects.defs
new file mode 100644
index 0000000..2c70e2e
--- /dev/null
+++ b/clutter/src/clutter_extra_objects.defs
@@ -0,0 +1,33 @@
+; These define-object declarations were not generated by h2defs.py
+; because it looks for the SomethingClass declaration too, but that is often
+; hidden.
+; However, it is needed by the documentation generation, which needs to
+; know what objects exist, so it can guess how to break apart C function names
+; that are mentioned in documentation text.
+; (DocsParser.pm:substitute_function(), which uses GtkDefs.pm:lookup_object().)
+
+(define-object AlignConstraint
+  (in-module "Clutter")
+  (c-name "ClutterAlignConstraint")
+  (gtype-id "CLUTTER_TYPE_ALIGN_CONSTRAINT")
+)
+
+(define-object BindConstraint
+  (in-module "Clutter")
+  (c-name "ClutterBindConstraint")
+  (gtype-id "CLUTTER_TYPE_BIND_CONSTRAINT")
+)
+
+(define-object SnapConstraint
+  (in-module "Clutter")
+  (c-name "ClutterSnapConstraint")
+  (gtype-id "CLUTTER_TYPE_SNAP_CONSTRAINT")
+)
+
+(define-object PageTurnEffect
+  (in-module "Clutter")
+  (c-name "ClutterPageTurnEffect")
+  (gtype-id "CLUTTER_TYPE_PAGE_TURN_EFFECT")
+)
+
+
diff --git a/clutter/src/clutter_signals.defs b/clutter/src/clutter_signals.defs
index 4c805d5..d245c14 100644
--- a/clutter/src/clutter_signals.defs
+++ b/clutter/src/clutter_signals.defs
@@ -2099,6 +2099,35 @@
   (construct-only #f)
 )
 
+;; From ClutterPageTurnEffect
+
+(define-property period
+  (of-object "ClutterPageTurnEffect")
+  (prop-type "GParamDouble")
+  (docs "The period of the page turn")
+  (readable #t)
+  (writable #t)
+  (construct-only #f)
+)
+
+(define-property angle
+  (of-object "ClutterPageTurnEffect")
+  (prop-type "GParamDouble")
+  (docs "The angle of the page rotation, in degrees")
+  (readable #t)
+  (writable #t)
+  (construct-only #f)
+)
+
+(define-property radius
+  (of-object "ClutterPageTurnEffect")
+  (prop-type "GParamFloat")
+  (docs "The radius of the page curl")
+  (readable #t)
+  (writable #t)
+  (construct-only #f)
+)
+
 ;; From ClutterPath
 
 (define-property description
diff --git a/clutter/src/filelist.am b/clutter/src/filelist.am
index ba2dcba..2bf4854 100644
--- a/clutter/src/filelist.am
+++ b/clutter/src/filelist.am
@@ -7,6 +7,7 @@ files_defs =                    \
        clutter_others.defs     \
        clutter_signals.defs    \
        clutter_vfuncs.defs     \
+       clutter_extra_objects.defs \
        clutter_docs.xml        \
        clutter_docs_override.xml
 
diff --git a/codegen/extradefs/generate_extra_defs_clutter.cc 
b/codegen/extradefs/generate_extra_defs_clutter.cc
index 272df7f..6d91d77 100644
--- a/codegen/extradefs/generate_extra_defs_clutter.cc
+++ b/codegen/extradefs/generate_extra_defs_clutter.cc
@@ -75,6 +75,7 @@ int main(int argc, char** argv)
     << get_defs(CLUTTER_TYPE_LAYOUT_MANAGER)
     << get_defs(CLUTTER_TYPE_LAYOUT_META)
     << get_defs(CLUTTER_TYPE_MEDIA)
+    << get_defs(CLUTTER_TYPE_PAGE_TURN_EFFECT)
     << get_defs(CLUTTER_TYPE_PATH)
     << get_defs(CLUTTER_TYPE_PATH_CONSTRAINT)
     << get_defs(CLUTTER_TYPE_PROPERTY_TRANSITION)


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