Forráskód Böngészése

qcacld-3.0: Fix wlan_mlme_public_struct.h documentation

wlan_mlme_public_struct.h has some documentation that is not being
processed by kernel-doc since it isn't using the kernel-doc comment
indicator "/**". Fix those comments, and also fix the documentation
syntax errors now reported by kernel-doc.

Change-Id: I407b5abefe8313071e5e99d52d69f181880c431d
CRs-Fixed: 3424372
Jeff Johnson 2 éve
szülő
commit
59a541e018
1 módosított fájl, 28 hozzáadás és 28 törlés
  1. 28 28
      components/mlme/dispatcher/inc/wlan_mlme_public_struct.h

+ 28 - 28
components/mlme/dispatcher/inc/wlan_mlme_public_struct.h

@@ -675,18 +675,18 @@ struct wlan_mlme_ht_caps {
 };
 
 #define MLME_CFG_WPS_UUID_MAX_LEN    16
-/*
+/**
  * struct wlan_mlme_wps_params - All wps based related cfg items
  *
- * @enable_wps - to enable wps
- * @wps_state - current wps state
- * @wps_version - wps version
- * @wps_cfg_method - wps config method
- * @wps_primary_device_category - wps primary device category
- * @wps_primary_device_oui - primary device OUI
- * @wps_device_sub_category - device sub category
- * @wps_device_password_id - password id of device
- * @wps_uuid - wps uuid to be sent in probe
+ * @enable_wps: to enable wps
+ * @wps_state: current wps state
+ * @wps_version: wps version
+ * @wps_cfg_method: wps config method
+ * @wps_primary_device_category: wps primary device category
+ * @wps_primary_device_oui: primary device OUI
+ * @wps_device_sub_category: device sub category
+ * @wps_device_password_id: password id of device
+ * @wps_uuid: wps uuid to be sent in probe
  */
 struct wlan_mlme_wps_params {
 	uint8_t enable_wps;
@@ -1214,8 +1214,8 @@ struct wlan_mlme_feature_flag {
 	uint32_t channel_bonding_mode_5ghz;
 };
 
-/*
- * struct wlan_mlme_sap_protection_cfg - SAP erp protection config items
+/**
+ * struct wlan_mlme_sap_protection - SAP erp protection config items
  * @ignore_peer_ht_opmode:     Ignore the ht opmode of the peer. Dynamic via INI
  * @enable_ap_obss_protection: enable/disable AP OBSS protection
  * @protection_force_policy:   Protection force policy. Static via cfg
@@ -1232,7 +1232,7 @@ struct wlan_mlme_sap_protection {
 	uint32_t protection_enabled;
 };
 
-/*
+/**
  * struct wlan_mlme_chainmask - All chainmask related cfg items
  * @txchainmask1x1:     To set transmit chainmask
  * @rxchainmask1x1:     To set rx chainmask
@@ -1462,7 +1462,7 @@ struct wlan_mlme_generic {
 #endif
 };
 
-/*
+/**
  * struct wlan_mlme_product_details_cfg - product details config items
  * @manufacturer_name: manufacture name
  * @model_number: model number
@@ -1478,7 +1478,7 @@ struct wlan_mlme_product_details_cfg {
 	char manufacture_product_version[WLAN_CFG_MFR_PRODUCT_VERSION_LEN + 1];
 };
 
-/*
+/**
  * struct acs_weight - Normalize ACS weight for mentioned channels
  * @chan_freq: frequency of the channel
  * @normalize_weight: Normalization factor of the frequency
@@ -1488,7 +1488,7 @@ struct acs_weight {
 	uint8_t normalize_weight;
 };
 
-/*
+/**
  * struct acs_weight_range - Normalize ACS weight for mentioned channel range
  * @start_freq: frequency of the start channel
  * @end_freq: frequency of the end channel
@@ -1503,13 +1503,13 @@ struct acs_weight_range {
 #define MAX_ACS_WEIGHT_RANGE              10
 #define MLME_GET_DFS_CHAN_WEIGHT(np_chan_weight) (np_chan_weight & 0x000000FF)
 
-/*
+/**
  * struct wlan_mlme_acs - All acs related cfg items
- * @is_acs_with_more_param - to enable acs with more param
- * @auto_channel_select_weight - to set acs channel weight
- * @is_vendor_acs_support - enable application based channel selection
- * @is_acs_support_for_dfs_ltecoex - enable channel for dfs and lte coex
- * @is_external_acs_policy - control external policy
+ * @is_acs_with_more_param: to enable acs with more param
+ * @auto_channel_select_weight: to set acs channel weight
+ * @is_vendor_acs_support: enable application based channel selection
+ * @is_acs_support_for_dfs_ltecoex: enable channel for dfs and lte coex
+ * @is_external_acs_policy: control external policy
  * @normalize_weight_chan: Weight factor to be considered in ACS
  * @normalize_weight_num_chan: Number of freq items for normalization.
  * @normalize_weight_range: Frequency range for weight normalization
@@ -1534,7 +1534,7 @@ struct wlan_mlme_acs {
 	uint32_t np_chan_weightage;
 };
 
-/*
+/**
  * struct wlan_mlme_cfg_twt - All twt related cfg items
  * @is_twt_enabled: global twt configuration
  * @is_bcast_responder_enabled: bcast responder enable/disable
@@ -2305,7 +2305,7 @@ struct wlan_mlme_rssi_cfg_score  {
 	uint32_t rssi_pref_5g_rssi_thresh;
 };
 
-/*
+/**
  * struct wlan_mlme_roam_scoring_cfg - MLME roam related scoring config
  * @enable_scoring_for_roam: Enable/disable BSS Scoring for Roaming
  * @roam_trigger_bitmap: bitmap for various roam triggers
@@ -2364,7 +2364,7 @@ struct mlme_power_usage {
 	char data[CFG_POWER_USAGE_MAX_LEN];
 };
 
-/*
+/**
  * struct wlan_mlme_power - power related config items
  * @max_tx_power_24: max power Tx for 2.4 ghz, this is based on frequencies
  * @max_tx_power_5: max power Tx for 5 ghz, this is based on frequencies
@@ -2400,7 +2400,7 @@ struct wlan_mlme_power {
 	bool skip_tpe;
 };
 
-/*
+/**
  * struct wlan_mlme_timeout - mlme timeout related config items
  * @join_failure_timeout: join failure timeout (can be changed in connect req)
  * @probe_req_retry_timeout: Probe req retry timeout during join time
@@ -2499,7 +2499,7 @@ struct wlan_mlme_wifi_pos_cfg {
 #define BTM_OFFLOAD_CONFIG_BIT_8    8
 #define BTM_OFFLOAD_CONFIG_BIT_7    7
 
-/*
+/**
  * struct wlan_mlme_btm - BTM related configs
  * @prefer_btm_query: flag to prefer btm query over 11k
  * @abridge_flag: set this flag to enable firmware to sort candidates based on
@@ -2564,7 +2564,7 @@ struct wlan_mlme_fe_rrm {
 };
 
 #ifdef MWS_COEX
-/*
+/**
  * struct wlan_mlme_mwc - MWC related configs
  * @mws_coex_4g_quick_tdm:  bitmap to set mws-coex 5g-nr power limit
  * @mws_coex_5g_nr_pwr_limit: bitmap to set mws-coex 5g-nr power limit