From 35052ae3f44d24cd71f437a2011c5032d34c94a7 Mon Sep 17 00:00:00 2001 From: Conor Kennedy Date: Fri, 21 Dec 2018 14:38:36 +0000 Subject: IVGCVSW-59 Add documentation to the public API * Add documentation to the Descriptors * Add documentation to the layers Change-Id: I5e0849753903565227fd47d329a600fd90b2feb9 --- src/armnn/layers/MemCopyLayer.hpp | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) (limited to 'src/armnn/layers/MemCopyLayer.hpp') diff --git a/src/armnn/layers/MemCopyLayer.hpp b/src/armnn/layers/MemCopyLayer.hpp index 3d79ec3a0b..051b18f1fe 100644 --- a/src/armnn/layers/MemCopyLayer.hpp +++ b/src/armnn/layers/MemCopyLayer.hpp @@ -9,18 +9,31 @@ namespace armnn { +/// This layer represents a memory copy operation. class MemCopyLayer : public Layer { public: - virtual std::unique_ptr - CreateWorkload(const Graph& graph, const IWorkloadFactory& factory) const override; + /// Makes a workload for the MemCopy type. + /// @param [in] graph The graph where this layer can be found. + /// @param [in] factory The workload factory which will create the workload. + /// @return A pointer to the created workload, or nullptr if not created. + virtual std::unique_ptrCreateWorkload(const Graph& graph, + const IWorkloadFactory& factory) const override; + /// Creates a dynamically-allocated copy of this layer. + /// @param [in] graph The graph into which this layer is being cloned. MemCopyLayer* Clone(Graph& graph) const override; + /// Check if the input tensor shape(s) + /// will lead to a valid configuration of @ref MemCopyLayer. void ValidateTensorShapesFromInputs() override; protected: + /// Constructor to create a MemCopyLayer. + /// @param [in] name Optional name for the layer. MemCopyLayer(const char* name); + + /// Default destructor ~MemCopyLayer() = default; }; -- cgit v1.2.1