Browse Source

qcacmn: Fix umac/cmn_services/interface_mgr documentation

The kernel-doc script identified some documentation issues in the
umac/cmn_services/interface_mgr folder, so fix them.

Change-Id: I699fd75a0827324872da4ca6a3be13a5ebcfda37
CRs-Fixed: 3390584
Jeff Johnson 2 years ago
parent
commit
4113a5f404

+ 5 - 3
umac/cmn_services/interface_mgr/inc/wlan_if_mgr_main.h

@@ -1,5 +1,6 @@
 /*
  * Copyright (c) 2020, The Linux Foundation. All rights reserved.
+ * Copyright (c) 2023 Qualcomm Innovation Center, Inc. All rights reserved.
  *
  * Permission to use, copy, modify, and/or distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above
@@ -14,7 +15,7 @@
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  */
 
-/*
+/**
  * DOC: contains Interface MGR init/deinit public api
  */
 
@@ -68,7 +69,7 @@
 #define ifmgr_hex_dump(level, data, buf_len) \
 		qdf_trace_hex_dump(QDF_MODULE_ID_IFMGR, level, data, buf_len)
 
-/*
+/**
  * wlan_if_mgr_init() - Interface manager module initialization API
  *
  * Return: QDF_STATUS
@@ -91,8 +92,9 @@ QDF_STATUS wlan_if_mgr_deinit(void);
  */
 QDF_STATUS wlan_if_mgr_psoc_created_notification(struct wlan_objmgr_psoc *psoc,
 						 void *arg_list);
+
 /**
- * wlan_scan_psoc_deleted_notification() - scan psoc delete handler
+ * wlan_if_mgr_psoc_destroyed_notification() - scan psoc delete handler
  * @psoc: psoc object
  * @arg_list: Argument list
  *

+ 12 - 11
umac/cmn_services/interface_mgr/inc/wlan_if_mgr_public_struct.h

@@ -1,6 +1,6 @@
 /*
  * Copyright (c) 2020-2021, The Linux Foundation. All rights reserved.
- * Copyright (c) 2021-2022 Qualcomm Innovation Center, Inc. All rights reserved.
+ * Copyright (c) 2021-2023 Qualcomm Innovation Center, Inc. All rights reserved.
  *
  * Permission to use, copy, modify, and/or distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above
@@ -15,7 +15,7 @@
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  */
 
-/*
+/**
  * DOC: contains interface manager structure definitions
  */
 #ifndef __IF_MGR_PUBLIC_STRUCTS_H
@@ -40,15 +40,16 @@
  * @WLAN_IF_MGR_EV_AP_START_BSS_COMPLETE:Event to handle start bss complete
  * @WLAN_IF_MGR_EV_AP_STOP_BSS:Event to handle stop bss request
  * @WLAN_IF_MGR_EV_AP_STOP_BSS_COMPLETE:Event to stop bss complete
- * WLAN_IF_MGR_EV_AP_START_ACS: Event to handle ACS start
- * WLAN_IF_MGR_EV_AP_STOP_ACS: Event to handle ACS stop
- * WLAN_IF_MGR_EV_AP_DONE_ACS: Event to handle ACS completion
- * WLAN_IF_MGR_EV_AP_CANCEL_ACS: Event to handle ACS cancel
- * WLAN_IF_MGR_EV_AP_START_HT40: Event to handle HT40 scan start
- * WLAN_IF_MGR_EV_AP_STOP_HT40: Event to handle HT40 scan stop
- * WLAN_IF_MGR_EV_AP_DONE_HT40: Event to handle HT40 scan completion
- * WLAN_IF_MGR_EV_AP_CANCEL_HT40: Event to handle HT40 scan cancel
- * WLAN_IF_MGR_EV_CSA_COMPLETE: Event to handle csa complete
+ * @WLAN_IF_MGR_EV_AP_START_ACS: Event to handle ACS start
+ * @WLAN_IF_MGR_EV_AP_STOP_ACS: Event to handle ACS stop
+ * @WLAN_IF_MGR_EV_AP_DONE_ACS: Event to handle ACS completion
+ * @WLAN_IF_MGR_EV_AP_CANCEL_ACS: Event to handle ACS cancel
+ * @WLAN_IF_MGR_EV_AP_START_HT40: Event to handle HT40 scan start
+ * @WLAN_IF_MGR_EV_AP_STOP_HT40: Event to handle HT40 scan stop
+ * @WLAN_IF_MGR_EV_AP_DONE_HT40: Event to handle HT40 scan completion
+ * @WLAN_IF_MGR_EV_AP_CANCEL_HT40: Event to handle HT40 scan cancel
+ * @WLAN_IF_MGR_EV_CSA_COMPLETE: Event to handle csa complete
+ * @WLAN_IF_MGR_EV_MAX: Max event
  */
 enum wlan_if_mgr_evt {
 	WLAN_IF_MGR_EV_CONNECT_START = 0,