IVGCVSW-59 Add documentation to the public API

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

Change-Id: I5e0849753903565227fd47d329a600fd90b2feb9

1 files changed, 26 insertions, 0 deletions

diff --git a/src/armnn/layers/PermuteLayer.hpp b/src/armnn/layers/PermuteLayer.hpp
index a32307dc10..e1f391a2ff 100644
--- a/src/armnn/layers/PermuteLayer.hpp
+++ b/src/armnn/layers/PermuteLayer.hpp
@@ -9,28 +9,49 @@
 namespace armnn
 {
 
+/// This layer represents a permutation operation.
 class PermuteLayer : public LayerWithParameters<PermuteDescriptor>
 {
 public:
+    /// Makes a workload for the Permute 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.
     PermuteLayer* Clone(Graph& graph) const override;
 
+    /// Check if the input tensor shape(s)
+    /// will lead to a valid configuration of @ref PermuteLayer.
     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;
 
+    /// @return a permutation vector represents the memory layout of the tensor elements.
     const PermutationVector& GetPermutation() const
     {
         return m_Param.m_DimMappings;
     }
 
+    /// Indicates if the other layer received is inverse of this one.
+    /// @param other The other layer to be compared with.
+    /// @return true if other layer is inverse of this false otherwise.
     bool IsInverse(const Layer& other) const
     {
         return (other.GetType() == LayerType::Permute) &&
             GetPermutation().IsInverse(boost::polymorphic_downcast<const PermuteLayer*>(&other)->GetPermutation());
     }
 
+    /// Indicates if the other layer received is equal to this one.
+    /// @param other The other layer to be compare with.
+    /// @return true if other layer is equal to this false otherwise.
     bool IsEqual(const Layer& other) const
     {
         return (other.GetType() == LayerType::Permute) &&
@@ -38,7 +59,12 @@ public:
     }
 
 protected:
+    /// Constructor to create a PermuteLayer.
+    /// @param [in] param PermuteDescriptor to configure the permute operation.
+    /// @param [in] name Optional name for the layer.
     PermuteLayer(const PermuteDescriptor& param, const char* name);
+
+    /// Default destructor
     ~PermuteLayer() = default;
 };