gpu: nvgpu: Remove redundant retval documentation

The @retval doxygen comments are sufficient to describe
all the possible return values. Remove the redundant
information present under @return doxygen comment.

JIRA PLCF-1312

Change-Id: If0c891d122a85117f75e7428b504ef4b26991aa3
Signed-off-by: Tejal Kudav <tkudav@nvidia.com>
Reviewed-on: https://git-master.nvidia.com/r/c/linux-nvgpu/+/2591494
(cherry picked from commit 956a77c271a6333287a9ebd53881a0a566e621ed)
Reviewed-on: https://git-master.nvidia.com/r/c/linux-nvgpu/+/2600877
Reviewed-by: svcacv <svcacv@nvidia.com>
Reviewed-by: Vaibhav Kachore <vkachore@nvidia.com>
Reviewed-by: mobile promotions <svcmobile_promotions@nvidia.com>
GVS: Gerrit_Virtual_Submit
Tested-by: mobile promotions <svcmobile_promotions@nvidia.com>
This commit is contained in:
Tejal Kudav
2021-09-08 16:28:08 +00:00
committed by mobile promotions
parent 79f83f4993
commit fbb2750c75

View File

@@ -133,7 +133,6 @@ struct nvgpu_cpu_time_correlation_sample {
* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* - Return 0 to indicate success
*
* @return 0 in case of success, < 0 in case of failure.
* @retval -EINVAL in case invalid \a timeout value is passed.
* @retval -EINVAL in case NULL pointer is passed for \a scaled_timeout.
* @retval -EINVAL in case \ref gk20a.ptimer_src_freq "g->ptimer_src_freq" is 0.