diff options
| author | Antonio Borneo <borneo.antonio@gmail.com> | 2021-01-02 20:35:09 +0100 |
|---|---|---|
| committer | Antonio Borneo <borneo.antonio@gmail.com> | 2021-01-13 11:33:53 +0000 |
| commit | 7e64e5a895ecd9bf25c5d2b39ff3119dafa30489 (patch) | |
| tree | b1cb98a5c984c124501b8e9bd1983da082d79a05 /src/target/riscv/riscv-013.c | |
| parent | 4cf5ab614bd830355065bb9400acf5484dc3f2c3 (diff) | |
| download | riscv-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/target/riscv/riscv-013.c')
| -rw-r--r-- | src/target/riscv/riscv-013.c | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/src/target/riscv/riscv-013.c b/src/target/riscv/riscv-013.c index 8558ba8..32a7f02 100644 --- a/src/target/riscv/riscv-013.c +++ b/src/target/riscv/riscv-013.c @@ -547,13 +547,15 @@ static dmi_status_t dmi_scan(struct target *target, uint32_t *address_in, } /** + * @param target * @param data_in The data we received from the target. - * @param dmi_op The operation to perform (read/write/nop). * @param dmi_busy_encountered * If non-NULL, will be updated to reflect whether DMI busy was * encountered while executing this operation or not. + * @param dmi_op The operation to perform (read/write/nop). * @param address The address argument to that operation. * @param data_out The data to send to the target. + * @param timeout_sec * @param exec When true, this scan will execute something, so extra RTI * cycles may be added. * @param ensure_success |