ps3/gelic: minor Kernel Doc corrections
authorSimon Horman <horms@kernel.org>
Wed, 21 Feb 2024 17:46:21 +0000 (17:46 +0000)
committerJakub Kicinski <kuba@kernel.org>
Sat, 24 Feb 2024 00:23:50 +0000 (16:23 -0800)
commit3e596599372e7823d08c658fde85bfc8bae9ba83
tree4b4be0c453e8814d0f2a10dde6b327ecd7246d4b
parent025f8ad20f2e3264d11683aa9cbbf0083eefbdcd
ps3/gelic: minor Kernel Doc corrections

* Update the Kernel Doc for gelic_descr_set_tx_cmdstat()
  and gelic_net_setup_netdev() so that documented name
  and the actual name of the function match.

* Move define of GELIC_ALIGN() so that it is no longer
  between gelic_alloc_card_net() and it's Kernel Doc.

* Document netdev parameter of gelic_alloc_card_net()
  in a way consistent to the documentation of other netdev parameters
  in this file.

Addresses the following warnings flagged by ./scripts/kernel-doc -none:

  .../ps3_gelic_net.c:711: warning: expecting prototype for gelic_net_set_txdescr_cmdstat(). Prototype was for gelic_descr_set_tx_cmdstat() instead
  .../ps3_gelic_net.c:1474: warning: expecting prototype for gelic_ether_setup_netdev(). Prototype was for gelic_net_setup_netdev() instead
  .../ps3_gelic_net.c:1528: warning: expecting prototype for gelic_alloc_card_net(). Prototype was for GELIC_ALIGN() instead
  .../ps3_gelic_net.c:1531: warning: Function parameter or struct member 'netdev' not described in 'gelic_alloc_card_net'

Signed-off-by: Simon Horman <horms@kernel.org>
Acked-by: Geoff Levand <geoff@infradead.org>
Link: https://lore.kernel.org/r/20240221-ps3-gelic-kdoc-v1-1-7629216d1340@kernel.org
Signed-off-by: Jakub Kicinski <kuba@kernel.org>
drivers/net/ethernet/toshiba/ps3_gelic_net.c