diff options
author | Jan Eilers <jan.eilers@arm.com> | 2021-01-31 19:56:23 +0000 |
---|---|---|
committer | Jan Eilers <jan.eilers@arm.com> | 2021-02-03 09:12:42 +0000 |
commit | 84f41eb74765bd93307f3c6b334354c486dc746d (patch) | |
tree | 886524a7ac9b7dedb0a4c2025d20492171be40d3 /docs/04_contributor.dox | |
parent | 31a7c890207f80afc866f706d797267d78d05a0d (diff) | |
download | armnn-84f41eb74765bd93307f3c6b334354c486dc746d.tar.gz |
IVGCVSW-5605 Doxygen: Add contribution guide sections
* Adds a page for contribution guidelines (Uses md guide)
* Adds a section for contribution guides (Uses md guide)
* Minor beautification
Signed-off-by: Jan Eilers <jan.eilers@arm.com>
Change-Id: Iafd7e3abf9da660ec21a215afada61a27ce928fc
Diffstat (limited to 'docs/04_contributor.dox')
-rw-r--r-- | docs/04_contributor.dox | 39 |
1 files changed, 39 insertions, 0 deletions
diff --git a/docs/04_contributor.dox b/docs/04_contributor.dox new file mode 100644 index 0000000000..5cbb6c3b8c --- /dev/null +++ b/docs/04_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 + +**/ +} |