IVGCVSW-59 Add documentation to the public API

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

Change-Id: I5e0849753903565227fd47d329a600fd90b2feb9

1 files changed, 23 insertions, 1 deletions

diff --git a/src/armnn/layers/ReshapeLayer.hpp b/src/armnn/layers/ReshapeLayer.hpp
index c3afee3557..13e73be4e4 100644
--- a/src/armnn/layers/ReshapeLayer.hpp
+++ b/src/armnn/layers/ReshapeLayer.hpp
@@ -9,17 +9,34 @@
 namespace armnn
 {
 
+/// This layer represents a reshape operation.
 class ReshapeLayer : public LayerWithParameters<ReshapeDescriptor>
 {
 public:
+    /// Makes a workload for the Reshape 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;
+                                                      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.
     ReshapeLayer* Clone(Graph& graph) const override;
 
+    /// Check if the input tensor shape(s)
+    /// will lead to a valid configuration of @ref ReshapeLayer.
     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;
 
+    /// Indicates if the other layer received is equal to this one.
+    /// @param other The other layer to be compared with.
+    /// @return true if other layer is equal to this false otherwise.
     bool IsEqual(const Layer& other) const
     {
         return (other.GetType() == LayerType::Reshape) &&
@@ -27,7 +44,12 @@ public:
     }
 
 protected:
+    /// Constructor to create a ReshapeLayer.
+    /// @param [in] param ReshapeDescriptor to configure the reshape operation.
+    /// @param [in] name Optional name for the layer.
     ReshapeLayer(const ReshapeDescriptor& desc, const char* name);
+
+    /// Default destructor
     ~ReshapeLayer() = default;
 };