forked from auracaster/openocd
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
This commit is contained in:
@@ -117,7 +117,7 @@ static int dsp5680xx_drscan(struct target *target, uint8_t *d_in,
|
||||
* @param target
|
||||
* @param d_in This is the data that will be shifted into the JTAG IR reg.
|
||||
* @param d_out The data that will be shifted out of the JTAG IR reg will be stored here.
|
||||
* @apram ir_len Length of the data to be shifted to JTAG IR.
|
||||
* @param ir_len Length of the data to be shifted to JTAG IR.
|
||||
*
|
||||
*/
|
||||
static int dsp5680xx_irscan(struct target *target, uint32_t *d_in,
|
||||
@@ -1070,8 +1070,8 @@ static int dsp5680xx_resume(struct target *target, int current,
|
||||
}
|
||||
|
||||
/**
|
||||
* The value of @address determines if it corresponds to P: (program) or X: (dat) memory.
|
||||
* If the address is over 0x200000 then it is considered X: memory, and @pmem = 0.
|
||||
* The value of @a address determines if it corresponds to P: (program) or X: (dat) memory.
|
||||
* If the address is over 0x200000 then it is considered X: memory, and @a pmem = 0.
|
||||
* The special case of 0xFFXXXX is not modified, since it allows to read out the
|
||||
* memory mapped EOnCE registers.
|
||||
*
|
||||
@@ -1405,8 +1405,8 @@ static int dsp5680xx_write_32(struct target *t, uint32_t a, uint32_t c,
|
||||
}
|
||||
|
||||
/**
|
||||
* Writes @buffer to memory.
|
||||
* The parameter @address determines whether @buffer should be written to
|
||||
* Writes @a buffer to memory.
|
||||
* The parameter @a address determines whether @a buffer should be written to
|
||||
* P: (program) memory or X: (dat) memory.
|
||||
*
|
||||
* @param target
|
||||
@@ -1506,8 +1506,8 @@ static int dsp5680xx_checksum_memory(struct target *t, target_addr_t a, uint32_t
|
||||
}
|
||||
|
||||
/**
|
||||
* Calculates a signature over @word_count words in the data from @buff16.
|
||||
* The algorithm used is the same the FM uses, so the @return may be used to compare
|
||||
* Calculates a signature over @a word_count words in the data from @a buff16.
|
||||
* The algorithm used is the same the FM uses, so the @a return may be used to compare
|
||||
* with the one generated by the FM module, and check if flashing was successful.
|
||||
* This algorithm is based on the perl script available from the Freescale website at FAQ 25630.
|
||||
*
|
||||
@@ -1606,14 +1606,14 @@ int dsp5680xx_f_protect_check(struct target *target, uint16_t *protected)
|
||||
|
||||
/**
|
||||
* Executes a command on the FM module.
|
||||
* Some commands use the parameters @address and @data, others ignore them.
|
||||
* Some commands use the parameters @a address and @a data, others ignore them.
|
||||
*
|
||||
* @param target
|
||||
* @param command Command to execute.
|
||||
* @param address Command parameter.
|
||||
* @param data Command parameter.
|
||||
* @param hfm_ustat FM status register.
|
||||
* @param pmem Address is P: (program) memory (@pmem == 1) or X: (dat) memory (@pmem == 0)
|
||||
* @param pmem Address is P: (program) memory (@a pmem == 1) or X: (dat) memory (@a pmem == 0)
|
||||
*
|
||||
* @return
|
||||
*/
|
||||
@@ -1787,9 +1787,9 @@ static int set_fm_ck_div(struct target *target)
|
||||
|
||||
/**
|
||||
* Executes the FM calculate signature command. The FM will calculate over the
|
||||
* data from @address to @address + @words -1. The result is written to a
|
||||
* register, then read out by this function and returned in @signature. The
|
||||
* value @signature may be compared to the one returned by perl_crc to
|
||||
* data from @a address to @a address + @a words -1. The result is written to a
|
||||
* register, then read out by this function and returned in @a signature. The
|
||||
* value @a signature may be compared to the one returned by perl_crc to
|
||||
* verify the flash was written correctly.
|
||||
*
|
||||
* @param target
|
||||
|
||||
Reference in New Issue
Block a user