aboutsummaryrefslogtreecommitdiff
path: root/doxygen
diff options
context:
space:
mode:
authorGyorgy Szing <Gyorgy.Szing@arm.com>2018-08-24 16:37:43 +0200
committerGy├Ârgy Szing <gyorgy.szing@arm.com>2019-03-05 09:28:07 +0000
commit967feecbb344f704f9be8d787db776ece0d9ad0c (patch)
tree544ed8df347bcf6f8304f3caa686f11794d0b4ce /doxygen
parent5b15f854b08285d77fa1156bedfe79cdc87c6d3c (diff)
downloadtrusted-firmware-m-967feecbb344f704f9be8d787db776ece0d9ad0c.tar.gz
Doc: non C specific doxygen documentation added.
Some parts of the TF-M Reference Manual are defined/written outside of C source files. These files have the .dox extension and have meta-data in C coments and doxygen documentation in C doxygen comments. Change-Id: Ia348be72acae9958f1bc65588cc4c14c8cf0c7e7 Signed-off-by: Gyorgy Szing <Gyorgy.Szing@arm.com>
Diffstat (limited to 'doxygen')
-rw-r--r--doxygen/mainpage.dox24
1 files changed, 24 insertions, 0 deletions
diff --git a/doxygen/mainpage.dox b/doxygen/mainpage.dox
new file mode 100644
index 000000000..e552f8faa
--- /dev/null
+++ b/doxygen/mainpage.dox
@@ -0,0 +1,24 @@
+/*
+ * Copyright (c) 2018-2019, Arm Limited. All rights reserved.
+ *
+ * SPDX-License-Identifier: BSD-3-Clause
+ *
+ */
+
+//This file is the main page for the Doxygen based reference guide.
+
+/*!
+\mainpage TF-M Reference Manual
+
+This document gives a reference for the TF-M core and services. This guide does
+not cover the non-secure application example, the boot-loader and the target
+platform implementations.
+
+\htmlonly
+Please use the menu on the left or on the top of the page for navigation.
+
+If information of a specific item is needed, then please use the search box
+top-right.
+\endhtmlonly
+
+*/