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/flash/nor | |
| 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/flash/nor')
| -rw-r--r-- | src/flash/nor/at91sam4.c | 3 | ||||
| -rw-r--r-- | src/flash/nor/core.h | 3 | ||||
| -rw-r--r-- | src/flash/nor/lpc2900.c | 4 | ||||
| -rw-r--r-- | src/flash/nor/psoc6.c | 1 |
4 files changed, 7 insertions, 4 deletions
diff --git a/src/flash/nor/at91sam4.c b/src/flash/nor/at91sam4.c index 86abf70..d4326e4 100644 --- a/src/flash/nor/at91sam4.c +++ b/src/flash/nor/at91sam4.c @@ -1709,6 +1709,9 @@ static int FLASHD_EraseEntireBank(struct sam4_bank_private *pPrivate) /** * Erases the entire flash. * @param pPrivate - the info about the bank. + * @param firstPage + * @param numPages + * @param status */ static int FLASHD_ErasePages(struct sam4_bank_private *pPrivate, int firstPage, diff --git a/src/flash/nor/core.h b/src/flash/nor/core.h index 107a1c5..97a368e 100644 --- a/src/flash/nor/core.h +++ b/src/flash/nor/core.h @@ -276,7 +276,8 @@ struct flash_bank *get_flash_bank_by_num_noprobe(unsigned int num); * @param target The target, presumed to contain one or more banks. * @param addr An address that is within the range of the bank. * @param check return ERROR_OK and result_bank NULL if the bank does not exist - * @returns The struct flash_bank located at @a addr, or NULL. + * @param result_bank The struct flash_bank located at @a addr, or NULL. + * @returns ERROR_OK on success, or an error indicating the problem. */ int get_flash_bank_by_addr(struct target *target, target_addr_t addr, bool check, struct flash_bank **result_bank); 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) { diff --git a/src/flash/nor/psoc6.c b/src/flash/nor/psoc6.c index 931404e..9c834fd 100644 --- a/src/flash/nor/psoc6.c +++ b/src/flash/nor/psoc6.c @@ -873,7 +873,6 @@ exit: /** *********************************************************************************************** * @brief Performs Mass Erase operation - * @param bank flash bank index to erase * @return ERROR_OK in case of success, ERROR_XXX code otherwise *************************************************************************************************/ COMMAND_HANDLER(psoc6_handle_mass_erase_command) |