remove obsolete doxygen comments
authorZachary T Welch <zw@superlucidity.net>
Wed, 11 Nov 2009 11:19:29 +0000 (03:19 -0800)
committerZachary T Welch <zw@superlucidity.net>
Wed, 11 Nov 2009 19:53:22 +0000 (11:53 -0800)
Documenting command handler parameters is redundant and pointless.

src/flash/flash.h
src/flash/lpc2900.c

index 648bd73..7f5875e 100644 (file)
@@ -102,12 +102,6 @@ typedef struct flash_driver_s
         * layer when this routine is called, and the driver can store
         * additional information in its flash_bank_t::driver_priv field.
         *
-        * @param cmd_ctx - the command context
-        * @param cmd     - the command, in this case 'flash'
-        * @param args    - parameters, see below
-        * @param argc    - number of parameters on command line
-        * @param bank    - new filled in flash bank.
-        *
         * The args are: @par
         * @code
         * args[0] = bank
index 251f682..379b4e8 100644 (file)
@@ -530,11 +530,6 @@ static uint32_t lpc2900_calc_tr( uint32_t clock, uint32_t time )
  *
  * Uses the Built-In-Self-Test (BIST) to generate a 128-bit hash value
  * of the flash content.
- *
- * @param cmd_ctx
- * @param cmd
- * @param args
- * @param argc
  */
 static int lpc2900_handle_signature_command( struct command_context_s *cmd_ctx,
                                              char *cmd, char **args, int argc )
@@ -586,11 +581,6 @@ static int lpc2900_handle_signature_command( struct command_context_s *cmd_ctx,
  *
  * Read customer info from index sector, and store that block of data into
  * a disk file. The format is binary.
- *
- * @param cmd_ctx
- * @param cmd
- * @param args
- * @param argc
  */
 static int lpc2900_handle_read_custom_command( struct command_context_s *cmd_ctx,
                                                char *cmd, char **args, int argc )
@@ -663,11 +653,6 @@ static int lpc2900_handle_read_custom_command( struct command_context_s *cmd_ctx
 
 /**
  * Enter password to enable potentially dangerous options.
- *
- * @param cmd_ctx
- * @param cmd
- * @param args
- * @param argc
  */
 static int lpc2900_handle_password_command(struct command_context_s *cmd_ctx,
                                            char *cmd, char **args, int argc)
@@ -704,11 +689,6 @@ static int lpc2900_handle_password_command(struct command_context_s *cmd_ctx,
 
 /**
  * Write customer info from file to the index sector.
- *
- * @param cmd_ctx
- * @param cmd
- * @param args
- * @param argc
  */
 static int lpc2900_handle_write_custom_command( struct command_context_s *cmd_ctx,
                                                 char *cmd, char **args, int argc )
@@ -820,11 +800,6 @@ static int lpc2900_handle_write_custom_command( struct command_context_s *cmd_ct
 
 /**
  * Activate 'sector security' for a range of sectors.
- *
- * @param cmd_ctx
- * @param cmd
- * @param args
- * @param argc
  */
 static int lpc2900_handle_secure_sector_command(struct command_context_s *cmd_ctx,
                                                 char *cmd, char **args, int argc)
@@ -925,11 +900,6 @@ static int lpc2900_handle_secure_sector_command(struct command_context_s *cmd_ct
 
 /**
  * Activate JTAG protection.
- *
- * @param cmd_ctx
- * @param cmd
- * @param args
- * @param argc
  */
 static int lpc2900_handle_secure_jtag_command(struct command_context_s *cmd_ctx,
                                               char *cmd, char **args, int argc)
@@ -987,8 +957,6 @@ static int lpc2900_handle_secure_jtag_command(struct command_context_s *cmd_ctx,
 
 /**
  * Register private command handlers.
- *
- * @param cmd_ctx
  */
 static int lpc2900_register_commands(struct command_context_s *cmd_ctx)
 {
@@ -1053,17 +1021,7 @@ static int lpc2900_register_commands(struct command_context_s *cmd_ctx)
 }
 
 
-/**
- * Evaluate flash bank command.
- *
- * Syntax: flash bank lpc2900 0 0 0 0 target# system_base_clock
- *
- * @param cmd_ctx
- * @param cmd
- * @param args
- * @param argc
- * @param bank Pointer to the flash bank descriptor
- */
+/// Evaluate flash bank command.
 static int lpc2900_flash_bank_command(struct command_context_s *cmd_ctx,
                                       char *cmd, char **args, int argc,
                                       struct flash_bank_s *bank)