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

memstick: core: fix kernel-doc notation

Use the correct kernel-doc format for function parameters (':'
instead of '-') to eliminate kernel-doc warnings.
Add some "Returns:" notations to functions.

memstick.c:206: warning: Function parameter or struct member 'host' not described in 'memstick_detect_change'
memstick.c:222: warning: Function parameter or struct member 'host' not described in 'memstick_next_req'
memstick.c:222: warning: Function parameter or struct member 'mrq' not described in 'memstick_next_req'
memstick.c:248: warning: Function parameter or struct member 'host' not described in 'memstick_new_req'
memstick.c:265: warning: Function parameter or struct member 'mrq' not described in 'memstick_init_req_sg'
memstick.c:265: warning: Function parameter or struct member 'tpc' not described in 'memstick_init_req_sg'
memstick.c:265: warning: Function parameter or struct member 'sg' not described in 'memstick_init_req_sg'
memstick.c:295: warning: Function parameter or struct member 'mrq' not described in 'memstick_init_req'
memstick.c:295: warning: Function parameter or struct member 'tpc' not described in 'memstick_init_req'
memstick.c:295: warning: Function parameter or struct member 'buf' not described in 'memstick_init_req'
memstick.c:295: warning: Function parameter or struct member 'length' not described in 'memstick_init_req'
memstick.c:366: warning: Function parameter or struct member 'card' not described in 'memstick_set_rw_addr'
memstick.c:513: warning: Function parameter or struct member 'host' not described in 'memstick_add_host'
memstick.c:549: warning: Function parameter or struct member 'host' not described in 'memstick_remove_host'
memstick.c:571: warning: Function parameter or struct member 'host' not described in 'memstick_free_host'
memstick.c:582: warning: Function parameter or struct member 'host' not described in 'memstick_suspend_host'
memstick.c:594: warning: Function parameter or struct member 'host' not described in 'memstick_resume_host'

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Maxim Levitsky <maximlevitsky@gmail.com>
Cc: Alex Dubov <oakad@yahoo.com>
Cc: Ulf Hansson <ulf.hansson@linaro.org>
Cc: linux-mmc@vger.kernel.org
Link: https://lore.kernel.org/r/20250111063230.910945-1-rdunlap@infradead.org
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>

authored by

Randy Dunlap and committed by
Greg Kroah-Hartman
a68d3cbf 73656a6a

+27 -19
+27 -19
drivers/memstick/core/memstick.c
··· 200 200 201 201 /** 202 202 * memstick_detect_change - schedule media detection on memstick host 203 - * @host - host to use 203 + * @host: host to use 204 204 */ 205 205 void memstick_detect_change(struct memstick_host *host) 206 206 { ··· 210 210 211 211 /** 212 212 * memstick_next_req - called by host driver to obtain next request to process 213 - * @host - host to use 214 - * @mrq - pointer to stick the request to 213 + * @host: host to use 214 + * @mrq: pointer to stick the request to 215 215 * 216 216 * Host calls this function from idle state (*mrq == NULL) or after finishing 217 217 * previous request (*mrq should point to it). If previous request was 218 - * unsuccessful, it is retried for predetermined number of times. Return value 219 - * of 0 means that new request was assigned to the host. 218 + * unsuccessful, it is retried for predetermined number of times. 219 + * 220 + * Returns: value of 0 means that new request was assigned to the host. 221 + * Otherwise a negative error code is returned. 220 222 */ 221 223 int memstick_next_req(struct memstick_host *host, struct memstick_request **mrq) 222 224 { ··· 244 242 245 243 /** 246 244 * memstick_new_req - notify the host that some requests are pending 247 - * @host - host to use 245 + * @host: host to use 248 246 */ 249 247 void memstick_new_req(struct memstick_host *host) 250 248 { ··· 258 256 259 257 /** 260 258 * memstick_init_req_sg - set request fields needed for bulk data transfer 261 - * @mrq - request to use 262 - * @tpc - memstick Transport Protocol Command 263 - * @sg - TPC argument 259 + * @mrq: request to use 260 + * @tpc: memstick Transport Protocol Command 261 + * @sg: TPC argument 264 262 */ 265 263 void memstick_init_req_sg(struct memstick_request *mrq, unsigned char tpc, 266 264 const struct scatterlist *sg) ··· 283 281 284 282 /** 285 283 * memstick_init_req - set request fields needed for short data transfer 286 - * @mrq - request to use 287 - * @tpc - memstick Transport Protocol Command 288 - * @buf - TPC argument buffer 289 - * @length - TPC argument size 284 + * @mrq: request to use 285 + * @tpc: memstick Transport Protocol Command 286 + * @buf: TPC argument buffer 287 + * @length: TPC argument size 290 288 * 291 289 * The intended use of this function (transfer of data items several bytes 292 290 * in size) allows us to just copy the value between request structure and ··· 362 360 /** 363 361 * memstick_set_rw_addr - issue SET_RW_REG_ADDR request and wait for it to 364 362 * complete 365 - * @card - media device to use 363 + * @card: media device to use 364 + * 365 + * Returns: error setting for the current request 366 366 */ 367 367 int memstick_set_rw_addr(struct memstick_dev *card) 368 368 { ··· 491 487 * memstick_alloc_host - allocate a memstick_host structure 492 488 * @extra: size of the user private data to allocate 493 489 * @dev: parent device of the host 490 + * 491 + * Returns: %NULL on failure or the allocated &memstick_host pointer on success 494 492 */ 495 493 struct memstick_host *memstick_alloc_host(unsigned int extra, 496 494 struct device *dev) ··· 513 507 514 508 /** 515 509 * memstick_add_host - start request processing on memstick host 516 - * @host - host to use 510 + * @host: host to use 511 + * 512 + * Returns: %0 on success or a negative error code on failure 517 513 */ 518 514 int memstick_add_host(struct memstick_host *host) 519 515 { ··· 551 543 552 544 /** 553 545 * memstick_remove_host - stop request processing on memstick host 554 - * @host - host to use 546 + * @host: host to use 555 547 */ 556 548 void memstick_remove_host(struct memstick_host *host) 557 549 { ··· 573 565 574 566 /** 575 567 * memstick_free_host - free memstick host 576 - * @host - host to use 568 + * @host: host to use 577 569 */ 578 570 void memstick_free_host(struct memstick_host *host) 579 571 { ··· 584 576 585 577 /** 586 578 * memstick_suspend_host - notify bus driver of host suspension 587 - * @host - host to use 579 + * @host: host to use 588 580 */ 589 581 void memstick_suspend_host(struct memstick_host *host) 590 582 { ··· 596 588 597 589 /** 598 590 * memstick_resume_host - notify bus driver of host resumption 599 - * @host - host to use 591 + * @host: host to use 600 592 */ 601 593 void memstick_resume_host(struct memstick_host *host) 602 594 {