Add pedantic rules on keywords in comments (#496)

All marked keywords should be written in capital letters

Author: kcudnik

inc/saiacl.h

@@ -79,7 +79,7 @@ typedef enum _sai_acl_ip_type_t
     /** IPv4 and IPv6 packets */
     SAI_ACL_IP_TYPE_IP,
 
-    /** Non-Ip packet */
+    /** Non-IP packet */
     SAI_ACL_IP_TYPE_NON_IP,
 
     /** Any IPv4 packet */
@@ -268,7 +268,7 @@ typedef enum _sai_acl_table_group_attr_t
      * groups to let the user specify his intention to allow further error
      * checks and optimizations based on a specific ASIC's SAI implementation.
      * ACL members being added to this group SHOULD be a subset of the bind
-     * point list that acl group was created with.
+     * point list that ACL group was created with.
      *
      * @type sai_s32_list_t sai_acl_bind_point_type_t
      * @flags CREATE_ONLY
@@ -282,8 +282,8 @@ typedef enum _sai_acl_table_group_attr_t
      * ACL table group type represents the way various ACL tables within this
      * ACL table group perform their lookups. There are two optional values :
      * Sequential - All the ACL tables are looked up in a sequential order ,
-     * which is based on the ACL table priorities and only one acl entry is matched
-     * with its corresponding acl entry action applied. In case two ACL tables
+     * which is based on the ACL table priorities and only one ACL entry is matched
+     * with its corresponding ACL entry action applied. In case two ACL tables
      * have the same priority they are looked up on a first come basis.
      * Parallel - All the ACL tables within the ACL table groups are looked up
      * in parallel and non-conflicting actions are resolved and applied from
@@ -326,7 +326,7 @@ typedef enum _sai_acl_table_group_member_attr_t
      * @brief ACL table group id
      *
      * This attribute is required to associate or attach a member object (acl_table_id)
-     * to a acl table group id allocated by the create acl group api.
+     * to a ACL table group id allocated by the create ACL group api.
      *
      * User should always use the group id returned by SAI create_acl_group api,
      * to group the tables else Invalid attribute value error code will be returned.
@@ -703,7 +703,7 @@ typedef enum _sai_acl_table_attr_t
     SAI_ACL_TABLE_ATTR_FIELD_IP_IDENTIFICATION,
 
     /**
-     * @brief Ip Dscp
+     * @brief IP DSCP
      *
      * @type bool
      * @flags CREATE_ONLY
@@ -712,7 +712,7 @@ typedef enum _sai_acl_table_attr_t
     SAI_ACL_TABLE_ATTR_FIELD_DSCP,
 
     /**
-     * @brief Ip Ecn
+     * @brief IP ECN
      *
      * @type bool
      * @flags CREATE_ONLY
@@ -721,7 +721,7 @@ typedef enum _sai_acl_table_attr_t
     SAI_ACL_TABLE_ATTR_FIELD_ECN,
 
     /**
-     * @brief Ip Ttl
+     * @brief IP TTL
      *
      * @type bool
      * @flags CREATE_ONLY
@@ -730,7 +730,7 @@ typedef enum _sai_acl_table_attr_t
     SAI_ACL_TABLE_ATTR_FIELD_TTL,
 
     /**
-     * @brief Ip Tos
+     * @brief IP TOS
      *
      * @type bool
      * @flags CREATE_ONLY
@@ -739,7 +739,7 @@ typedef enum _sai_acl_table_attr_t
     SAI_ACL_TABLE_ATTR_FIELD_TOS,
 
     /**
-     * @brief Ip Flags
+     * @brief IP Flags
      *
      * @type bool
      * @flags CREATE_ONLY
@@ -748,7 +748,7 @@ typedef enum _sai_acl_table_attr_t
     SAI_ACL_TABLE_ATTR_FIELD_IP_FLAGS,
 
     /**
-     * @brief Tcp Flags
+     * @brief TCP Flags
      *
      * @type bool
      * @flags CREATE_ONLY
@@ -757,7 +757,7 @@ typedef enum _sai_acl_table_attr_t
     SAI_ACL_TABLE_ATTR_FIELD_TCP_FLAGS,
 
     /**
-     * @brief Ip Type
+     * @brief IP Type
      *
      * @type bool
      * @flags CREATE_ONLY
@@ -766,7 +766,7 @@ typedef enum _sai_acl_table_attr_t
     SAI_ACL_TABLE_ATTR_FIELD_ACL_IP_TYPE,
 
     /**
-     * @brief Ip Frag
+     * @brief IP Frag
      *
      * @type bool
      * @flags CREATE_ONLY
@@ -1130,7 +1130,7 @@ typedef enum _sai_acl_entry_attr_t
     SAI_ACL_ENTRY_ATTR_FIELD_OUT_PORT,
 
     /**
-     * @brief Source port which could be a physical or lag port
+     * @brief Source port which could be a physical or LAG port
      * (mask is not needed)
      *
      * @type sai_acl_field_data_t sai_object_id_t
@@ -1234,63 +1234,63 @@ typedef enum _sai_acl_entry_attr_t
     SAI_ACL_ENTRY_ATTR_FIELD_IP_IDENTIFICATION,
 
     /**
-     * @brief Ip Dscp (6 bits)
+     * @brief IP DSCP (6 bits)
      *
      * @type sai_acl_field_data_t sai_uint8_t
      * @flags CREATE_AND_SET
      */
     SAI_ACL_ENTRY_ATTR_FIELD_DSCP,
 
     /**
-     * @brief Ip Ecn (2 bits)
+     * @brief IP ECN (2 bits)
      *
      * @type sai_acl_field_data_t sai_uint8_t
      * @flags CREATE_AND_SET
      */
     SAI_ACL_ENTRY_ATTR_FIELD_ECN,
 
     /**
-     * @brief Ip Ttl
+     * @brief IP TTL
      *
      * @type sai_acl_field_data_t sai_uint8_t
      * @flags CREATE_AND_SET
      */
     SAI_ACL_ENTRY_ATTR_FIELD_TTL,
 
     /**
-     * @brief Ip Tos
+     * @brief IP TOS
      *
      * @type sai_acl_field_data_t sai_uint8_t
      * @flags CREATE_AND_SET
      */
     SAI_ACL_ENTRY_ATTR_FIELD_TOS,
 
     /**
-     * @brief Ip Flags (3 bits)
+     * @brief IP Flags (3 bits)
      *
      * @type sai_acl_field_data_t sai_uint8_t
      * @flags CREATE_AND_SET
      */
     SAI_ACL_ENTRY_ATTR_FIELD_IP_FLAGS,
 
     /**
-     * @brief Tcp Flags (6 bits)
+     * @brief TCP Flags (6 bits)
      *
      * @type sai_acl_field_data_t sai_uint8_t
      * @flags CREATE_AND_SET
      */
     SAI_ACL_ENTRY_ATTR_FIELD_TCP_FLAGS,
 
     /**
-     * @brief Ip Type (field mask is not needed)
+     * @brief IP Type (field mask is not needed)
      *
      * @type sai_acl_field_data_t sai_acl_ip_type_t
      * @flags CREATE_AND_SET
      */
     SAI_ACL_ENTRY_ATTR_FIELD_ACL_IP_TYPE,
 
     /**
-     * @brief Ip Frag (field mask is not needed)
+     * @brief IP Frag (field mask is not needed)
      *
      * @type sai_acl_field_data_t sai_acl_ip_frag_t
      * @flags CREATE_AND_SET
@@ -1485,7 +1485,7 @@ typedef enum _sai_acl_entry_attr_t
 
     /**
      * @brief Redirect Packet to a destination which can be a port,
-     * lag, nexthop, nexthopgroup
+     * LAG, nexthop, nexthopgroup
      *
      * @type sai_acl_action_data_t sai_object_id_t
      * @flags CREATE_AND_SET

inc/saibridge.h

@@ -70,10 +70,10 @@ typedef enum _sai_bridge_port_fdb_learning_mode_t
  */
 typedef enum _sai_bridge_port_type_t
 {
-    /** Port or Lag */
+    /** Port or LAG */
     SAI_BRIDGE_PORT_TYPE_PORT,
 
-    /** {Port or Lag.vlan} */
+    /** {Port or LAG.vlan} */
     SAI_BRIDGE_PORT_TYPE_SUB_PORT,
 
     /** bridge router port */
@@ -106,7 +106,7 @@ typedef enum _sai_bridge_port_attr_t
     SAI_BRIDGE_PORT_ATTR_TYPE = SAI_BRIDGE_PORT_ATTR_START,
 
     /**
-     * @brief Associated Port or Lag object id
+     * @brief Associated Port or LAG object id
      *
      * @type sai_object_id_t
      * @flags MANDATORY_ON_CREATE | CREATE_ONLY
@@ -177,7 +177,7 @@ typedef enum _sai_bridge_port_attr_t
     SAI_BRIDGE_PORT_ATTR_MAX_LEARNED_ADDRESSES,
 
     /**
-     * @brief Action for packets with unknown source mac address
+     * @brief Action for packets with unknown source MAC address
      * when FDB learning limit is reached.
      *
      * @type sai_packet_action_t

inc/saifdb.h

@@ -58,7 +58,7 @@ typedef struct _sai_fdb_entry_t
      */
     sai_object_id_t switch_id;
 
-    /** Mac address */
+    /** MAC address */
     sai_mac_t mac_address;
 
     /** Bridge type */
@@ -96,7 +96,7 @@ typedef enum _sai_fdb_event_t
 } sai_fdb_event_t;
 
 /**
- * @brief Attribute Id for fdb entry
+ * @brief Attribute Id for FDB entry
  */
 typedef enum _sai_fdb_entry_attr_t
 {
@@ -192,7 +192,7 @@ typedef enum _sai_fdb_flush_entry_type_t
  * then there is no need to specify the #SAI_FDB_FLUSH_ATTR_ENTRY_TYPE attribute.
  * The API uses AND operation when multiple attributes are specified. For
  * exmaple,
- * 1) Flush all entries in fdb table - Do not specify any attribute
+ * 1) Flush all entries in FDB table - Do not specify any attribute
  * 2) Flush all entries by bridge port - Set #SAI_FDB_FLUSH_ATTR_BRIDGE_PORT_ID
  * 3) Flush all entries by VLAN - Set #SAI_FDB_FLUSH_ATTR_VLAN_ID
  * 4) Flush all entries by bridge port and VLAN - Set #SAI_FDB_FLUSH_ATTR_BRIDGE_PORT_ID
