]> git.ipfire.org Git - thirdparty/dbus.git/commitdiff
doxygen: fix example for dbus_message_append_args
authorFelipe Franciosi <felipe@nutanix.com>
Mon, 23 Sep 2019 12:22:32 +0000 (13:22 +0100)
committerFelipe Franciosi <felipe@nutanix.com>
Mon, 23 Sep 2019 12:22:32 +0000 (13:22 +0100)
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>
dbus/dbus-message.c

index edf76549f58357f2decd0016aec67ba35b96e435..45b1adfd6f6d868fe11b74b4b0add8d36d57a0b0 100644 (file)
@@ -1784,10 +1784,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