From c357c47be8a3f210f9eee9a05cc13f1051b036d3 Mon Sep 17 00:00:00 2001 From: Alex Gilday Date: Wed, 21 Mar 2018 13:54:09 +0000 Subject: COMPMID-1008: Fix Doxygen issues Change-Id: Ie73d8771f85d1f5b059f3a56f1bbd73c98e94a38 Reviewed-on: https://eu-gerrit-1.euhpc.arm.com/124723 Reviewed-by: Michalis Spyrou Tested-by: Jenkins --- arm_compute/runtime/TensorAllocator.h | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) (limited to 'arm_compute/runtime/TensorAllocator.h') diff --git a/arm_compute/runtime/TensorAllocator.h b/arm_compute/runtime/TensorAllocator.h index 9af100c129..2ad37d0576 100644 --- a/arm_compute/runtime/TensorAllocator.h +++ b/arm_compute/runtime/TensorAllocator.h @@ -1,5 +1,5 @@ /* - * Copyright (c) 2016, 2017 ARM Limited. + * Copyright (c) 2016-2018 ARM Limited. * * SPDX-License-Identifier: MIT * @@ -44,13 +44,16 @@ using MemoryGroup = MemoryGroupBase; class TensorAllocator : public ITensorAllocator { public: - /** Default constructor. */ + /** Default constructor. + * + * @param[in] owner Owner of the tensor allocator. + */ TensorAllocator(Tensor *owner = nullptr); /** Default destructor */ ~TensorAllocator(); - /** Prevent instances of this class from being copied (As this class contains pointers). */ + /** Prevent instances of this class from being copied (As this class contains pointers) */ TensorAllocator(const TensorAllocator &) = delete; - /** Prevent instances of this class from being copy assigned (As this class contains pointers). */ + /** Prevent instances of this class from being copy assigned (As this class contains pointers) */ TensorAllocator &operator=(const TensorAllocator &) = delete; /** Allow instances of this class to be moved */ TensorAllocator(TensorAllocator &&) noexcept; @@ -71,7 +74,10 @@ public: */ void init(const TensorAllocator &allocator, const Coordinates &coords, TensorInfo sub_info); - /** Returns the pointer to the allocated data. */ + /** Returns the pointer to the allocated data. + * + * @return a pointer to the allocated data. + */ uint8_t *data() const; /** Allocate size specified by TensorInfo of CPU memory. -- cgit v1.2.1