update doxygen configuration to produce a PDF

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

diff --git a/src/flash/flash.h b/src/flash/flash.h
index 4651fc3664175cf4fb067f990d39990920e014b2..23a7b81839c0707f0f4f1edeeefb8712d59d1400 100644 (file)
--- a/src/flash/flash.h
+++ b/src/flash/flash.h
@@ -105,21 +105,21 @@ struct flash_driver
         * layer when this routine is called, and the driver can store
         * additional information in its struct flash_bank::driver_priv field.
         *
-        * The args are: @par
+        * The CMD_ARGV are: @par
         * @code
-        * args[0] = bank
-        * args[1] = drivername {name above}
-        * args[2] = baseaddress
-        * args[3] = lengthbytes
-        * args[4] = chip_width_in bytes
-        * args[5] = bus_width_bytes
-        * args[6] = driver-specific parameters
+        * CMD_ARGV[0] = bank
+        * CMD_ARGV[1] = drivername {name above}
+        * CMD_ARGV[2] = baseaddress
+        * CMD_ARGV[3] = lengthbytes
+        * CMD_ARGV[4] = chip_width_in bytes
+        * CMD_ARGV[5] = bus_width_bytes
+        * CMD_ARGV[6] = driver-specific parameters
         * @endcode
         *
-        * For example, args[4] = 16 bit flash, args[5] = 32bit bus.
+        * For example, CMD_ARGV[4] = 16 bit flash, CMD_ARGV[5] = 32bit bus.
         *
-        * If extra arguments are provided (@a argc > 6), they will
-        * start in @a args[6].  These can be used to implement
+        * If extra arguments are provided (@a CMD_ARGC > 6), they will
+        * start in @a CMD_ARGV[6].  These can be used to implement
         * driver-specific extensions.
         *
         * @returns ERROR_OK if successful; otherwise, an error code.
@@ -318,13 +318,13 @@ struct flash_bank *get_flash_bank_by_num(int num);
 /**
  * Retreives @a bank from a command argument, reporting errors parsing
  * the bank identifier or retreiving the specified bank.
- * @param cmd_ctx The command context for reporting errors.
- * @param str The string containing the bank identifier.
+ * @param name_index The index to the string in args containing the
+ * bank identifier.
  * @param bank On output, contians a pointer to the bank or NULL.
  * @returns ERROR_OK on success, or an error indicating the problem.
  */
-int flash_command_get_bank_by_num(struct command_context *cmd_ctx,
-               const char *str, struct flash_bank **bank);
+COMMAND_HELPER(flash_command_get_bank_by_num, unsigned name_index,
+               struct flash_bank **bank);
 /**
  * Returns the flash bank like get_flash_bank_by_num(), without probing.
  * @param num The flash bank number.