Commit a89a501c authored by Andrew Lunn's avatar Andrew Lunn Committed by Jakub Kicinski
Browse files

net: dcb: Fix kerneldoc warnings 



net//dcb/dcbnl.c:1836: warning: Function parameter or member 'app' not described in 'dcb_getapp'
net//dcb/dcbnl.c:1836: warning: Function parameter or member 'dev' not described in 'dcb_getapp'
net//dcb/dcbnl.c:1858: warning: Function parameter or member 'dev' not described in 'dcb_setapp'
net//dcb/dcbnl.c:1858: warning: Function parameter or member 'new' not described in 'dcb_setapp'
net//dcb/dcbnl.c:1899: warning: Function parameter or member 'app' not described in 'dcb_ieee_getapp_mask'
net//dcb/dcbnl.c:1899: warning: Function parameter or member 'dev' not described in 'dcb_ieee_getapp_mask'
net//dcb/dcbnl.c:1922: warning: Function parameter or member 'dev' not described in 'dcb_ieee_setapp'
net//dcb/dcbnl.c:1922: warning: Function parameter or member 'new' not described in 'dcb_ieee_setapp'
net//dcb/dcbnl.c:1953: warning: Function parameter or member 'del' not described in 'dcb_ieee_delapp'
net//dcb/dcbnl.c:1953: warning: Function parameter or member 'dev' not described in 'dcb_ieee_delapp'
net//dcb/dcbnl.c:1986: warning: Function parameter or member 'dev' not described in 'dcb_ieee_getapp_prio_dscp_mask_map'
net//dcb/dcbnl.c:1986: warning: Function parameter or member 'p_map' not described in 'dcb_ieee_getapp_prio_dscp_mask_map'
net//dcb/dcbnl.c:2016: warning: Function parameter or member 'dev' not described in 'dcb_ieee_getapp_dscp_prio_mask_map'
net//dcb/dcbnl.c:2016: warning: Function parameter or member 'p_map' not described in 'dcb_ieee_getapp_dscp_prio_mask_map'
net//dcb/dcbnl.c:2045: warning: Function parameter or member 'dev' not described in 'dcb_ieee_getapp_default_prio_mask'

For some of these warnings, change to comments to plain comments,
since no attempt is being made to follow kerneldoc syntax.

Signed-off-by: default avatarAndrew Lunn <andrew@lunn.ch>
Link: https://lore.kernel.org/r/20201028010913.930929-1-andrew@lunn.ch


Signed-off-by: default avatarJakub Kicinski <kuba@kernel.org>
parent 7cdda1c1

net/dcb/dcbnl.c

+13 −3
Original line number Diff line number Diff line
@@ -1827,6 +1827,8 @@ static int dcb_app_add(const struct dcb_app *app, int ifindex) 


/**

 * dcb_getapp - retrieve the DCBX application user priority

 * @dev: network interface

 * @app: application to get user priority of

 *

 * On success returns a non-zero 802.1p user priority bitmap

 * otherwise returns 0 as the invalid user priority bitmap to
@@ -1849,6 +1851,8 @@ EXPORT_SYMBOL(dcb_getapp); 


/**

 * dcb_setapp - add CEE dcb application data to app list

 * @dev: network interface

 * @new: application data to add

 *

 * Priority 0 is an invalid priority in CEE spec. This routine

 * removes applications from the app list if the priority is
@@ -1890,6 +1894,8 @@ EXPORT_SYMBOL(dcb_setapp); 


/**

 * dcb_ieee_getapp_mask - retrieve the IEEE DCB application priority

 * @dev: network interface

 * @app: where to store the retrieve application data

 *

 * Helper routine which on success returns a non-zero 802.1Qaz user

 * priority bitmap otherwise returns 0 to indicate the dcb_app was
@@ -1912,6 +1918,8 @@ EXPORT_SYMBOL(dcb_ieee_getapp_mask); 


/**

 * dcb_ieee_setapp - add IEEE dcb application data to app list

 * @dev: network interface

 * @new: application data to add

 *

 * This adds Application data to the list. Multiple application

 * entries may exists for the same selector and protocol as long
@@ -1946,6 +1954,8 @@ EXPORT_SYMBOL(dcb_ieee_setapp); 


/**

 * dcb_ieee_delapp - delete IEEE dcb application data from list

 * @dev: network interface

 * @del: application data to delete

 *

 * This removes a matching APP data from the APP list

 */
@@ -1975,7 +1985,7 @@ int dcb_ieee_delapp(struct net_device *dev, struct dcb_app *del) 
}

EXPORT_SYMBOL(dcb_ieee_delapp);



/**

/*

 * dcb_ieee_getapp_prio_dscp_mask_map - For a given device, find mapping from

 * priorities to the DSCP values assigned to that priority. Initialize p_map

 * such that each map element holds a bit mask of DSCP values configured for
@@ -2004,7 +2014,7 @@ void dcb_ieee_getapp_prio_dscp_mask_map(const struct net_device *dev, 
}

EXPORT_SYMBOL(dcb_ieee_getapp_prio_dscp_mask_map);



/**

/*

 * dcb_ieee_getapp_dscp_prio_mask_map - For a given device, find mapping from

 * DSCP values to the priorities assigned to that DSCP value. Initialize p_map

 * such that each map element holds a bit mask of priorities configured for a
@@ -2031,7 +2041,7 @@ dcb_ieee_getapp_dscp_prio_mask_map(const struct net_device *dev, 
}

EXPORT_SYMBOL(dcb_ieee_getapp_dscp_prio_mask_map);



/**

/*

 * Per 802.1Q-2014, the selector value of 1 is used for matching on Ethernet

 * type, with valid PID values >= 1536. A special meaning is then assigned to

 * protocol value of 0: "default priority. For use when priority is not

CRA Git | Maintained and supported by SUSTech CRA and CCSE