staging: fsl-dpaa2/ethsw: document nested structs as per kernel-doc
authorIoana Ciornei <ioana.ciornei@nxp.com>
Fri, 27 Jul 2018 14:43:18 +0000 (17:43 +0300)
committerGreg Kroah-Hartman <gregkh@linuxfoundation.org>
Fri, 27 Jul 2018 15:18:19 +0000 (17:18 +0200)
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>
drivers/staging/fsl-dpaa2/ethsw/dpsw.h

index 82f80c4..db43fa3 100644 (file)
@@ -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;