IVGCVSW-59 Add documentation to the public API

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

Change-Id: I5e0849753903565227fd47d329a600fd90b2feb9

1 files changed, 14 insertions, 0 deletions

diff --git a/src/armnn/layers/DebugLayer.hpp b/src/armnn/layers/DebugLayer.hpp
index 6aaa271807..fc777a8bad 100644
--- a/src/armnn/layers/DebugLayer.hpp
+++ b/src/armnn/layers/DebugLayer.hpp
@@ -9,18 +9,32 @@
 namespace armnn
 {
 
+/// This layer visualizes the data flowing through the network.
 class DebugLayer : public LayerWithParameters<DebugDescriptor>
 {
 public:
+    /// Makes a workload for the Debug 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.
     DebugLayer* Clone(Graph& graph) const override;
 
+    /// Check if the input tensor shape(s)
+    /// will lead to a valid configuration of @ref DebugLayer.
     void ValidateTensorShapesFromInputs() override;
 
 protected:
+    /// Constructor to create a DebugLayer.
+    /// @param [in] param DebugDescriptor to configure the debug layer.
+    /// @param [in] name Optional name for the layer.
     DebugLayer(const DebugDescriptor& param, const char* name);
+
+    /// Default destructor
     ~DebugLayer() = default;
 };