summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFelipe Franciosi <felipe@nutanix.com>2019-09-23 13:22:32 +0100
committerSimon McVittie <smcv@collabora.com>2020-04-20 20:06:41 +0100
commitced04aabc7fe5f82c6acfc8f0a2178117798f219 (patch)
tree89c3b88380a634072f9b5fe736172747a52cb575
parent3e40637b10a6f83bdffc987a7b13f6b5b4ff3695 (diff)
downloaddbus-ced04aabc7fe5f82c6acfc8f0a2178117798f219.tar.gz
doxygen: fix example for dbus_message_append_args
Commit 724adb2f6 mangled the dbus_message_append_args() code example. This fixes it by breaking the lines and aligning at the right places. Signed-off-by: Felipe Franciosi <felipe@nutanix.com>
-rw-r--r--dbus/dbus-message.c14
1 files changed, 10 insertions, 4 deletions
diff --git a/dbus/dbus-message.c b/dbus/dbus-message.c
index 43b3a9fb..84d8c0ca 100644
--- a/dbus/dbus-message.c
+++ b/dbus/dbus-message.c
@@ -1773,10 +1773,16 @@ dbus_message_get_type (DBusMessage *message)
* To append an array of fixed-length basic types (except Unix file
* descriptors), pass in the DBUS_TYPE_ARRAY typecode, the element
* typecode, the address of the array pointer, and a 32-bit integer
- * giving the number of elements in the array. So for example: @code
- * const dbus_int32_t array[] = { 1, 2, 3 }; const dbus_int32_t
- * *v_ARRAY = array; dbus_message_append_args (message,
- * DBUS_TYPE_ARRAY, DBUS_TYPE_INT32, &v_ARRAY, 3, DBUS_TYPE_INVALID);
+ * giving the number of elements in the array. So for example:
+ *
+ * @code
+ *
+ * const dbus_int32_t array[] = { 1, 2, 3 };
+ * const dbus_int32_t *v_ARRAY = array;
+ * dbus_message_append_args (message,
+ * DBUS_TYPE_ARRAY, DBUS_TYPE_INT32, &v_ARRAY, 3,
+ * DBUS_TYPE_INVALID);
+ *
* @endcode
*
* This function does not support arrays of Unix file descriptors. If