doc: Workaround kenrel-doc code scanner

dwsuse · dwsuse · commit b578ba9bc96d · 2022-06-27T08:19:47.000+02:00
The kernel-doc scanner trips over a void function. It will complain
with 'contents before sections'. To help out, explicitly move the
state machine into the next state which avoids the warning.

Signed-off-by: Daniel Wagner &lt;dwagner@suse.de&gt;
diff --git a/src/nvme/mi.h b/src/nvme/mi.h
@@ -363,8 +363,8 @@ void nvme_mi_close(nvme_mi_ep_t ep);
 /**
  * nvme_mi_scan_mctp - look for MCTP-connected NVMe-MI endpoints.
  *
- * This function queries the system mctp daemon ("mctpd") over dbus, to find
- * MCTP endpoints that report support for NVMe-MI over MCTP.
+ * Description: This function queries the system mctp daemon ("mctpd") over
+ * dbus, to find MCTP endpoints that report support for NVMe-MI over MCTP.
  *
  * This requires libvnme-mi to be compiled with D-Bus support; if not, this
  * will return NULL.

Original file line number	Diff line number	Diff line change
`@@ -363,8 +363,8 @@ void nvme_mi_close(nvme_mi_ep_t ep);`
`363`	`363`	`/**`
`364`	`364`	`* nvme_mi_scan_mctp - look for MCTP-connected NVMe-MI endpoints.`
`365`	`365`	`*`
`366`		`- * This function queries the system mctp daemon ("mctpd") over dbus, to find`
`367`		`- * MCTP endpoints that report support for NVMe-MI over MCTP.`
	`366`	`+ * Description: This function queries the system mctp daemon ("mctpd") over`
	`367`	`+ * dbus, to find MCTP endpoints that report support for NVMe-MI over MCTP.`
`368`	`368`	`*`
`369`	`369`	`* This requires libvnme-mi to be compiled with D-Bus support; if not, this`
`370`	`370`	`* will return NULL.`