rpmsg: glink: fix some kerneldoc comments
authorAlex Elder <elder@linaro.org>
Tue, 5 Jan 2021 23:56:03 +0000 (17:56 -0600)
committerBjorn Andersson <bjorn.andersson@linaro.org>
Wed, 6 Jan 2021 03:45:06 +0000 (21:45 -0600)
The kerneldoc comments for the do_cleanup_msg and cleanup_done_msg
structures describe the fields, but don't prefix the field names
with "@".  Add those, to get rid of some W=1 build warnings on
an x86_64 architecture build.

Signed-off-by: Alex Elder <elder@linaro.org>
Link: https://lore.kernel.org/r/20210105235603.32663-1-elder@linaro.org
Signed-off-by: Bjorn Andersson <bjorn.andersson@linaro.org>
drivers/rpmsg/qcom_glink_ssr.c

index dcd1ce6..1fc2bf5 100644 (file)
 
 /**
  * struct do_cleanup_msg - The data structure for an SSR do_cleanup message
- * version:     The G-Link SSR protocol version
- * command:     The G-Link SSR command - do_cleanup
- * seq_num:     Sequence number
- * name_len:    Length of the name of the subsystem being restarted
- * name:        G-Link edge name of the subsystem being restarted
+ * @version:   The G-Link SSR protocol version
+ * @command:   The G-Link SSR command - do_cleanup
+ * @seq_num:   Sequence number
+ * @name_len:  Length of the name of the subsystem being restarted
+ * @name:      G-Link edge name of the subsystem being restarted
  */
 struct do_cleanup_msg {
        __le32 version;
@@ -28,9 +28,9 @@ struct do_cleanup_msg {
 
 /**
  * struct cleanup_done_msg - The data structure for an SSR cleanup_done message
- * version:     The G-Link SSR protocol version
- * response:    The G-Link SSR response to a do_cleanup command, cleanup_done
- * seq_num:     Sequence number
+ * @version:   The G-Link SSR protocol version
+ * @response:  The G-Link SSR response to a do_cleanup command, cleanup_done
+ * @seq_num:   Sequence number
  */
 struct cleanup_done_msg {
        __le32 version;