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/rtt/rtt.h | |
| 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/rtt/rtt.h')
| -rw-r--r-- | src/rtt/rtt.h | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/src/rtt/rtt.h b/src/rtt/rtt.h index 597c838..bc21bd0 100644 --- a/src/rtt/rtt.h +++ b/src/rtt/rtt.h @@ -237,7 +237,7 @@ const struct rtt_control *rtt_get_control(void); * Read channel information. * * @param[in] channel_index Channel index. - * @param[in] channel_type Channel type. + * @param[in] type Channel type. * @param[out] info Channel information. * * @returns ERROR_OK on success, an error code on failure. |