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/graph/INode.h | 2 ++ arm_compute/graph/IOperation.h | 4 +++- arm_compute/graph/ITensorObject.h | 8 ++++++-- 3 files changed, 11 insertions(+), 3 deletions(-) (limited to 'arm_compute/graph') diff --git a/arm_compute/graph/INode.h b/arm_compute/graph/INode.h index 1969423074..be4575de91 100644 --- a/arm_compute/graph/INode.h +++ b/arm_compute/graph/INode.h @@ -46,6 +46,8 @@ public: * @param[in] ctx Graph context to be used * @param[in] input Input tensor of the node * @param[in] output Output tensor of the node + * + * @return a pointer to the function which implements the node. */ virtual std::unique_ptr instantiate_node(GraphContext &ctx, ITensorObject *input, ITensorObject *output) = 0; /** Override the existing target hint diff --git a/arm_compute/graph/IOperation.h b/arm_compute/graph/IOperation.h index a9fa4f83c7..b1afb21db7 100644 --- a/arm_compute/graph/IOperation.h +++ b/arm_compute/graph/IOperation.h @@ -1,5 +1,5 @@ /* - * Copyright (c) 2017 ARM Limited. + * Copyright (c) 2017-2018 ARM Limited. * * SPDX-License-Identifier: MIT * @@ -43,6 +43,8 @@ public: /** Interface to be implemented that configures an operation * * @param[in] ctx Node parameters to be used by the operation + * + * @return a pointer to the function which implements the operation. */ virtual std::unique_ptr configure(NodeContext &ctx) = 0; /** Interface to be implemented that returns the target of the operation diff --git a/arm_compute/graph/ITensorObject.h b/arm_compute/graph/ITensorObject.h index a922dd53fe..1b6f929305 100644 --- a/arm_compute/graph/ITensorObject.h +++ b/arm_compute/graph/ITensorObject.h @@ -1,5 +1,5 @@ /* - * Copyright (c) 2017 ARM Limited. + * Copyright (c) 2017-2018 ARM Limited. * * SPDX-License-Identifier: MIT * @@ -61,7 +61,11 @@ public: * * @return Tensor */ - virtual ITensor *tensor() = 0; + virtual ITensor *tensor() = 0; + /** Returns a pointer to the internal tensor + * + * @return const Tensor + */ virtual const ITensor *tensor() const = 0; /** Return the target that this tensor is pinned on * -- cgit v1.2.1