Doc: fix doxygen comments.
Some existing doxygen comments resulted in bad or bad looking
documentation. These were fixed.
Change-Id: I20ab5a81c54d3bdc0e056965ad7de293d472cdf9
Signed-off-by: Gyorgy Szing <Gyorgy.Szing@arm.com>
diff --git a/test/framework/test_framework.h b/test/framework/test_framework.h
index b27e298..8c50ae5 100644
--- a/test/framework/test_framework.h
+++ b/test/framework/test_framework.h
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2017-2018, Arm Limited. All rights reserved.
+ * Copyright (c) 2017-2019, Arm Limited. All rights reserved.
*
* SPDX-License-Identifier: BSD-3-Clause
*
@@ -86,12 +86,12 @@
const char *test_err_to_str(enum test_suite_err_t err);
/**
- * \brief Sets test suite parameters in the \ref structure.
+ * \brief Sets test suite parameters.
*
* \param[in] name Test suite name
* \param[in] test_list Pointer to the test list
* \param[in] size Test list size
- * \param[in/out] p_ts Pointer to test suite object to fill in the
+ * \param[in,out] p_ts Pointer to test suite object to fill in the
* parameters
*
* \returns Returns error code as specified in \ref test_suite_err_t
@@ -103,7 +103,7 @@
/**
* \brief Runs the given test suite.
*
- * \param[in/out] test_suite Test suite to run the list of tests and
+ * \param[in,out] test_suite Test suite to run the list of tests and
* store test results.
*
* \returns Returns error code as specified in \ref test_suite_err_t
@@ -118,13 +118,13 @@
void show_tests(const struct test_suite_t *ts);
/**
- * \brief Sets test failure state and information in the \ref sst_test_result_t
+ * \brief Sets test failure state and information in the \ref test_result_t
* structure.
*
* \param[in] info_msg Information message to show
* \param[in] filename Filename where the error has ocurred
* \param[in] line Line in the file where the error has ocurred
- * \param[out] ret Pointer to \ref sst_test_result_t structure to
+ * \param[out] ret Pointer to \ref test_result_t structure to
* set the values
*
* \note: If info_msg is "" or , info message is not shown. If filename is "",
diff --git a/test/framework/test_framework_helpers.h b/test/framework/test_framework_helpers.h
index 03eb3dc..fe530a3 100755
--- a/test/framework/test_framework_helpers.h
+++ b/test/framework/test_framework_helpers.h
@@ -30,7 +30,7 @@
/**
* \brief Translates psa_ps_status_t into a string.
*
- * \param[in] err psa_ps_status_t status value.
+ * \param[in] status psa_ps_status_t status value.
*
* \return psa_ps_status_t as string.
*/
diff --git a/test/suites/attestation/secure/attestation_s_tests.h b/test/suites/attestation/secure/attestation_s_tests.h
index f240c94..97e8c40 100644
--- a/test/suites/attestation/secure/attestation_s_tests.h
+++ b/test/suites/attestation/secure/attestation_s_tests.h
@@ -17,7 +17,7 @@
/**
* \brief Register testsuite for the initial attestation service.
*
- * \param[in] p_test_suite The test suite to be executed.
+ * \param[in] "p_test_suite" The test suite to be executed.
*/
void
register_testsuite_s_attestation_interface(struct test_suite_t *p_test_suite);
diff --git a/test/suites/audit/audit_tests_common.h b/test/suites/audit/audit_tests_common.h
index c23efff..93bd6a8 100644
--- a/test/suites/audit/audit_tests_common.h
+++ b/test/suites/audit/audit_tests_common.h
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2018, Arm Limited. All rights reserved.
+ * Copyright (c) 2018-2019, Arm Limited. All rights reserved.
*
* SPDX-License-Identifier: BSD-3-Clause
*
@@ -43,7 +43,7 @@
*
* \brief A log item with no payload (standard size) has the following size.
* More details can be found observing \ref psa_audit_record
- * \ref tfm_log_tlr and \ref tfm_log_hdr
+ * \ref log_tlr and \ref log_hdr
*/
#define STANDARD_LOG_ENTRY_SIZE (28)
@@ -82,7 +82,7 @@
#define FINAL_LOGGING_SIZE (56)
/*!
- * \def DUMMY_TEST_ID_BASE
+ * \def DUMMY_TEST_RECORD_ID_BASE
*
* \brief The log record is initialized with a dummy ID which uses this value as
* base value
diff --git a/test/suites/core/non_secure/core_test_api.h b/test/suites/core/non_secure/core_test_api.h
index 7371915..864cadc 100644
--- a/test/suites/core/non_secure/core_test_api.h
+++ b/test/suites/core/non_secure/core_test_api.h
@@ -27,7 +27,7 @@
};
/**
- * \brief Calls the secure function provided in \ref fn_ptr
+ * \brief Calls the secure function provided in \c fn_ptr
*
* \param[in] fn_ptr Secure function to be called.
* \param[in] args Arguments for fn_ptr.
diff --git a/test/suites/sst/non_secure/os_wrapper.h b/test/suites/sst/non_secure/os_wrapper.h
index ebff448..2df3532 100644
--- a/test/suites/sst/non_secure/os_wrapper.h
+++ b/test/suites/sst/non_secure/os_wrapper.h
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2017-2018, Arm Limited. All rights reserved.
+ * Copyright (c) 2017-2019, Arm Limited. All rights reserved.
*
* SPDX-License-Identifier: BSD-3-Clause
*
@@ -59,7 +59,7 @@
*
* \return 0 in case of successful release, or OS_WRAPPER_ERROR in case of error
*/
-uint32_t os_wrapper_semaphore_delete(uint32_t sema);
+uint32_t os_wrapper_semaphore_delete(uint32_t semaphore_id);
/**
* \brief Creates a new thread
diff --git a/test/test_services/tfm_core_test_2/tfm_ss_core_test_2.c b/test/test_services/tfm_core_test_2/tfm_ss_core_test_2.c
index ac5c172..77368f4 100644
--- a/test/test_services/tfm_core_test_2/tfm_ss_core_test_2.c
+++ b/test/test_services/tfm_core_test_2/tfm_ss_core_test_2.c
@@ -51,7 +51,10 @@
return CORE_TEST_ERRNO_SUCCESS_2;
}
-psa_status_t spm_core_test_2_check_caller_client_id(void)
+psa_status_t spm_core_test_2_check_caller_client_id(struct psa_invec *in_vec,
+ size_t in_len,
+ struct psa_outvec *out_vec,
+ size_t out_len)
{
size_t i;
int32_t caller_client_id_stack = INVALID_NS_CLIENT_ID;
diff --git a/test/test_services/tfm_core_test_2/tfm_ss_core_test_2.h b/test/test_services/tfm_core_test_2/tfm_ss_core_test_2.h
index 96cc17d..44b12df 100644
--- a/test/test_services/tfm_core_test_2/tfm_ss_core_test_2.h
+++ b/test/test_services/tfm_core_test_2/tfm_ss_core_test_2.h
@@ -74,7 +74,9 @@
* \return Returns \ref TFM_SUCCESS on success, \ref CORE_TEST_ERRNO_TEST_FAULT
* othervise.
*/
-psa_status_t spm_core_test_2_check_caller_client_id(void);
+ psa_status_t spm_core_test_2_check_caller_client_id(
+ struct psa_invec *in_vec, size_t in_len, struct psa_outvec *out_vec,
+ size_t out_len);
#ifdef __cplusplus
}