From 277f311871a814ca89dc4de3f4214055788e4ebb Mon Sep 17 00:00:00 2001 From: Jeff Johnson Date: Sat, 14 Jan 2023 22:30:18 -0800 Subject: [PATCH] qcacmn: Fix umac/wifi_radar documentation The kernel-doc script identified some documentation errors in the umac/wifi_radar folder, so fix them. Change-Id: If8dd597ab3fae871986110d22c326cef67655cb3 CRs-Fixed: 3380570 --- umac/wifi_radar/core/inc/wifi_radar_defs_i.h | 42 +++++++++---------- .../inc/wlan_wifi_radar_utils_api.h | 26 ++++++------ 2 files changed, 34 insertions(+), 34 deletions(-) diff --git a/umac/wifi_radar/core/inc/wifi_radar_defs_i.h b/umac/wifi_radar/core/inc/wifi_radar_defs_i.h index d51a270a62..95e5b2adf0 100644 --- a/umac/wifi_radar/core/inc/wifi_radar_defs_i.h +++ b/umac/wifi_radar/core/inc/wifi_radar_defs_i.h @@ -1,10 +1,10 @@ /* - * 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 * copyright notice and this permission notice appear in all copies. - + * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR @@ -32,8 +32,8 @@ /** * wlan_wifi_radar_psoc_obj_create_handler() - * psoc object create handler for WiFi Radar - * @psoc - pointer to psoc object - * @args - void pointer in case it needs arguments + * @psoc: pointer to psoc object + * @arg: void pointer in case it needs arguments * * Return: status of object creation */ @@ -44,8 +44,8 @@ struct wlan_objmgr_psoc *psoc, void *arg); /** * wlan_wifi_radar_psoc_obj_destroy_handler() - * psoc object destroy handler for WiFi Radar - * @psoc - pointer to psoc object - * @args - void pointer in case it needs arguments + * @psoc: pointer to psoc object + * @arg: void pointer in case it needs arguments * * Return: status of destroy object */ @@ -56,8 +56,8 @@ struct wlan_objmgr_psoc *psoc, void *arg); /** * wlan_wifi_radar_pdev_obj_create_handler() - * pdev object create handler for WiFi Radar - * @pdev - pointer to pdev object - * @args - void pointer in case it needs arguments + * @pdev: pointer to pdev object + * @arg: void pointer in case it needs arguments * * Return: status of object creation */ @@ -68,8 +68,8 @@ struct wlan_objmgr_pdev *pdev, void *arg); /** * wlan_wifi_radar_pdev_obj_destroy_handler() - * pdev object destroy handler for WiFi Radar - * @pdev - pointer to pdev object - * @args - void pointer in case it needs arguments + * @pdev: pointer to pdev object + * @arg: void pointer in case it needs arguments * * Return: status of destroy object */ @@ -80,8 +80,8 @@ struct wlan_objmgr_pdev *pdev, void *arg); /** * wlan_wifi_radar_peer_obj_create_handler() - * peer object create handler for WiFi Radar - * @peer - pointer to peer object - * @args - void pointer in case it needs arguments + * @peer: pointer to peer object + * @arg: void pointer in case it needs arguments * * Return: status of object creation */ @@ -92,8 +92,8 @@ struct wlan_objmgr_peer *peer, void *arg); /** * wlan_wifi_radar_peer_obj_destroy_handler() - * peer object destroy handler for WiFi radar - * @peer - pointer to peer object - * @args - void pointer in case it needs arguments + * @peer: pointer to peer object + * @arg: void pointer in case it needs arguments * * Return: status ofi destroy object */ @@ -103,7 +103,7 @@ struct wlan_objmgr_peer *peer, void *arg); /** * wifi_radar_streamfs_init() - stream filesystem init - * @pdev - pointer to pdev object + * @pdev: pointer to pdev object * * Return: status of fs init */ @@ -112,7 +112,7 @@ wifi_radar_streamfs_init(struct wlan_objmgr_pdev *pdev); /** * wifi_radar_streamfs_remove() - stream filesystem remove - * @pdev - pointer to pdev object + * @pdev: pointer to pdev object * * Return: status of fs remove */ @@ -121,9 +121,9 @@ wifi_radar_streamfs_remove(struct wlan_objmgr_pdev *pdev); /** * wifi_radar_streamfs_write() - write to stream filesystem - * @pa - pointer to pdev_cfr object - * @write_data - Pointer to data - * @write_len - data len + * @pa: pointer to pdev_cfr object + * @write_data: Pointer to data + * @write_len: data len * * Return: status of fs write */ @@ -134,7 +134,7 @@ size_t write_len); /** * wifi_radar_streamfs_flush() - flush the write to streamfs - * @pa - pointer to pdev_cfr object + * @pa: pointer to pdev_cfr object * * Return: status of fs flush */ diff --git a/umac/wifi_radar/dispatcher/inc/wlan_wifi_radar_utils_api.h b/umac/wifi_radar/dispatcher/inc/wlan_wifi_radar_utils_api.h index e94f7b3afa..1f0e555025 100644 --- a/umac/wifi_radar/dispatcher/inc/wlan_wifi_radar_utils_api.h +++ b/umac/wifi_radar/dispatcher/inc/wlan_wifi_radar_utils_api.h @@ -1,10 +1,10 @@ /* - * Copyright (c) 2021, 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 * copyright notice and this permission notice appear in all copies. - + * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR @@ -37,8 +37,8 @@ /** * struct psoc_wifi_radar - private psoc object for WiFi Radar - * psoc_obj: pointer to psoc object - * is_wifi_radar_capable: flag to determine if wifi radar is enabled or not + * @psoc_obj: pointer to psoc object + * @is_wifi_radar_capable: flag to determine if wifi radar is enabled or not */ struct psoc_wifi_radar { struct wlan_objmgr_psoc *psoc_obj; @@ -47,12 +47,12 @@ struct psoc_wifi_radar { /** * struct pdev_wifi_radar - private pdev object for WiFi Radar - * pdev_obj: pointer to pdev object - * is_wifi_radar_capable: flag to determine if wifi radar is enabled or not - * chan_ptr: Channel in relayfs - * dir_ptr: Parent directory of relayfs file - * num_subbufs: No. of sub-buffers used in relayfs - * subbuf_size: Size of sub-buffer used in relayfs + * @pdev_obj: pointer to pdev object + * @is_wifi_radar_capable: flag to determine if wifi radar is enabled or not + * @chan_ptr: Channel in relayfs + * @dir_ptr: Parent directory of relayfs file + * @num_subbufs: No. of sub-buffers used in relayfs + * @subbuf_size: Size of sub-buffer used in relayfs */ struct pdev_wifi_radar { struct wlan_objmgr_pdev *pdev_obj; @@ -65,7 +65,7 @@ struct pdev_wifi_radar { /** * struct peer_wifi_radar - private peer object for WiFi Radar - * peer_obj: pointer to peer_obj + * @peer_obj: pointer to peer_obj */ struct peer_wifi_radar { struct wlan_objmgr_peer *peer_obj; @@ -120,7 +120,7 @@ QDF_STATUS wifi_radar_deinitialize_pdev(struct wlan_objmgr_pdev *pdev); /** * wlan_wifi_radar_is_feature_disabled() - Check if wifi radarfeature * is disabled - * @pdev - the physical device object. + * @pdev: the physical device object. * * Return : true if wifi radar is disabled, else false. */