Thanks Jani. I will use free form comments in v4, meanwhile i will
explore the required stuff for kernel-doc and add kernel-doc entries
where ever it makes sense, in upcoming versions.
--Ram
On Thursday 17 May 2018 01:47 PM, Jani Nikula wrote:
On Thu, 17 May 2018, "C, Ramalingam" <ramalingam.c@xxxxxxxxx> wrote:
+/**
Drop the extra *, unless you really love it :)
ha ha. Actually I have added intentionally. But removing them across
all patches as per your suggestions. :)
/** is a syntax for KDoc, so if you want to receive automatic code
documentation you should use it and adhere to KDoc syntax
Thanks Alexander for the information. At present I am not adding the
KDoc support, if it is not compulsory. So I will remove the /**.
It's "kernel-doc" to be pedantic. No such thing as KDoc.
If you use /** please stick to the exact kernel-doc format. The below is
not. You'll find the documentation under Documentation/doc-guide.
If you drop /** please either use free form comments or stick to the
kernel-doc format. Please don't leave behind things that look eerily
similar to kernel-doc comments but are not. Without /** you won't even
get warnings about them.
/**
* mei_store_pairing_info - Store pairing info received from panel
* @cldev: Pointer for mei client device
* @data: Intel HW specific Data
* @pairing_info: Pointer for AKE_Send_Pairing_Info
*
* Returns 0 on success, <0 on failure.
*/
BR,
Jani.
--Ram
+ * mei_store_pairing_info:
+ * Function to store pairing info received from panel
+ *
+ * @cldev : Pointer for mei client device
+ * @data : Intel HW specific Data
+ * @pairing_info : Pointer for AKE_Send_Pairing_Info
+ *
+ * Returns 0 on Success, <0 on Failure */
_______________________________________________
Intel-gfx mailing list
Intel-gfx@xxxxxxxxxxxxxxxxxxxxx
https://lists.freedesktop.org/mailman/listinfo/intel-gfx
