openocd: fix doxygen parameters of functions

[openocd.git] / src / flash / nor / core.h

diff --git a/src/flash/nor/core.h b/src/flash/nor/core.h
index 107a1c56e20182e7d26fc9d8fea54e7156935b36..97a368e8e812daf47b13ef1b042584d9508d778b 100644 (file)
--- 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);