Skip to content

Commit

Permalink
staging: fsl-dpaa2/ethsw: document nested structs as per kernel-doc
Browse files Browse the repository at this point in the history
Document nested structs per kernel-doc requirements by moving
all comments before the actual struct.

Signed-off-by: Ioana Ciornei <ioana.ciornei@nxp.com>
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
  • Loading branch information
Ioana Ciornei authored and Greg Kroah-Hartman committed Jul 27, 2018
1 parent f970bec commit a89bac0
Showing 1 changed file with 12 additions and 15 deletions.
27 changes: 12 additions & 15 deletions drivers/staging/fsl-dpaa2/ethsw/dpsw.h
Original file line number Diff line number Diff line change
Expand Up @@ -79,24 +79,21 @@ enum dpsw_component_type {
* struct dpsw_cfg - DPSW configuration
* @num_ifs: Number of external and internal interfaces
* @adv: Advanced parameters; default is all zeros;
* use this structure to change default settings
* use this structure to change default settings
* @adv.options: Enable/Disable DPSW features (bitmap)
* @adv.max_vlans: Maximum Number of VLAN's; 0 - indicates default 16
* @adv.max_meters_per_if: Number of meters per interface
* @adv.max_fdbs: Maximum Number of FDB's; 0 - indicates default 16
* @adv.max_fdb_entries: Number of FDB entries for default FDB table;
* 0 - indicates default 1024 entries.
* @adv.fdb_aging_time: Default FDB aging time for default FDB table;
* 0 - indicates default 300 seconds
* @adv.max_fdb_mc_groups: Number of multicast groups in each FDB table;
* 0 - indicates default 32
* @adv.component_type: Indicates the component type of this bridge
*/
struct dpsw_cfg {
u16 num_ifs;
/**
* struct adv - Advanced parameters
* @options: Enable/Disable DPSW features (bitmap)
* @max_vlans: Maximum Number of VLAN's; 0 - indicates default 16
* @max_meters_per_if: Number of meters per interface
* @max_fdbs: Maximum Number of FDB's; 0 - indicates default 16
* @max_fdb_entries: Number of FDB entries for default FDB table;
* 0 - indicates default 1024 entries.
* @fdb_aging_time: Default FDB aging time for default FDB table;
* 0 - indicates default 300 seconds
* @max_fdb_mc_groups: Number of multicast groups in each FDB table;
* 0 - indicates default 32
* @component_type: Indicates the component type of this bridge
*/
struct {
u64 options;
u16 max_vlans;
Expand Down

0 comments on commit a89bac0

Please sign in to comment.