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>
diff --git a/secure_fw/services/audit_logging/dir_audit_logging.dox b/secure_fw/services/audit_logging/dir_audit_logging.dox
new file mode 100644
index 0000000..68955e9
--- /dev/null
+++ b/secure_fw/services/audit_logging/dir_audit_logging.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 for the Audit Logging service.
+\details The audit logging service is responsible for implementing logging
+functionalities which are used to store information on security related events.
+
+*/
\ No newline at end of file
diff --git a/secure_fw/services/crypto/dir_crypto.dox b/secure_fw/services/crypto/dir_crypto.dox
new file mode 100644
index 0000000..1c7480a
--- /dev/null
+++ b/secure_fw/services/crypto/dir_crypto.dox
@@ -0,0 +1,16 @@
+/*
+ * Copyright (c) 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 for the Crypto service.
+\details The Crypto service captures cryptography functionality.
+
+*/
diff --git a/secure_fw/services/dir_services.dox b/secure_fw/services/dir_services.dox
new file mode 100644
index 0000000..7525e15
--- /dev/null
+++ b/secure_fw/services/dir_services.dox
@@ -0,0 +1,18 @@
+/*
+ * 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 for secure services.
+\details The source code of each service lives in a sub-directory. In addition
+this directory holds source files defining partitioning information. These are
+generated from the templates in this directory, and partition manifest files.
+
+*/
\ No newline at end of file
diff --git a/secure_fw/services/initial_attestation/dir_initial_attestation.dox b/secure_fw/services/initial_attestation/dir_initial_attestation.dox
new file mode 100644
index 0000000..e709c8a
--- /dev/null
+++ b/secure_fw/services/initial_attestation/dir_initial_attestation.dox
@@ -0,0 +1,17 @@
+/*
+ * Copyright (c) 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 for the initial Attestation service.
+\details The initial Attestation service implements initial attestation
+functionality.
+
+*/
\ No newline at end of file
diff --git a/secure_fw/services/platform/dir_platform.dox b/secure_fw/services/platform/dir_platform.dox
new file mode 100644
index 0000000..4b25d63
--- /dev/null
+++ b/secure_fw/services/platform/dir_platform.dox
@@ -0,0 +1,16 @@
+/*
+ * Copyright (c) 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 for the Platform service.
+\details The Platform service captures target platform specific functionality.
+
+*/
\ No newline at end of file
diff --git a/secure_fw/services/secure_storage/dir_secure_storage.dox b/secure_fw/services/secure_storage/dir_secure_storage.dox
new file mode 100644
index 0000000..036fbce
--- /dev/null
+++ b/secure_fw/services/secure_storage/dir_secure_storage.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 for the Secure Storage service.
+\details The secure storage service is responsible to hold sensitive information
+in a protected storage.
+
+*/
\ No newline at end of file