COMPMID-1065 : Create documentation explaining how to add new functions / kernels

Change-Id: I98183f95814442b6f3dbb67a1bdae99df05b9b01

8 files changed, 16 insertions, 2 deletions

diff --git a/src/core/CL/ICLKernel.cpp b/src/core/CL/ICLKernel.cpp
index 491e0c4b91..995fcb481b 100644
--- a/src/core/CL/ICLKernel.cpp
+++ b/src/core/CL/ICLKernel.cpp
@@ -110,10 +110,12 @@ void ICLKernel::add_tensor_argument(unsigned &idx, const ICLTensor *tensor, cons
     ARM_COMPUTE_UNUSED(idx_start);
 }
 
+#ifndef DOXYGEN_SKIP_THIS
 template void ICLKernel::add_tensor_argument<1>(unsigned &idx, const ICLTensor *tensor, const Window &window);
 template void ICLKernel::add_tensor_argument<2>(unsigned &idx, const ICLTensor *tensor, const Window &window);
 template void ICLKernel::add_tensor_argument<3>(unsigned &idx, const ICLTensor *tensor, const Window &window);
 template void ICLKernel::add_tensor_argument<4>(unsigned &idx, const ICLTensor *tensor, const Window &window);
+#endif /* DOXYGEN_SKIP_THIS */
 
 void ICLKernel::set_target(cl::Device &device)
 {
diff --git a/src/core/CL/kernels/CLReshapeLayerKernel.cpp b/src/core/CL/kernels/CLReshapeLayerKernel.cpp
index a275e9e874..aa1339dd1e 100644
--- a/src/core/CL/kernels/CLReshapeLayerKernel.cpp
+++ b/src/core/CL/kernels/CLReshapeLayerKernel.cpp
@@ -37,6 +37,7 @@
 
 #include <string>
 
+/** [CLReshapeLayerKernel Kernel] **/
 using namespace arm_compute;
 
 namespace
@@ -123,3 +124,4 @@ void CLReshapeLayerKernel::run(const Window &window, cl::CommandQueue &queue)
     add_3D_tensor_argument(idx, _output, window_collapsed);
     enqueue(queue, *this, slice);
 }
+/** [CLReshapeLayerKernel Kernel] **/
diff --git a/src/core/NEON/kernels/NEReshapeLayerKernel.cpp b/src/core/NEON/kernels/NEReshapeLayerKernel.cpp
index 298f50b93d..c71899144d 100644
--- a/src/core/NEON/kernels/NEReshapeLayerKernel.cpp
+++ b/src/core/NEON/kernels/NEReshapeLayerKernel.cpp
@@ -35,6 +35,7 @@
 
 #include <cstdint>
 
+/** [NEReshapeLayerKernel Kernel] **/
 using namespace arm_compute;
 
 namespace
@@ -120,3 +121,4 @@ void NEReshapeLayerKernel::run(const Window &window, const ThreadInfo &info)
             ARM_COMPUTE_ERROR("Unsupported data type!");
     }
 }
+/** [NEReshapeLayerKernel Kernel] **/
diff --git a/src/core/NEON/kernels/NEWinogradConvolutionLayerKernel.cpp b/src/core/NEON/kernels/NEWinogradConvolutionLayerKernel.cpp
index f5609b6f5c..3e76a080fd 100644
--- a/src/core/NEON/kernels/NEWinogradConvolutionLayerKernel.cpp
+++ b/src/core/NEON/kernels/NEWinogradConvolutionLayerKernel.cpp
@@ -249,6 +249,7 @@ int NEWinogradLayerTransformWeightsKernel<T, OutputTileRows, OutputTileCols, Ker
     return WinogradConv::get_kernel_matrix_stride(kernel_shape);
 }
 
+#ifndef DOXYGEN_SKIP_THIS
 template <typename T, int OutputTileRows, int OutputTileCols, int KernelRows, int KernelCols>
 void NEWinogradLayerTransformWeightsKernel<T, OutputTileRows, OutputTileCols, KernelRows, KernelCols>::configure(
     const ITensor *weights_hwio,
@@ -270,6 +271,7 @@ void NEWinogradLayerTransformWeightsKernel<T, OutputTileRows, OutputTileCols, Ke
     win.set(Window::DimX, Window::Dimension(0, win_last, 1));
     INEKernel::configure(win);
 }
