aboutsummaryrefslogtreecommitdiff
path: root/docs/05_00_software_components.dox
diff options
context:
space:
mode:
authorNikhil Raj <nikhil.raj@arm.com>2021-11-10 15:01:25 +0000
committerNikhil Raj Arm <nikhil.raj@arm.com>2021-11-11 17:38:25 +0000
commit608c8366c0979a14607ec77d06771d6c994332b2 (patch)
tree32a492099a99c7033b92d6728f18f032028500c6 /docs/05_00_software_components.dox
parentf596ad0ee83e23b3c6ad80a574be4fe7bdd4826e (diff)
downloadarmnn-608c8366c0979a14607ec77d06771d6c994332b2.tar.gz
Remove use guide section from doxygen
* This guide has now been moved to the Quick Start section in doxygen Signed-off-by: Nikhil Raj <nikhil.raj@arm.com> Change-Id: I758915c43f0e9e116f7308482db34d560d7ba0d9
Diffstat (limited to 'docs/05_00_software_components.dox')
-rw-r--r--docs/05_00_software_components.dox46
1 files changed, 46 insertions, 0 deletions
diff --git a/docs/05_00_software_components.dox b/docs/05_00_software_components.dox
new file mode 100644
index 0000000000..2d65daed1e
--- /dev/null
+++ b/docs/05_00_software_components.dox
@@ -0,0 +1,46 @@
+/// Copyright (c) 2021 ARM Limited and Contributors. All rights reserved.
+///
+/// SPDX-License-Identifier: MIT
+///
+
+namespace armnn
+{
+/**
+@page swtools Software Components
+
+On this page you can find all software components 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_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_armnnConverter_README Converter
+
+@page md_tests_ModelAccuracyTool-Armnn_README ModelAccuracyTool
+
+@page md_tests_ImageCSVFileGenerator_README ImageCSVFileGenerator
+
+@page md_tests_ImageTensorGenerator_README ImageTensorGenerator
+
+**/
+}
+