[glibmm] gmmproc: Improve the documentation of properties.
- From: Kjell Ahlstedt <kjellahl src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [glibmm] gmmproc: Improve the documentation of properties.
- Date: Thu, 1 Nov 2012 18:54:03 +0000 (UTC)
commit 59d61969c4bee65b1c8641f6b9fbb778deee3ed0
Author: Kjell Ahlstedt <kjell ahlstedt bredband net>
Date: Thu Nov 1 19:50:27 2012 +0100
gmmproc: Improve the documentation of properties.
* tools/m4/property.m4: Change "the property of the value" to "the value of
the property". Make the description of the return value different for
PropertyProxy, PropertyProxy_ReadOnly and PropertyProxy_WriteOnly.
ChangeLog | 8 ++++++++
tools/m4/property.m4 | 7 ++++---
2 files changed, 12 insertions(+), 3 deletions(-)
---
diff --git a/ChangeLog b/ChangeLog
index b8a248a..51228ad 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,11 @@
+2012-11-01 Kjell Ahlstedt <kjell ahlstedt bredband net>
+
+ gmmproc: Improve the documentation of properties.
+
+ * tools/m4/property.m4: Change "the property of the value" to "the value of
+ the property". Make the description of the return value different for
+ PropertyProxy, PropertyProxy_ReadOnly and PropertyProxy_WriteOnly.
+
2012-10-30 Josà Alburquerque <jaalburquerque gmail com>
Resolver: Add lookup_records() and lookup_records_finish().
diff --git a/tools/m4/property.m4 b/tools/m4/property.m4
index 2d270a9..119f21c 100644
--- a/tools/m4/property.m4
+++ b/tools/m4/property.m4
@@ -8,7 +8,7 @@ dnl
dnl $1 $2 $3 $4 $5 $6
dnl _PROPERTY_PROXY(name, name_underscored, cpp_type, proxy_suffix, deprecated, docs)
-dnl proxy_suffix could be "_WriteOnly" or "_ReadOnly"
+dnl proxy_suffix could be "", "_WriteOnly" or "_ReadOnly"
dnl The method will be const if the propertyproxy is _ReadOnly.
dnl
define(`_PROPERTY_PROXY',`dnl
@@ -21,8 +21,9 @@ Glib::PropertyProxy$4< _QUOTE($3) >'dnl
/** $6
*
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
- * @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
- * the value of the property changes.
+ * @return A PropertyProxy$4 that allows you to dnl
+ifelse($4,_ReadOnly,get,`ifelse($4,_WriteOnly,set,get or set)') the value of the property,
+ * or receive notification when the value of the property changes.
*/
__PROXY_TYPE__ property_$2`'() ifelse($4,_ReadOnly, const,);
#endif //#GLIBMM_PROPERTIES_ENABLED
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]