aboutsummaryrefslogtreecommitdiff
path: root/interface/dir_interface.dox
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 /interface/dir_interface.dox
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 'interface/dir_interface.dox')
-rw-r--r--interface/dir_interface.dox17
1 files changed, 17 insertions, 0 deletions
diff --git a/interface/dir_interface.dox b/interface/dir_interface.dox
new file mode 100644
index 0000000000..2ddef823e5
--- /dev/null
+++ b/interface/dir_interface.dox
@@ -0,0 +1,17 @@
+/*
+ * Copyright (c) 2018-2019, Arm Limited. All rights reserved.
+ *
+ * SPDX-License-Identifier: BSD-3-Clause
+ *
+ */
+
+//This file holds description for the current directory. This documentation
+//will be included in the Doxygen output.
+
+/*!
+\dir
+\brief Source code defining secure domain entry points for the non-secure
+domain.
+\details
+
+*/ \ No newline at end of file