]> git.gag.com Git - fw/openocd/commit
openocd: fix doxygen parameters of functions
authorAntonio Borneo <borneo.antonio@gmail.com>
Sat, 2 Jan 2021 19:35:09 +0000 (20:35 +0100)
committerAntonio Borneo <borneo.antonio@gmail.com>
Wed, 13 Jan 2021 11:33:53 +0000 (11:33 +0000)
commit7e64e5a895ecd9bf25c5d2b39ff3119dafa30489
treeb1cb98a5c984c124501b8e9bd1983da082d79a05
parent4cf5ab614bd830355065bb9400acf5484dc3f2c3
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
18 files changed:
src/flash/nand/at91sam9.c
src/flash/nor/at91sam4.c
src/flash/nor/core.h
src/flash/nor/lpc2900.c
src/flash/nor/psoc6.c
src/jtag/drivers/OpenULINK/src/jtag.c
src/jtag/drivers/ftdi.c
src/jtag/drivers/jtag_vpi.c
src/jtag/drivers/ulink.c
src/jtag/drivers/usb_blaster/usb_blaster.c
src/rtt/rtt.h
src/target/arc.c
src/target/arc_jtag.c
src/target/arm_adi_v5.c
src/target/dsp5680xx.c
src/target/riscv/riscv-013.c
src/target/semihosting_common.c
src/target/target.c