qcacmn: Fix QDF documentation

The kernel-doc script identified a large number of documentation
issues in the QDF. A series of patches has already fixed many of the
issues, so fix most of the remaining ones.

Note that the QDF IPA abstraction still has issues, but it is under
rework, so not trying to clean it up until after the rework is
complete.

Change-Id: I10c33e341cb6b46e0f8ada99069616d450c07189
CRs-Fixed: 3406197
This commit is contained in:
Jeff Johnson
2023-02-13 20:15:22 -08:00
committed by Madan Koyyalamudi
parent de1279ed3f
commit 4042de592d
33 changed files with 287 additions and 250 deletions

View File

@@ -1,6 +1,6 @@
/*
* Copyright (c) 2014-2021 The Linux Foundation. All rights reserved.
* 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
@@ -31,10 +31,13 @@
#include <qdf_status.h>
#include <qdf_trace.h>
/**
* typedef __qdf_workqueue_t - qdf_workqueue_t abstraction
*/
typedef struct workqueue_struct __qdf_workqueue_t;
/**
* typedef struct __qdf_work_t - wrapper around the real task func
* typedef __qdf_work_t - wrapper around the real task func
* @work: Instance of work
* @fn: function pointer to the handler
* @arg: pointer to argument
@@ -46,7 +49,7 @@ typedef struct {
} __qdf_work_t;
/**
* typedef struct __qdf_bh_t - wrapper around the real task func
* typedef __qdf_bh_t - wrapper around the real task func
* @bh: Instance of the bottom half
* @fn: function pointer to the handler
* @arg: pointer to argument