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/secure_fw/spm/spm_db_setup.h b/secure_fw/spm/spm_db_setup.h
index e1c53d2..f4102cf1 100644
--- a/secure_fw/spm/spm_db_setup.h
+++ b/secure_fw/spm/spm_db_setup.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
*
@@ -17,10 +17,10 @@
* Gets the index of a partition in the partition db based on the partition ID
* provided as a parameter.
*
- * \param[in] partition_id The ID of the partition
+ * \param[in] partition_idx The index of the partition
*
- * \return \ref INVALID_PARTITION_IDX if the provided ID is invalid. The index
- * of the partition otherwise.
+ * \return \ref INVALID_PARTITION_IDX if the provided index is invalid. The
+ * index of the partition otherwise.
*/
uint32_t get_partition_idx(uint32_t partition_id);