Re: [PATCH v2 01/12] scsi: core: Suppress a kernel-doc warning

On 12/12/21 19:03, Bart Van Assche wrote:

On 12/12/21 18:53, Randy Dunlap wrote:

quoted

On 11/29/21 11:45, Bart Van Assche wrote:

quoted

-/**
+/*
   * scsi_enable_async_suspend - Enable async suspend and resume
   */
  void scsi_enable_async_suspend(struct device *dev)

Why this instead of describing @dev: ?

  * @dev: the struct device to enable for async suspend and resume

Hi Randy,

I expect that anyone can guess the meaning of the @dev argument without adding any explanation. Hence the choice to convert the kernel-doc comment into a regular comment.

That's probably true, but we do try to document (using kernel-doc)
non-static functions for other people's use.

Oh well. Thanks.

-- 
~Randy