Browse Source

qcacmn: Fix inc/wlan_ipa_core.h documentation

Fix documentation issues in inc/wlan_ipa_core.h
identified by kernel-doc script.

Change-Id: Ibd4867f8553326078d08f2fde9469ee74a1ec963
CRs-Fixed: 3424480
Namita Nair 2 years ago
parent
commit
f27ac75cff
1 changed files with 11 additions and 14 deletions
  1. 11 14
      ipa/core/inc/wlan_ipa_core.h

+ 11 - 14
ipa/core/inc/wlan_ipa_core.h

@@ -875,8 +875,8 @@ void wlan_ipa_flush_pending_vdev_events(struct wlan_ipa_priv *ipa_ctx,
 #ifdef IPA_OPT_WIFI_DP
 /**
  * wlan_ipa_wdi_opt_dpath_flt_rsrv_cb() - reserve cce super rules for Rx filter
- * @ipa_ctx - ipa_context
- * out_params - filter reservation params
+ * @ipa_ctx: ipa_context
+ * @out_params: filter reservation params
  *
  * Return:int 0 on success, negative on failure
  *
@@ -888,17 +888,16 @@ int wlan_ipa_wdi_opt_dpath_flt_rsrv_cb(
 /**
  * wlan_ipa_wdi_opt_dpath_notify_flt_rsvd() - notify filter reservation
  * response to IPA
+ * @is_success: result of filter reservation
  *
- * @is_success : result of filter reservation
- *
- * @Return 0 on success, negative on failure
+ * Return 0 on success, negative on failure
  */
 int wlan_ipa_wdi_opt_dpath_notify_flt_rsvd(bool is_success);
 
 /**
  * wlan_ipa_wdi_opt_dpath_flt_add_cb - Add rx filter tuple to cce filter
  * @ipa_ctx: IPA context
- * in_out - filter tuple info
+ * @in_out: filter tuple info
  *
  * Return: 0 on success, negative on failure
  */
@@ -909,7 +908,7 @@ int wlan_ipa_wdi_opt_dpath_flt_add_cb(
 /**
  * wlan_ipa_wdi_opt_dpath_flt_rem_cb() - Remove rx filter tuple from cce filter
  * @ipa_ctx: IPA context
- * in - filter tuple info
+ * @in: filter tuple info
  *
  * Return: 0 on success, negative on failure
  */
@@ -920,9 +919,8 @@ int wlan_ipa_wdi_opt_dpath_flt_rem_cb(
 /**
  * wlan_ipa_wdi_opt_dpath_notify_flt_add_rem_cb() - notify filter add/remove
  * result to IPA
- *
- * @result0 : result of add/remove filter0
- * @result1 : result of add/remove filter1
+ * @result0: result of add/remove filter0
+ * @result1: result of add/remove filter1
  *
  * Return: void
  */
@@ -940,11 +938,10 @@ int wlan_ipa_wdi_opt_dpath_flt_rsrv_rel_cb(void *ipa_ctx);
 /**
  * wlan_ipa_wdi_opt_dpath_notify_flt_rlsd() - notify filter release
  * response to IPA
+ * @result0: result of filter0 release
+ * @result1: result of filter1 release
  *
- * @result0 : result of filter0 release
- * @result1 : result of filter1 release
- *
- * @Return: 0 on success, negative on failure
+ * Return: 0 on success, negative on failure
  */
 int wlan_ipa_wdi_opt_dpath_notify_flt_rlsd(int result0, int result1);