aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorJan Eilers <jan.eilers@arm.com>2021-08-17 13:50:08 +0100
committerNikhil Raj <nikhil.raj@arm.com>2021-08-20 11:14:02 +0100
commit3309c339b20aaeb29157576a620c4f38ee98730c (patch)
treebb118acb596a6b3366f4acb9968ebb3f5bf4fb2d /docs
parent4914d0c1f4cbb01fe276a7093af4cff13270b74a (diff)
downloadarmnn-3309c339b20aaeb29157576a620c4f38ee98730c.tar.gz
Make samples visible in doxygen
* uses the @example doxygen command to add all our simple examples into an 'Examples' tab in the doxygen documentation Signed-off-by: Jan Eilers <jan.eilers@arm.com> Change-Id: Ie8ae19ca471a0616eeea7f708d547388c8ee860e Signed-off-by: Nikhil Raj <nikhil.raj@arm.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/01_01_parsers.dox4
-rw-r--r--docs/Doxyfile3
2 files changed, 4 insertions, 3 deletions
diff --git a/docs/01_01_parsers.dox b/docs/01_01_parsers.dox
index 3ac5b27735..97497fe016 100644
--- a/docs/01_01_parsers.dox
+++ b/docs/01_01_parsers.dox
@@ -22,7 +22,7 @@ bindings take a look into the @ref md_python_pyarmnn_README section.
-@section S5_onnx_parser ArmNN Onnx Parser
+@section S5_onnx_parser Arm NN Onnx Parser
`armnnOnnxParser` is a library for loading neural networks defined in ONNX protobuf files into the Arm NN runtime.
@@ -92,7 +92,7 @@ More machine learning operators will be supported in future releases.
-@section S6_tf_lite_parser ArmNN Tf Lite Parser
+@section S6_tf_lite_parser Arm NN Tf Lite Parser
`armnnTfLiteParser` is a library for loading neural networks defined by TensorFlow Lite FlatBuffers files
into the Arm NN runtime.
diff --git a/docs/Doxyfile b/docs/Doxyfile
index 16510041cf..3fc872eda2 100644
--- a/docs/Doxyfile
+++ b/docs/Doxyfile
@@ -840,7 +840,8 @@ INPUT = ./docs/01_00_software_tools.dox \
./InstallationViaAptRepository.md \
./ContributorGuide.md \
./BuildGuideAndroidNDK.md \
- ./BuildGuideCrossCompilation.md
+ ./BuildGuideCrossCompilation.md \
+ ./samples/examples.dox
# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses