• Simon Horman's avatar
    ps3/gelic: minor Kernel Doc corrections · 3e596599
    Simon Horman authored
    * 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: default avatarSimon Horman <horms@kernel.org>
    Acked-by: default avatarGeoff Levand <geoff@infradead.org>
    Link: https://lore.kernel.org/r/20240221-ps3-gelic-kdoc-v1-1-7629216d1340@kernel.orgSigned-off-by: default avatarJakub Kicinski <kuba@kernel.org>
    3e596599
ps3_gelic_net.c 47.8 KB