[glibmm] Show get_type() in the API documentation.
- From: Murray Cumming <murrayc src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [glibmm] Show get_type() in the API documentation.
- Date: Mon, 16 Jul 2012 09:19:45 +0000 (UTC)
commit 816a7b8da3936c416835a5d46697c212d20f1466
Author: Murray Cumming <murrayc murrayc com>
Date: Mon Jul 16 11:13:55 2012 +0200
Show get_type() in the API documentation.
* tools/m4/class_boxedtype.m4:
* tools/m4/class_boxedtype_static.m4:
* tools/m4/class_gobject.m4:
* tools/m4/class_interface.m4: Move the static get_type()
functions out of the ifdef so that doxygen can see them,
because they are sometimes needed, for instance when
implementing a custom container.
Bug #670212 (Mark Vender).
ChangeLog | 13 +++++++++++++
tools/m4/class_boxedtype.m4 | 4 +++-
tools/m4/class_boxedtype_static.m4 | 4 +++-
tools/m4/class_gobject.m4 | 4 +++-
tools/m4/class_interface.m4 | 5 ++++-
5 files changed, 26 insertions(+), 4 deletions(-)
---
diff --git a/ChangeLog b/ChangeLog
index 3d8ce88..63bbebd 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,16 @@
+2012-07-16 Murray Cumming <murrayc murrayc com>
+
+ Show get_type() in the API documentation.
+
+ * tools/m4/class_boxedtype.m4:
+ * tools/m4/class_boxedtype_static.m4:
+ * tools/m4/class_gobject.m4:
+ * tools/m4/class_interface.m4: Move the static get_type()
+ functions out of the ifdef so that doxygen can see them,
+ because they are sometimes needed, for instance when
+ implementing a custom container.
+ Bug #670212 (Mark Vender).
+
2012-07-10 Krzesimir Nowak <qdlacz gmail com>
Glib::Checksum: Fix a typo.
diff --git a/tools/m4/class_boxedtype.m4 b/tools/m4/class_boxedtype.m4
index fce5f65..1a9b731 100644
--- a/tools/m4/class_boxedtype.m4
+++ b/tools/m4/class_boxedtype.m4
@@ -190,9 +190,11 @@ public:
#ifndef DOXYGEN_SHOULD_SKIP_THIS
typedef __CPPNAME__ CppObjectType;
typedef __CNAME__ BaseObjectType;
+#endif /* DOXYGEN_SHOULD_SKIP_THIS */
+ /** Get the GType for this class, for use with the underlying GObject type system.
+ */
static GType get_type() G_GNUC_CONST;
-#endif /* DOXYGEN_SHOULD_SKIP_THIS */
ifdef(`__BOOL_CUSTOM_DEFAULT_CTOR__',`dnl
',`dnl else
diff --git a/tools/m4/class_boxedtype_static.m4 b/tools/m4/class_boxedtype_static.m4
index b242150..ecda942 100644
--- a/tools/m4/class_boxedtype_static.m4
+++ b/tools/m4/class_boxedtype_static.m4
@@ -141,9 +141,11 @@ public:
#ifndef DOXYGEN_SHOULD_SKIP_THIS
typedef __CPPNAME__ CppObjectType;
typedef __CNAME__ BaseObjectType;
+#endif /* DOXYGEN_SHOULD_SKIP_THIS */
+ /** Get the GType for this class, for use with the underlying GObject type system.
+ */
static GType get_type() G_GNUC_CONST;
-#endif /* DOXYGEN_SHOULD_SKIP_THIS */
ifdef(`__BOOL_CUSTOM_DEFAULT_CTOR__',,`dnl else
__CPPNAME__`'();
diff --git a/tools/m4/class_gobject.m4 b/tools/m4/class_gobject.m4
index f56fd7a..b73069e 100644
--- a/tools/m4/class_gobject.m4
+++ b/tools/m4/class_gobject.m4
@@ -247,9 +247,11 @@ public:
_IMPORT(SECTION_DTOR_DOCUMENTATION)
virtual ~__CPPNAME__`'();
-#ifndef DOXYGEN_SHOULD_SKIP_THIS
+ /** Get the GType for this class, for use with the underlying GObject type system.
+ */
static GType get_type() G_GNUC_CONST;
+#ifndef DOXYGEN_SHOULD_SKIP_THIS
ifdef(`__BOOL_DYNAMIC_GTYPE_REGISTRATION__',`
static GType get_type(GTypeModule* module) G_GNUC_CONST;
',`')
diff --git a/tools/m4/class_interface.m4 b/tools/m4/class_interface.m4
index e47925c..99d1d75 100644
--- a/tools/m4/class_interface.m4
+++ b/tools/m4/class_interface.m4
@@ -259,8 +259,11 @@ _IMPORT(SECTION_DTOR_DOCUMENTATION)
static void add_interface(GType gtype_implementer);
-#ifndef DOXYGEN_SHOULD_SKIP_THIS
+ /** Get the GType for this class, for use with the underlying GObject type system.
+ */
static GType get_type() G_GNUC_CONST;
+
+#ifndef DOXYGEN_SHOULD_SKIP_THIS
static GType get_base_type() G_GNUC_CONST;
#endif
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]