aboutsummaryrefslogtreecommitdiff
path: root/src/flash/nor/lpc2900.c
diff options
context:
space:
mode:
authorAntonio Borneo <borneo.antonio@gmail.com>2021-01-02 20:35:09 +0100
committerAntonio Borneo <borneo.antonio@gmail.com>2021-01-13 11:33:53 +0000
commit7e64e5a895ecd9bf25c5d2b39ff3119dafa30489 (patch)
treeb1cb98a5c984c124501b8e9bd1983da082d79a05 /src/flash/nor/lpc2900.c
parent4cf5ab614bd830355065bb9400acf5484dc3f2c3 (diff)
downloadriscv-openocd-7e64e5a895ecd9bf25c5d2b39ff3119dafa30489.zip
riscv-openocd-7e64e5a895ecd9bf25c5d2b39ff3119dafa30489.tar.gz
riscv-openocd-7e64e5a895ecd9bf25c5d2b39ff3119dafa30489.tar.bz2
openocd: fix doxygen parameters of functions
Add to doxygen comment the missing parameters. Remove from doxygen comment any non-existing parameter. Fix the parameter names in doxygen comment to match the one in the function prototype. Where the parameter name in the doxygen description seems better than the one in the code, change the code. Escape the character '<' to prevent doxygen to interpret it as an xml tag. Change-Id: I22da723339ac7d7a7a64ac4c1cc4336e2416c2cc Signed-off-by: Antonio Borneo <borneo.antonio@gmail.com> Reviewed-on: http://openocd.zylin.com/6002 Tested-by: jenkins
Diffstat (limited to 'src/flash/nor/lpc2900.c')
-rw-r--r--src/flash/nor/lpc2900.c4
1 files changed, 2 insertions, 2 deletions
diff --git a/src/flash/nor/lpc2900.c b/src/flash/nor/lpc2900.c
index 6596cde..4d3d7f7 100644
--- a/src/flash/nor/lpc2900.c
+++ b/src/flash/nor/lpc2900.c
@@ -453,8 +453,8 @@ static int lpc2900_write_index_page(struct flash_bank *bank,
/**
* Calculate FPTR.TR register value for desired program/erase time.
*
- * @param clock System clock in Hz
- * @param time Program/erase time in µs
+ * @param clock_var System clock in Hz
+ * @param time_var Program/erase time in µs
*/
static uint32_t lpc2900_calc_tr(uint32_t clock_var, uint32_t time_var)
{