@@ -294,7 +294,7 @@ typedef sai_status_t (*sai_remove_fdb_entry_fn)(
         _In_ const sai_fdb_entry_t *fdb_entry);
 
 /**
- * @brief Set fdb entry attribute value
+ * @brief Set FDB entry attribute value
  *
  * @param[in] fdb_entry FDB entry
  * @param[in] attr Attribute
@@ -306,7 +306,7 @@ typedef sai_status_t (*sai_set_fdb_entry_attribute_fn)(
         _In_ const sai_attribute_t *attr);
 
 /**
- * @brief Get fdb entry attribute value
+ * @brief Get FDB entry attribute value
  *
  * @param[in] fdb_entry FDB entry
  * @param[in] attr_count Number of attributes
@@ -337,7 +337,7 @@ typedef sai_status_t (*sai_flush_fdb_entries_fn)(
  * @brief FDB notifications
  *
  * @param[in] count Number of notifications
- * @param[in] data Pointer to fdb event notification data array
+ * @param[in] data Pointer to FDB event notification data array
  */
 typedef void (*sai_fdb_event_notification_fn)(
         _In_ uint32_t count,

inc/saihostif.h

@@ -66,7 +66,7 @@ typedef enum _sai_hostif_trap_group_attr_t
     SAI_HOSTIF_TRAP_GROUP_ATTR_ADMIN_STATE = SAI_HOSTIF_TRAP_GROUP_ATTR_START,
 
     /**
-     * @brief Cpu egress queue
+     * @brief CPU egress queue
      *
      * @type sai_uint32_t
      * @flags CREATE_AND_SET
@@ -75,7 +75,7 @@ typedef enum _sai_hostif_trap_group_attr_t
     SAI_HOSTIF_TRAP_GROUP_ATTR_QUEUE,
 
     /**
-     * @brief Sai policer object id
+     * @brief SAI policer object id
      *
      * @type sai_object_id_t
      * @flags CREATE_AND_SET
@@ -263,25 +263,25 @@ typedef enum _sai_hostif_trap_type_t
     SAI_HOSTIF_TRAP_TYPE_IP2ME = 0x00004000,
 
     /**
-     * @brief SSH traffic (tcp dst port == 22) to local router IP address
+     * @brief SSH traffic (TCP dst port == 22) to local router IP address
      * (default packet action is drop)
      */
     SAI_HOSTIF_TRAP_TYPE_SSH = 0x00004001,
 
     /**
-     * @brief SNMP traffic (udp dst port == 161) to local router IP address
+     * @brief SNMP traffic (UDP dst port == 161) to local router IP address
      * (default packet action is drop)
      */
     SAI_HOSTIF_TRAP_TYPE_SNMP = 0x00004002,
 
     /**
-     * @brief BGP traffic (tcp src port == 179 or tcp dst port == 179) to local
+     * @brief BGP traffic (TCP src port == 179 or TCP dst port == 179) to local
      * router IP address (default packet action is drop)
      */
     SAI_HOSTIF_TRAP_TYPE_BGP = 0x00004003,
 
     /**
-     * @brief BGPv6 traffic (tcp src port == 179 or tcp dst port == 179) to
+     * @brief BGPv6 traffic (TCP src port == 179 or TCP dst port == 179) to
      * local router IP address (default packet action is drop)
      */
     SAI_HOSTIF_TRAP_TYPE_BGPV6 = 0x00004004,
@@ -456,7 +456,7 @@ typedef enum _sai_hostif_user_defined_trap_type_t
     /** ACL traps (default packet action is drop) */
     SAI_HOSTIF_USER_DEFINED_TRAP_TYPE_ACL,
 
-    /** fdb traps (default packet action is drop) */
+    /** FDB traps (default packet action is drop) */
     SAI_HOSTIF_USER_DEFINED_TRAP_TYPE_FDB,
 
     /** Custom range base */
@@ -785,7 +785,7 @@ typedef enum _sai_hostif_table_entry_attr_t
      * Valid only when #SAI_HOSTIF_TABLE_ENTRY_ATTR_TYPE == #SAI_HOSTIF_TABLE_ENTRY_TYPE_PORT
      * || #SAI_HOSTIF_TABLE_ENTRY_TYPE_LAG || #SAI_HOSTIF_TABLE_ENTRY_TYPE_VLAN
      * should be port object when type is SAI_HOSTIF_TABLE_ENTRY_TYPE_PORT
-     * should be lag object when type is SAI_HOSTIF_TABLE_ENTRY_TYPE_LAG
+     * should be LAG object when type is SAI_HOSTIF_TABLE_ENTRY_TYPE_LAG
      * should be VLAN ID object when type is SAI_HOSTIF_TABLE_ENTRY_TYPE_VLAN
      *
      * @type sai_object_id_t

inc/sail2mc.h

@@ -82,7 +82,7 @@ typedef struct _sai_l2mc_entry_t
 } sai_l2mc_entry_t;
 
 /**
- * @brief Attribute Id for l2mc entry
+ * @brief Attribute Id for L2MC entry
  */
 typedef enum _sai_l2mc_entry_attr_t
 {
@@ -152,7 +152,7 @@ typedef sai_status_t (*sai_remove_l2mc_entry_fn)(
         _In_ const sai_l2mc_entry_t *l2mc_entry);
 
 /**
- * @brief Set l2mc entry attribute value
+ * @brief Set L2MC entry attribute value
  *
  * @param[in] l2mc_entry L2MC entry
  * @param[in] attr Attribute
@@ -164,7 +164,7 @@ typedef sai_status_t (*sai_set_l2mc_entry_attribute_fn)(
         _In_ const sai_attribute_t *attr);
 
 /**
- * @brief Get l2mc entry attribute value
+ * @brief Get L2MC entry attribute value
  *
  * @param[in] l2mc_entry L2MC entry
  * @param[in] attr_count Number of attributes