[PATCH] ALSA: hda - add missing documentation to hdac_i915

[Takashi Iwai]

On Thu, 24 Sep 2020 17:40:43 +0200,
Kai Vehmanen wrote:
> 
> Document missing function arguments and fix make W=1
> warning:
> 
> sound/hda/hdac_i915.c:80: warning: Function parameter or member 'i915' not described in 'connectivity_check'
> sound/hda/hdac_i915.c:80: warning: Function parameter or member 'hdac' not described in 'connectivity_check'
> 
> Fixes: 7b882fe3e3e8 ('ALSA: hda - handle multiple i915 device instances')
> Signed-off-by: Kai Vehmanen <kai.vehmanen at linux.intel.com>

Do we really need to put this internal function in the API documents?
If not, the right fix would be to drop the kerneldoc marker instead.


thanks,

Takashi

> ---
>  sound/hda/hdac_i915.c | 2 ++
>  1 file changed, 2 insertions(+)
> 
> diff --git a/sound/hda/hdac_i915.c b/sound/hda/hdac_i915.c
> index d236e497435d..9592d0c0c254 100644
> --- a/sound/hda/hdac_i915.c
> +++ b/sound/hda/hdac_i915.c
> @@ -75,6 +75,8 @@ EXPORT_SYMBOL_GPL(snd_hdac_i915_set_bclk);
>  
>  /**
>   * Returns true if the devices can be connected for audio.
> + * @i915: i915 PCI device
> + * @hdac: HDA audio controller PCI device
>   */
>  static bool connectivity_check(struct pci_dev *i915, struct pci_dev *hdac)
>  {
> -- 
> 2.27.0
>