[gtkmm/gtkmm-2-22] gdkmm: Avoid most Documentation warnings from gmmproc.



commit be57941d0c850f03dcab2020d620326d2f5955d9
Author: Murray Cumming <murrayc murrayc com>
Date:   Fri Sep 3 23:10:01 2010 +0200

    gdkmm: Avoid most Documentation warnings from gmmproc.
    
    * gdk/src/filelist.am:
    * gdk/src/gdk.defs:
    * gdk/src/gdk_extra_objects.defs: Added this *extra_objects.defs file,
    with hand-coded define-object sections, for objects that hide their *Class
    or *Iface struct declarations, which stops h2defs.py from generating
    define-object sections.
    These allows DocsParser.pm to know how to split mentions of C functions into
    the object and the method, so it can guess the C++ method name to mention
    instead.

 ChangeLog                      |   14 ++++++++++++++
 gdk/src/filelist.am            |    1 +
 gdk/src/gdk.defs               |    1 +
 gdk/src/gdk_extra_objects.defs |   31 +++++++++++++++++++++++++++++++
 4 files changed, 47 insertions(+), 0 deletions(-)
---
diff --git a/ChangeLog b/ChangeLog
index 38cb63c..5c37060 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,19 @@
 2010-09-13  Murray Cumming  <murrayc murrayc com>
 
+  gdkmm: Avoid most Documentation warnings from gmmproc.
+
+	* gdk/src/filelist.am:
+	* gdk/src/gdk.defs:
+	* gdk/src/gdk_extra_objects.defs: Added this *extra_objects.defs file,
+	with hand-coded define-object sections, for objects that hide their *Class
+	or *Iface struct declarations, which stops h2defs.py from generating
+	define-object sections.
+	These allows DocsParser.pm to know how to split mentions of C functions into
+	the object and the method, so it can guess the C++ method name to mention
+	instead.
+
+2010-09-13  Murray Cumming  <murrayc murrayc com>
+
 	IconView: Added get/set_item_orientation().
 
 	* gtk/src/gtk_methods.defs: Regenerated with h2defs.py.
diff --git a/gdk/src/filelist.am b/gdk/src/filelist.am
index b148adb..e248e23 100644
--- a/gdk/src/filelist.am
+++ b/gdk/src/filelist.am
@@ -5,6 +5,7 @@ gdkmm_files_defs =		\
 	gdk_enums.defs		\
 	gdk_extra.defs		\
 	gdk_methods.defs	\
+	gdk_extra_objects.defs	\
 	gdk_pixbuf_methods.defs		\
 	gdk_pixbuf_enums.defs	\
 	gdk_signals.defs	\
diff --git a/gdk/src/gdk.defs b/gdk/src/gdk.defs
index 4f833a8..20dbc9e 100644
--- a/gdk/src/gdk.defs
+++ b/gdk/src/gdk.defs
@@ -1,4 +1,5 @@
 (include gdk_methods.defs)
+(include gdk_extra_objects.defs)
 (include gdk_pixbuf_methods.defs)
 (include gdk_pixbuf_enums.defs)
 (include gdk_signals.defs)
diff --git a/gdk/src/gdk_extra_objects.defs b/gdk/src/gdk_extra_objects.defs
new file mode 100644
index 0000000..9f76252
--- /dev/null
+++ b/gdk/src/gdk_extra_objects.defs
@@ -0,0 +1,31 @@
+; 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 Event
+  (in-module "Gdk")
+  (c-name "GdkEvent")
+  (gtype-id "GDK_TYPE_EVENT")
+)
+
+(define-object Region
+  (in-module "Gdk")
+  (c-name "GdkRegion")
+  (gtype-id "GDK_TYPE_REGION")
+)
+
+(define-object Visual
+  (in-module "Gdk")
+  (c-name "GdkVisual")
+  (gtype-id "GDK_TYPE_VISUAL")
+)
+
+(define-object Window
+  (in-module "Gdk")
+  (c-name "GdkWindow")
+  (gtype-id "GDK_TYPE_WINDOW")
+)



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