Przeglądaj źródła

qcacld-3.0: Fix Spatial Reuse Documentation

The kernel-doc script identified a few documentation issues in
components/spatial_reuse, so fix them.

Change-Id: Ie4238aa43d8263151c2f9d05ebbe74ae8854f472
CRs-Fixed: 3361723
Jeff Johnson 2 lat temu
rodzic
commit
5e59e167e5

+ 3 - 3
components/spatial_reuse/dispatcher/inc/spatial_reuse_api.h

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2022 Qualcomm Innovation Center, Inc. All rights reserved.
+ * Copyright (c) 2022-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 @@
  */
 
 /**
- * DOC : contains interface prototypes for spatial_reuse api
+ * DOC: contains interface prototypes for spatial_reuse api
  */
 
 #ifndef _SPATIAL_REUSE_API_H_
@@ -51,7 +51,7 @@ enum sr_osif_reason_code {
 };
 
 /**
- * sr_osif_event_cb() - CB to deliver SR events
+ * typedef sr_osif_event_cb() - CB to deliver SR events
  * @vdev: objmgr manager vdev
  * @sr_osif_oper: SR Operation like suspend / resume
  * @sr_osif_rc: Event reason code

+ 3 - 4
components/spatial_reuse/dispatcher/inc/spatial_reuse_ucfg_api.h

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2022 Qualcomm Innovation Center, Inc. All rights reserved.
+ * Copyright (c) 2022-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 @@
  */
 
 /**
- * DOC : contains interface prototypes for OS_IF layer
+ * DOC: contains interface prototypes for OS_IF layer
  */
 #ifndef _SPATIAL_REUSE_UCFG_API_H_
 #define _SPATIAL_REUSE_UCFG_API_H_
@@ -50,12 +50,11 @@ void ucfg_spatial_reuse_get_sr_config(struct wlan_objmgr_vdev *vdev,
 				      uint8_t *non_srg_max_pd_offset,
 				      bool *he_spr_enabled);
 /**
- * ucfg_spatial_reuse_get_sr_config() - Spatial reuse config set
+ * ucfg_spatial_reuse_set_sr_config() - Spatial reuse config set
  *
  * @vdev: object manager vdev
  * @sr_ctrl: spatial reuse sr control
  * @non_srg_max_pd_offset: non-srg max pd offset
- * @he_spr_enabled: Spatial reuse enabled
  *
  * Return: void
  */

+ 2 - 2
components/spatial_reuse/dispatcher/src/spatial_reuse_api.c

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2022 Qualcomm Innovation Center, Inc. All rights reserved.
+ * Copyright (c) 2022-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 @@
  */
 
 /**
- * DOC : contains interface prototypes for spatial_reuse api
+ * DOC: contains interface prototypes for spatial_reuse api
  */
 #include <spatial_reuse_api.h>
 #include <target_if_spatial_reuse.h>

+ 2 - 2
components/spatial_reuse/dispatcher/src/spatial_reuse_ucfg_api.c

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2022 Qualcomm Innovation Center, Inc. All rights reserved.
+ * Copyright (c) 2022-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 @@
  */
 
 /**
- * DOC : contains interface prototypes for OS_IF layer
+ * DOC: contains interface prototypes for OS_IF layer
  */
 #include <qdf_trace.h>
 #include <spatial_reuse_ucfg_api.h>