From 35052ae3f44d24cd71f437a2011c5032d34c94a7 Mon Sep 17 00:00:00 2001
From: Conor Kennedy <conor.kennedy@arm.com>
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/Convolution2dLayer.hpp | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

(limited to 'src/armnn/layers/Convolution2dLayer.hpp')

diff --git a/src/armnn/layers/Convolution2dLayer.hpp b/src/armnn/layers/Convolution2dLayer.hpp
index 31a9117139..b812b1bece 100644
--- a/src/armnn/layers/Convolution2dLayer.hpp
+++ b/src/armnn/layers/Convolution2dLayer.hpp
@@ -11,25 +11,47 @@ namespace armnn
 
 class ScopedCpuTensorHandle;
 
+/// This layer represents a convolution 2d operation.
 class Convolution2dLayer : public LayerWithParameters<Convolution2dDescriptor>
 {
 public:
+    /// A unique pointer to store Weight values.
     std::unique_ptr<ScopedCpuTensorHandle> m_Weight;
+    /// A unique pointer to store Bias values.
     std::unique_ptr<ScopedCpuTensorHandle> m_Bias;
 
+    /// Makes a workload for the Convolution2d 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_ptr<IWorkload> CreateWorkload(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.
     Convolution2dLayer* Clone(Graph& graph) const override;
 
+    /// Check if the input tensor shape(s)
+    /// will lead to a valid configuration of @ref Convolution2dLayer.
     void ValidateTensorShapesFromInputs() override;
 
+    /// By default returns inputShapes if the number of inputs are equal to number of outputs,
+    /// otherwise infers the output shapes from given input shapes and layer properties.
+    /// @param [in] inputShapes The input shapes layer has.
+    /// @return A vector to the inferred output shape.
     std::vector<TensorShape> InferOutputShapes(const std::vector<TensorShape>& inputShapes) const override;
 
 protected:
+    /// Constructor to create a Convolution2dLayer.
+    /// @param [in] param Convolution2dDescriptor to configure the convolution2d operation.
+    /// @param [in] name Optional name for the layer.
     Convolution2dLayer(const Convolution2dDescriptor& param, const char* name);
+
+    /// Default destructor
     ~Convolution2dLayer() = default;
 
+    /// Retrieve the handles to the constant values stored by the layer.
+    /// @return A vector of the constant tensors stored by this layer.
     ConstantTensors GetConstantTensorsByRef() override;
 };
 
-- 
cgit v1.2.1