crypto: qat - fix comment structure

aguerinIntel · herbertx · commit bca79b9f5639 · 2024-02-24T08:41:20.000+08:00
Move comment description to the same line as the function name.

This is to fix the following warning when compiling the QAT driver
using the clang compiler with CC=clang W=2:
    drivers/crypto/intel/qat/qat_common/qat_crypto.c:108: warning: missing initial short description on line:
     * qat_crypto_vf_dev_config()

Signed-off-by: Adam Guerin &lt;adam.guerin@intel.com&gt;
Reviewed-by: Giovanni Cabiddu &lt;giovanni.cabiddu@intel.com&gt;
Signed-off-by: Herbert Xu &lt;herbert@gondor.apana.org.au&gt;
diff --git a/drivers/crypto/intel/qat/qat_common/qat_crypto.c b/drivers/crypto/intel/qat/qat_common/qat_crypto.c
@@ -105,8 +105,8 @@ struct qat_crypto_instance *qat_crypto_get_instance_node(int node)
 }
 
 /**
- * qat_crypto_vf_dev_config()
- *     create dev config required to create crypto inst.
+ * qat_crypto_vf_dev_config() - create dev config required to create
+ * crypto inst.
  *
  * @accel_dev: Pointer to acceleration device.
  *

Original file line number	Diff line number	Diff line change
`@@ -105,8 +105,8 @@ struct qat_crypto_instance *qat_crypto_get_instance_node(int node)`
`105`	`105`	`}`
`106`	`106`
`107`	`107`	`/**`
`108`		`- * qat_crypto_vf_dev_config()`
`109`		`- * create dev config required to create crypto inst.`
	`108`	`+ * qat_crypto_vf_dev_config() - create dev config required to create`
	`109`	`+ * crypto inst.`
`110`	`110`	`*`
`111`	`111`	`* @accel_dev: Pointer to acceleration device.`
`112`	`112`	`*`