qcacmn: Fix dp/inc documentation

The kernel-doc script identified a large number of kernel-doc issues
in the dp/inc folder, so fix them.

Change-Id: I6213164d2209cc4de9684ae66281ee2999f82672
CRs-Fixed: 3375078
This commit is contained in:
Jeff Johnson
2023-01-06 15:47:47 -08:00
committed by Madan Koyyalamudi
parent 3c4a739d9c
commit d18654812f
30 changed files with 1294 additions and 1042 deletions

View File

@@ -1,5 +1,6 @@
/*
* Copyright (c) 2016-2017, 2019, 2021 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
@@ -17,8 +18,8 @@
*/
/**
* @file cdp_txrx_raw.h
* @brief Define the host data path raw mode API functions
* DOC: cdp_txrx_raw.h
* Define the host data path raw mode API functions
* called by the host control SW and the OS interface module
*/
#ifndef _CDP_TXRX_RAW_H_
@@ -29,16 +30,16 @@
#include <cdp_txrx_cmn.h>
/**
* @brief finds the ast entry for the packet
* @details: Finds the ast entry i.e 4th address for the packet based on the
* details in the netbuf.
* cdp_rawsim_get_astentry() - finds the ast entry for the packet
* @soc: soc handle
* @vdev_id: id of the data virtual device object
* @pnbuf: pointer to nbuf
* @raw_ast: pointer to fill ast information
*
* @param soc - soc handle
* @param vdev_id - id of the data virtual device object
* @param pnbuf - pointer to nbuf
* @param raw_ast - pointer to fill ast information
* Finds the ast entry i.e 4th address for the packet based on the
* details in the netbuf.
*
* @return - 0 on success, -1 on error, 1 if more nbufs need to be consumed.
* Return: 0 on success, -1 on error, 1 if more nbufs need to be consumed.
*/
static inline QDF_STATUS