[1/7] misc: mei: hw.h: fix kernel-doc warnings

Message ID 20231012024845.29169-2-rdunlap@infradead.org
State New
Headers
Series misc: mei: fix all kernel-doc warnings |

Commit Message

Randy Dunlap Oct. 12, 2023, 2:48 a.m. UTC
  Fix kernel-doc warnings in hw.h:

hw.h:809: warning: missing initial short description on line:
 * struct hbm_client_dma_unmap_request
hw.h:812: warning: contents before sections
hw.h:825: warning: missing initial short description on line:
 * struct hbm_client_dma_response
hw.h:828: warning: contents before sections

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Tomas Winkler <tomas.winkler@intel.com>
Cc: Arnd Bergmann <arnd@arndb.de>
Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
---
 drivers/misc/mei/hw.h |    8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)
  

Patch

diff -- a/drivers/misc/mei/hw.h b/drivers/misc/mei/hw.h
--- a/drivers/misc/mei/hw.h
+++ b/drivers/misc/mei/hw.h
@@ -806,8 +806,8 @@  struct hbm_client_dma_map_request {
 } __packed;
 
 /**
- * struct hbm_client_dma_unmap_request
- *    client dma unmap request from the host to the firmware
+ * struct hbm_client_dma_unmap_request - client dma unmap request
+ *        from the host to the firmware
  *
  * @hbm_cmd: bus message command header
  * @status: unmap status
@@ -822,8 +822,8 @@  struct hbm_client_dma_unmap_request {
 } __packed;
 
 /**
- * struct hbm_client_dma_response
- *   client dma unmap response from the firmware to the host
+ * struct hbm_client_dma_response - client dma unmap response
+ *        from the firmware to the host
  *
  * @hbm_cmd: bus message command header
  * @status: command status