• Randy Dunlap's avatar
    net/tipc: fix tipc header files for kernel-doc · ff10527e
    Randy Dunlap authored
    Fix tipc header files for adding to the networking docbook.
    
    Remove some uses of "/**" that were not kernel-doc notation.
    
    Fix some source formatting to eliminate Sphinx warnings.
    
    Add missing struct member and function argument kernel-doc descriptions.
    
    Correct the description of a couple of struct members that were
    marked as "(FIXME)".
    
    Documentation/networking/tipc:18: ../net/tipc/name_table.h:65: WARNING: Unexpected indentation.
    Documentation/networking/tipc:18: ../net/tipc/name_table.h:66: WARNING: Block quote ends without a blank line; unexpected unindent.
    
    ../net/tipc/bearer.h:128: warning: Function parameter or member 'min_win' not described in 'tipc_media'
    ../net/tipc/bearer.h:128: warning: Function parameter or member 'max_win' not described in 'tipc_media'
    
    ../net/tipc/bearer.h:171: warning: Function parameter or member 'min_win' not described in 'tipc_bearer'
    ../net/tipc/bearer.h:171: warning: Function parameter or member 'max_win' not described in 'tipc_bearer'
    ../net/tipc/bearer.h:171: warning: Function parameter or member 'disc' not described in 'tipc_bearer'
    ../net/tipc/bearer.h:171: warning: Function parameter or member 'up' not described in 'tipc_bearer'
    ../net/tipc/bearer.h:171: warning: Function parameter or member 'refcnt' not described in 'tipc_bearer'
    
    ../net/tipc/name_distr.h:68: warning: Function parameter or member 'port' not described in 'distr_item'
    
    ../net/tipc/name_table.h:111: warning: Function parameter or member 'services' not described in 'name_table'
    ../net/tipc/name_table.h:111: warning: Function parameter or member 'cluster_scope_lock' not described in 'name_table'
    ../net/tipc/name_table.h:111: warning: Function parameter or member 'rc_dests' not described in 'name_table'
    ../net/tipc/name_table.h:111: warning: Function parameter or member 'snd_nxt' not described in 'name_table'
    
    ../net/tipc/subscr.h:67: warning: Function parameter or member 'kref' not described in 'tipc_subscription'
    ../net/tipc/subscr.h:67: warning: Function parameter or member 'net' not described in 'tipc_subscription'
    ../net/tipc/subscr.h:67: warning: Function parameter or member 'service_list' not described in 'tipc_subscription'
    ../net/tipc/subscr.h:67: warning: Function parameter or member 'conid' not described in 'tipc_subscription'
    ../net/tipc/subscr.h:67: warning: Function parameter or member 'inactive' not described in 'tipc_subscription'
    ../net/tipc/subscr.h:67: warning: Function parameter or member 'lock' not described in 'tipc_subscription'
    Signed-off-by: default avatarRandy Dunlap <rdunlap@infradead.org>
    Signed-off-by: default avatarJakub Kicinski <kuba@kernel.org>
    ff10527e
name_table.h 6.35 KB