diff options
| author | Antonio Borneo <borneo.antonio@gmail.com> | 2021-01-02 18:17:20 +0100 |
|---|---|---|
| committer | Antonio Borneo <borneo.antonio@gmail.com> | 2021-01-13 11:33:16 +0000 |
| commit | 4cf5ab614bd830355065bb9400acf5484dc3f2c3 (patch) | |
| tree | 12b340fb20f5654cb492f222375ba1a2d5f70ec4 /src/flash | |
| parent | 02bd67db3f85b9764b6c4a3556d070a3345e4103 (diff) | |
| download | riscv-openocd-4cf5ab614bd830355065bb9400acf5484dc3f2c3.zip riscv-openocd-4cf5ab614bd830355065bb9400acf5484dc3f2c3.tar.gz riscv-openocd-4cf5ab614bd830355065bb9400acf5484dc3f2c3.tar.bz2 | |
openocd: fix incorrect doxygen comments
Use '@param' in front of function's parameters and '@a' when the
parameter is recalled in the description.
This fixes doxygen complains:
warning: Found unknown command '@buff16'
While there, fix a minor typo s/occured/occurred/ in a comment and
the typo s/@apram/@param/ in a doxygen comment.
Change-Id: I5cd86a80adef552331310a21c55ec5d11354be21
Signed-off-by: Antonio Borneo <borneo.antonio@gmail.com>
Reviewed-on: http://openocd.zylin.com/6001
Tested-by: jenkins
Diffstat (limited to 'src/flash')
| -rw-r--r-- | src/flash/nor/dsp5680xx_flash.c | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/src/flash/nor/dsp5680xx_flash.c b/src/flash/nor/dsp5680xx_flash.c index 6f1eccf..4902282 100644 --- a/src/flash/nor/dsp5680xx_flash.c +++ b/src/flash/nor/dsp5680xx_flash.c @@ -193,8 +193,8 @@ static int dsp5680xx_probe(struct flash_bank *bank) /** * The flash module (FM) on the dsp5680xx supports both individual sector * and mass erase of the flash memory. - * If this function is called with @first == @last == 0 or if @first is the - * first sector (#0) and @last is the last sector then the mass erase command + * If this function is called with @a first == @a last == 0 or if @a first is the + * first sector (#0) and @a last is the last sector then the mass erase command * is executed (much faster than erasing each sector individually). * * @param bank |