+#endif /* DOXYGEN_SKIP_THIS */
 
 template <typename T, int OutputTileRows, int OutputTileCols, int KernelRows, int KernelCols>
 void NEWinogradLayerTransformWeightsKernel<T, OutputTileRows, OutputTileCols, KernelRows, KernelCols>::run(const Window &window, const ThreadInfo &info)
diff --git a/src/core/Utils.cpp b/src/core/Utils.cpp
index 78c3dba25a..39dad8f581 100644
--- a/src/core/Utils.cpp
+++ b/src/core/Utils.cpp
@@ -34,7 +34,7 @@
 #include <string>
 
 using namespace arm_compute;
-
+#ifndef DOXYGEN_SKIP_THIS
 std::string arm_compute::build_information()
 {
     static const std::string information =
@@ -42,7 +42,7 @@ std::string arm_compute::build_information()
         ;
     return information;
 }
-
+#endif /* DOXYGEN_SKIP_THIS */
 std::string arm_compute::read_file(const std::string &filename, bool binary)
 {
     std::string   out;
diff --git a/src/runtime/CL/functions/CLReshapeLayer.cpp b/src/runtime/CL/functions/CLReshapeLayer.cpp
index b1ca7a821d..b98a99dec3 100644
--- a/src/runtime/CL/functions/CLReshapeLayer.cpp
+++ b/src/runtime/CL/functions/CLReshapeLayer.cpp
@@ -27,6 +27,7 @@
 #include "arm_compute/core/CL/kernels/CLReshapeLayerKernel.h"
 #include "support/ToolchainSupport.h"
 
+/** [CLReshapeLayer snippet] **/
 using namespace arm_compute;
 
 void CLReshapeLayer::configure(const ICLTensor *input, ICLTensor *output)
@@ -40,3 +41,4 @@ Status CLReshapeLayer::validate(const ITensorInfo *input, const ITensorInfo *out
 {
     return CLReshapeLayerKernel::validate(input, output);
 }
+/** [CLReshapeLayer snippet] **/
diff --git a/src/runtime/CPP/CPPScheduler.cpp b/src/runtime/CPP/CPPScheduler.cpp
index 68611f7eea..2b179fd5ff 100644
--- a/src/runtime/CPP/CPPScheduler.cpp
+++ b/src/runtime/CPP/CPPScheduler.cpp
@@ -228,6 +228,7 @@ unsigned int CPPScheduler::num_threads() const
     return _num_threads;
 }
 
+#ifndef DOXYGEN_SKIP_THIS
 void CPPScheduler::run_workloads(std::vector<IScheduler::Workload> &workloads)
 {
     const unsigned int num_threads = std::min(_num_threads, static_cast<unsigned int>(workloads.size()));
@@ -262,6 +263,7 @@ void CPPScheduler::run_workloads(std::vector<IScheduler::Workload> &workloads)
         std::cerr << "Caught system_error with code " << e.code() << " meaning " << e.what() << '\n';
     }
 }
+#endif /* DOXYGEN_SKIP_THIS */
 
 void CPPScheduler::schedule(ICPPKernel *kernel, const Hints &hints)
 {
diff --git a/src/runtime/OMP/OMPScheduler.cpp b/src/runtime/OMP/OMPScheduler.cpp
index 77ee233cdd..2355389dbd 100644
--- a/src/runtime/OMP/OMPScheduler.cpp
+++ b/src/runtime/OMP/OMPScheduler.cpp
@@ -89,6 +89,7 @@ void OMPScheduler::schedule(ICPPKernel *kernel, const Hints &hints)
     }
 }
 
+#ifndef DOXYGEN_SKIP_THIS
 void OMPScheduler::run_workloads(std::vector<arm_compute::IScheduler::Workload> &workloads)
 {
     const unsigned int num_threads = std::min(_num_threads, static_cast<unsigned int>(workloads.size()));
@@ -107,3 +108,4 @@ void OMPScheduler::run_workloads(std::vector<arm_compute::IScheduler::Workload>
         workloads[tid](info);
     }
 }
+#endif /* DOXYGEN_SKIP_THIS */