IVGCVSW-59 Add documentation to the public API

        * Add documentation to the Descriptors
        * Add documentation to the layers

Change-Id: I5e0849753903565227fd47d329a600fd90b2feb9

1 files changed, 20 insertions, 0 deletions

diff --git a/src/armnn/layers/BatchNormalizationLayer.hpp b/src/armnn/layers/BatchNormalizationLayer.hpp
index 9ed15bebbf..02d8456a67 100644
--- a/src/armnn/layers/BatchNormalizationLayer.hpp
+++ b/src/armnn/layers/BatchNormalizationLayer.hpp
@@ -11,25 +11,45 @@ namespace armnn
 
 class ScopedCpuTensorHandle;
 
+/// This layer represents a batch normalization operation.
 class BatchNormalizationLayer : public LayerWithParameters<BatchNormalizationDescriptor>
 {
 public:
+    /// A unique pointer to store Mean values
     std::unique_ptr<ScopedCpuTensorHandle> m_Mean;
+    /// A unique pointer to store Variance values
     std::unique_ptr<ScopedCpuTensorHandle> m_Variance;
+    /// A unique pointer to store Beta values
     std::unique_ptr<ScopedCpuTensorHandle> m_Beta;
+    /// A unique pointer to store Gamma values
     std::unique_ptr<ScopedCpuTensorHandle> m_Gamma;
 
+    /// Makes a workload for the BatchNormalization 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.
     BatchNormalizationLayer* Clone(Graph& graph) const override;
 
+    /// Check if the input tensor shape(s)
+    /// will lead to a valid configuration of @ref BatchNormalizationLayer.
     void ValidateTensorShapesFromInputs() override;
 
 protected:
+    /// Constructor to create a BatchNormalizationLayer.
+    /// @param [in] param BatchNormalizationDescriptor to configure the batch normalization operation.
+    /// @param [in] name Optional name for the layer.
     BatchNormalizationLayer(const BatchNormalizationDescriptor& param, const char* name);
+
+    /// Default destructor
     ~BatchNormalizationLayer() = 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;
 };