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

staging: most: dim2: hal: Demote non-conformant kernel-doc headers

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: Lee Jones <lee.jones@linaro.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-36-lee.jones@linaro.org
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>

authored by

Lee Jones and committed by
Greg Kroah-Hartman
51ca97af 7af9b444

+4 -4
+2 -2
drivers/staging/most/dim2/hal.c
··· 96 96 } 97 97 98 98 /** 99 - * Allocates DBR memory. 99 + * alloc_dbr() - Allocates DBR memory. 100 100 * @size: Allocating memory size. 101 - * @return Offset in DBR memory by success or DBR_SIZE if out of memory. 101 + * Returns: Offset in DBR memory by success or DBR_SIZE if out of memory. 102 102 */ 103 103 static int alloc_dbr(u16 size) 104 104 {
+2 -2
drivers/staging/qlge/qlge_main.c
··· 1389 1389 } 1390 1390 } 1391 1391 1392 - /** 1392 + /* 1393 1393 * qlge_update_mac_hdr_len - helper routine to update the mac header length 1394 1394 * based on vlan tags if present 1395 1395 */ ··· 2235 2235 } 2236 2236 } 2237 2237 2238 - /** 2238 + /* 2239 2239 * qlge_update_hw_vlan_features - helper routine to reinitialize the adapter 2240 2240 * based on the features to enable/disable hardware vlan accel 2241 2241 */