aboutsummaryrefslogtreecommitdiff
path: root/docs/01_00_software_tools.dox
diff options
context:
space:
mode:
authorJan Eilers <jan.eilers@arm.com>2021-01-29 14:18:13 +0000
committerJan Eilers <jan.eilers@arm.com>2021-02-03 09:11:51 +0000
commit31a7c890207f80afc866f706d797267d78d05a0d (patch)
tree8b133170fbdf0d87a0a8a5b72c6eaf73fcbb2391 /docs/01_00_software_tools.dox
parent74a3cf5755b801cf258177e8e55b4cda64a0c351 (diff)
downloadarmnn-31a7c890207f80afc866f706d797267d78d05a0d.tar.gz
IVGCVSW-5605 Doxygen: Add the TfLite Delegate to Doxygen docu
* Moves TensorFlowLiteDelegateSupport.md to doxygen * Renames a few .dox files to represent the structure of the documentation * Adds sections for build and use guides * Integrates markdown guides for the delegate into doxygen Signed-off-by: Jan Eilers <jan.eilers@arm.com> Change-Id: I68b7a29239be88c0617da9bdfce5323ebf26f5bc
Diffstat (limited to 'docs/01_00_software_tools.dox')
-rw-r--r--docs/01_00_software_tools.dox58
1 files changed, 58 insertions, 0 deletions
diff --git a/docs/01_00_software_tools.dox b/docs/01_00_software_tools.dox
new file mode 100644
index 0000000000..416e2265bb
--- /dev/null
+++ b/docs/01_00_software_tools.dox
@@ -0,0 +1,58 @@
+/// Copyright (c) 2021 ARM Limited and Contributors. All rights reserved.
+///
+/// SPDX-License-Identifier: MIT
+///
+
+namespace armnn
+{
+/**
+@page swtools Software Tools
+
+On this page you can find all software tools contained in the Arm NN repository. You will find links to how-to guides and
+other helpful information in each section.
+
+@subpage delegate
+
+@subpage parsers
+
+@subpage md_python_pyarmnn_README
+
+@subpage serializer
+
+@subpage deserializer
+
+@subpage md_src_armnnQuantizer_README
+
+@subpage md_src_armnnConverter_README
+
+@subpage md_tests_ImageCSVFileGenerator_README
+
+@subpage md_tests_ImageTensorGenerator_README
+
+@subpage md_tests_ModelAccuracyTool-Armnn_README
+**/
+}
+
+
+/// Create pages for each tool so they appear nicely in the doxygen tree-view. Subpages are not listed there.
+///
+/// Note: The parser, serializer and deserializer pages are created in 01_parsers.dox or 02_deserializer_serializer.dox
+namespace armnn
+{
+/**
+
+@page md_python_pyarmnn_README PyArmNN
+
+@page md_src_armnnQuantizer_README Quantizer
+
+@page md_src_armnnConverter_README Converter
+
+@page md_tests_ModelAccuracyTool-Armnn_README ModelAccuracyTool
+
+@page md_tests_ImageCSVFileGenerator_README ImageCSVFileGenerator
+
+@page md_tests_ImageTensorGenerator_README ImageTensorGenerator
+
+**/
+}
+