most: most.h: fix lots of kernel-doc warnings

Browse source

- document enums with the "enum" keyword
- add a description for @dbr_size
- add missing descriptions to struct most_interface (some just need
  a ':' to be good)
- add missing descriptions to struct most_component
- use Returns: syntax for function return values
- convert most_deregister_interface() to kernel-doc notation and fix
  its parameter name

Repairs these warnings:

Warning: include/linux/most.h:17 This comment starts with '/**',
 but isn't a kernel-doc comment.
 * Interface type
Warning: include/linux/most.h:32 This comment starts with '/**',
 but isn't a kernel-doc comment.
 * Channel direction.
Warning: include/linux/most.h:40 This comment starts with '/**',
 but isn't a kernel-doc comment.
 * Channel data type.
Warning: include/linux/most.h:131 struct member 'dbr_size' not
 described in 'most_channel_config'
Warning: include/linux/most.h:191 This comment starts with '/**',
 but isn't a kernel-doc comment.
 * Interface instance description.
Warning: include/linux/most.h:274 struct member 'mod' not described
 in 'most_component'
Warning: include/linux/most.h:274 struct member 'cfg_complete' not
 described in 'most_component'
Warning: include/linux/most.h:288 This comment starts with '/**',
 but isn't a kernel-doc comment.
 * Deregisters instance of the interface.
Warning: include/linux/most.h:292 No description found for return value
 of 'most_register_interface'
Warning: include/linux/most.h:298 function parameter 'iface' not
 described in 'most_deregister_interface'

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Link: https://patch.msgid.link/20260719051123.2458641-1-rdunlap@infradead.org
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>

...

This commit is contained in:

Randy Dunlap 2026-07-18 22:11:23 -07:00 • committed by Greg Kroah-Hartman

parent 18dd0b4e48

commit d07b6f53f0

1 changed files with 22 additions and 15 deletions

Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL

Download patch file Download diff file Expand all files Collapse all files

37

include/linux/most.h

View file