COMPMID-1393: Update example documentation

Change-Id: I7251575645b35b611de9d8931bb2b7dbc096de13
Reviewed-on: https://eu-gerrit-1.euhpc.arm.com/140544
Tested-by: Jenkins <bsgcomp@arm.com>
Reviewed-by: Anthony Barbier <anthony.barbier@arm.com>

12 files changed, 25 insertions, 1 deletions

diff --git a/examples/graph_alexnet.cpp b/examples/graph_alexnet.cpp
index e4bc2da571..63e7b16128 100644
--- a/examples/graph_alexnet.cpp
+++ b/examples/graph_alexnet.cpp
@@ -170,6 +170,8 @@ private:
 
 /** Main program for AlexNet
  *
+ * @note To list all the possible arguments execute the binary appended with the --help option
+ *
  * @param[in] argc Number of arguments
  * @param[in] argv Arguments
  *
diff --git a/examples/graph_googlenet.cpp b/examples/graph_googlenet.cpp
index f9cb9787f1..4497dbd470 100644
--- a/examples/graph_googlenet.cpp
+++ b/examples/graph_googlenet.cpp
@@ -197,6 +197,8 @@ private:
 
 /** Main program for Googlenet
  *
+ * @note To list all the possible arguments execute the binary appended with the --help option
+ *
  * @param[in] argc Number of arguments
  * @param[in] argv Arguments
  */
diff --git a/examples/graph_inception_v3.cpp b/examples/graph_inception_v3.cpp
index 6262193b02..67f4e3cacf 100644
--- a/examples/graph_inception_v3.cpp
+++ b/examples/graph_inception_v3.cpp
@@ -845,6 +845,8 @@ private:
 
 /** Main program for Inception V3
  *
+ * @note To list all the possible arguments execute the binary appended with the --help option
+ *
  * @param[in] argc Number of arguments
  * @param[in] argv Arguments
  */
diff --git a/examples/graph_inception_v4.cpp b/examples/graph_inception_v4.cpp
index def73dff7a..4e405923fc 100644
--- a/examples/graph_inception_v4.cpp
+++ b/examples/graph_inception_v4.cpp
@@ -719,6 +719,8 @@ private:
 
 /** Main program for Inception V4
  *
+ * @note To list all the possible arguments execute the binary appended with the --help option
+ *
  * @param[in] argc Number of arguments
  * @param[in] argv Arguments
  */
diff --git a/examples/graph_lenet.cpp b/examples/graph_lenet.cpp
index c02e2f9ec0..0d8a943737 100644
--- a/examples/graph_lenet.cpp
+++ b/examples/graph_lenet.cpp
@@ -126,8 +126,10 @@ private:
 
 /** Main program for LeNet
  *
+ * @note To list all the possible arguments execute the binary appended with the --help option
+ *
  * @param[in] argc Number of arguments
- * @param[in] argv Arguments ( [optional] Target (0 = NEON, 1 = OpenCL, 2 = OpenCL with Tuner), [optional] Path to the weights folder, [optional] batches, [optional] Fast math for convolution layer (0 = DISABLED, 1 = ENABLED) )
+ * @param[in] argv Arguments
  */
 int main(int argc, char **argv)
 {
diff --git a/examples/graph_mobilenet.cpp b/examples/graph_mobilenet.cpp
index 395936b8f7..b30f4c5fd3 100644
--- a/examples/graph_mobilenet.cpp
+++ b/examples/graph_mobilenet.cpp
@@ -339,6 +339,8 @@ private:
 
 /** Main program for MobileNetV1
  *
+ * @note To list all the possible arguments execute the binary appended with the --help option
+ *
  * @param[in] argc Number of arguments
  * @param[in] argv Arguments
  */
diff --git a/examples/graph_resnet50.cpp b/examples/graph_resnet50.cpp
index 2970037768..58f36f6ae4 100644
--- a/examples/graph_resnet50.cpp
+++ b/examples/graph_resnet50.cpp
@@ -232,6 +232,8 @@ private:
 
 /** Main program for ResNet50
  *
+ * @note To list all the possible arguments execute the binary appended with the --help option
+ *
  * @param[in] argc Number of arguments
  * @param[in] argv Arguments
  */
diff --git a/examples/graph_resnext50.cpp b/examples/graph_resnext50.cpp
index a02e406acb..c0e9b9f22a 100644
--- a/examples/graph_resnext50.cpp
+++ b/examples/graph_resnext50.cpp
@@ -183,6 +183,8 @@ private:
 
 /** Main program for ResNeXt50
  *
+ * @note To list all the possible arguments execute the binary appended with the --help option
+ *
  * @param[in] argc Number of arguments
  * @param[in] argv Arguments
  */
diff --git a/examples/graph_squeezenet.cpp b/examples/graph_squeezenet.cpp
index 9751539af6..9439ab4343 100644
--- a/examples/graph_squeezenet.cpp
+++ b/examples/graph_squeezenet.cpp
@@ -199,6 +199,8 @@ private:
 
 /** Main program for Squeezenet v1.0
  *
+ * @note To list all the possible arguments execute the binary appended with the --help option
+ *
  * @param[in] argc Number of arguments
  * @param[in] argv Arguments
  */
diff --git a/examples/graph_squeezenet_v1_1.cpp b/examples/graph_squeezenet_v1_1.cpp
index be0c326f2a..ba7ee774a7 100644
--- a/examples/graph_squeezenet_v1_1.cpp
+++ b/examples/graph_squeezenet_v1_1.cpp
@@ -201,6 +201,8 @@ private:
 
 /** Main program for Squeezenet v1.1
  *
+ * @note To list all the possible arguments execute the binary appended with the --help option
+ *
  * @param[in] argc Number of arguments
  * @param[in] argv Arguments
  */
diff --git a/examples/graph_vgg16.cpp b/examples/graph_vgg16.cpp
index 8ce1221ead..e677650d04 100644
--- a/examples/graph_vgg16.cpp
+++ b/examples/graph_vgg16.cpp
@@ -234,6 +234,8 @@ private:
 
 /** Main program for VGG16
  *
+ * @note To list all the possible arguments execute the binary appended with the --help option
+ *
  * @param[in] argc Number of arguments
  * @param[in] argv Arguments
  */
diff --git a/examples/graph_vgg19.cpp b/examples/graph_vgg19.cpp
index dcde4a2a65..c7fc333e0a 100644
--- a/examples/graph_vgg19.cpp
+++ b/examples/graph_vgg19.cpp
@@ -246,6 +246,8 @@ private:
 
 /** Main program for VGG19
  *
+ * @note To list all the possible arguments execute the binary appended with the --help option
+ *
  * @param[in] argc Number of arguments
  * @param[in] argv Arguments
  */