Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

staging: most: dim2: hal: Fix one kernel-doc header and demote two non-conforming ones

Fixes the following W=1 kernel build warning(s):

drivers/staging/most/dim2/hal.c:99: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
drivers/staging/most/dim2/hal.c:788: warning: Function parameter or member 'buf_size' not described in 'dim_norm_isoc_buffer_size'
drivers/staging/most/dim2/hal.c:788: warning: Function parameter or member 'packet_length' not described in 'dim_norm_isoc_buffer_size'
drivers/staging/most/dim2/hal.c:788: warning: expecting prototype for Retrieves maximal possible correct buffer size for isochronous data type(). Prototype was for dim_norm_isoc_buffer_size() instead
drivers/staging/most/dim2/hal.c:802: warning: Function parameter or member 'buf_size' not described in 'dim_norm_sync_buffer_size'
drivers/staging/most/dim2/hal.c:802: warning: Function parameter or member 'bytes_per_frame' not described in 'dim_norm_sync_buffer_size'
drivers/staging/most/dim2/hal.c:802: warning: expecting prototype for Retrieves maximal possible correct buffer size for synchronous data type(). Prototype was for dim_norm_sync_buffer_size() instead

Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Cc: Andrey Shvetsov <andrey.shvetsov@k2l.de>
Cc: linux-staging@lists.linux.dev
Signed-off-by: Lee Jones <lee.jones@linaro.org>
Link: https://lore.kernel.org/r/20210414181129.1628598-35-lee.jones@linaro.org
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>

authored by

Lee Jones and committed by
Greg Kroah-Hartman
7af9b444 f74afcfd

+3 -3
+3 -3
drivers/staging/most/dim2/hal.c
··· 97 97 98 98 /** 99 99 * Allocates DBR memory. 100 - * @param size Allocating memory size. 100 + * @size: Allocating memory size. 101 101 * @return Offset in DBR memory by success or DBR_SIZE if out of memory. 102 102 */ 103 103 static int alloc_dbr(u16 size) ··· 778 778 writel(0, &g.dim2->MS1); 779 779 } 780 780 781 - /** 781 + /* 782 782 * Retrieves maximal possible correct buffer size for isochronous data type 783 783 * conform to given packet length and not bigger than given buffer size. 784 784 * ··· 792 792 return norm_isoc_buffer_size(buf_size, packet_length); 793 793 } 794 794 795 - /** 795 + /* 796 796 * Retrieves maximal possible correct buffer size for synchronous data type 797 797 * conform to given bytes per frame and not bigger than given buffer size. 798 798 *