aboutsummaryrefslogtreecommitdiff
path: root/docs/05_contributor.dox
diff options
context:
space:
mode:
authorNikhil Raj <nikhil.raj@arm.com>2021-11-05 12:26:41 +0000
committerJim Flynn <jim.flynn@arm.com>2021-11-06 09:20:24 +0000
commit3f22d27f51c493e37b9da0692b6bf776f4430dcf (patch)
tree9fa3a05ff5bc9298ca768db8aa18b8a935e19daf /docs/05_contributor.dox
parentd3b94d305fddd3bbbdf718685084087e4b92ca7f (diff)
downloadarmnn-3f22d27f51c493e37b9da0692b6bf776f4430dcf.tar.gz
IVGCVSW-6372 Change order in doxygen tree view
Signed-off-by: Nikhil Raj <nikhil.raj@arm.com> Change-Id: Ia765d335ef998e7e47a1c0c81a375645972f4e1d
Diffstat (limited to 'docs/05_contributor.dox')
-rw-r--r--docs/05_contributor.dox39
1 files changed, 39 insertions, 0 deletions
diff --git a/docs/05_contributor.dox b/docs/05_contributor.dox
new file mode 100644
index 0000000000..5cbb6c3b8c
--- /dev/null
+++ b/docs/05_contributor.dox
@@ -0,0 +1,39 @@
+/// Copyright (c) 2021 ARM Limited and Contributors. All rights reserved.
+///
+/// SPDX-License-Identifier: MIT
+///
+
+namespace armnn
+{
+/**
+
+@page contribguides Contribution Guides
+@tableofcontents
+
+This is a collection of guides that should help you contribute code to Arm NN. Before you get started, please
+take a look into our /ref md_Contributor_Guide section.
+
+ - @subpage md_src_backends_README \n
+ This guide explains how to add your own backend to Arm NN. This might be useful if you would like to accelerate neural
+ networks on hardware that Arm NN currently doesn't support.
+
+
+ - @subpage md_src_dynamic_README \n
+ Arm NN allows you to load a backend dynamically on runtime. To find out how that can be done take a look at this guide.
+
+**/
+}
+
+
+/// Create pages for each tool so they appear nicely in the doxygen tree-view. Subpages are not listed there.
+/// Also we can overwrite the page name this way.
+namespace armnn
+{
+/**
+
+@page md_src_backends_README Backend Developer Guide
+
+@page md_src_dynamic_README Dynamically loadable Backend
+
+**/
+}