i3c: doc: Make documentation readable

finikorg · mmahadevan108 · commit 7c50ab1f0364 · 2022-09-12T10:25:29.000-05:00
Use @code .. @Endcode blocks to make docs readable. Signed-off-by: Andrei Emeltchenko <andrei.emeltchenko@intel.com>
diff --git a/include/zephyr/drivers/i3c.h b/include/zephyr/drivers/i3c.h
@@ -1542,6 +1542,7 @@ static inline int i3c_reg_update_byte(struct i3c_device_desc *target,
  *
  * It looks something like this (with name "testing"):
  *
+ * @code
  * D: I3C msg: testing, addr=56
  * D:    W len=01:
  * D: contents:
@@ -1550,6 +1551,7 @@ static inline int i3c_reg_update_byte(struct i3c_device_desc *target,
  * D: contents:
  * D: 00 01 02 03 04 05 06 07 |........
  * D: 08 09 0a 0b 0c 0d       |......
+ * @endcode
  *
  * @param name Name of this dump, displayed at the top.
  * @param msgs Array of messages to dump.

Original file line number	Diff line number	Diff line change
`@@ -1542,6 +1542,7 @@ static inline int i3c_reg_update_byte(struct i3c_device_desc *target,`
`1542`	`1542`	`*`
`1543`	`1543`	`* It looks something like this (with name "testing"):`
`1544`	`1544`	`*`
	`1545`	`+ * @code`
`1545`	`1546`	`* D: I3C msg: testing, addr=56`
`1546`	`1547`	`* D: W len=01:`
`1547`	`1548`	`* D: contents:`
`@@ -1550,6 +1551,7 @@ static inline int i3c_reg_update_byte(struct i3c_device_desc *target,`
`1550`	`1551`	`* D: contents:`
`1551`	`1552`	`* D: 00 01 02 03 04 05 06 07 \|........`
`1552`	`1553`	`* D: 08 09 0a 0b 0c 0d \|......`
	`1554`	`+ * @endcode`
`1553`	`1555`	`*`
`1554`	`1556`	`* @param name Name of this dump, displayed at the top.`
`1555`	`1557`	`* @param msgs Array of messages to dump.`