summaryrefslogtreecommitdiffstats
path: root/dbus/dbus-string.c
diff options
context:
space:
mode:
Diffstat (limited to 'dbus/dbus-string.c')
-rw-r--r--dbus/dbus-string.c10
1 files changed, 9 insertions, 1 deletions
diff --git a/dbus/dbus-string.c b/dbus/dbus-string.c
index 17a7d918..a5bf3ebc 100644
--- a/dbus/dbus-string.c
+++ b/dbus/dbus-string.c
@@ -374,7 +374,11 @@ _dbus_string_get_data (DBusString *str,
}
/**
- * Gets the raw character buffer from a const string.
+ * Gets the raw character buffer from a const string.
+ *
+ * @todo should return the const char* instead of using an out param;
+ * the temporary variable encourages a bug where you use const data
+ * after modifying the string and possibly causing a realloc.
*
* @param str the string
* @param data_return location to store returned data
@@ -420,6 +424,10 @@ _dbus_string_get_data_len (DBusString *str,
/**
* const version of _dbus_string_get_data_len().
*
+ * @todo should return the const char* instead of using an out param;
+ * the temporary variable encourages a bug where you use const data
+ * after modifying the string and possibly causing a realloc.
+ *
* @param str the string
* @param data_return location to return the buffer
* @param start byte offset to return