openocd: fix doxygen parameters of functions
Add to doxygen comment the missing parameters. Remove from doxygen comment any non-existing parameter. Fix the parameter names in doxygen comment to match the one in the function prototype. Where the parameter name in the doxygen description seems better than the one in the code, change the code. Escape the character '<' to prevent doxygen to interpret it as an xml tag. Change-Id: I22da723339ac7d7a7a64ac4c1cc4336e2416c2cc Signed-off-by: Antonio Borneo <borneo.antonio@gmail.com> Reviewed-on: http://openocd.zylin.com/6002 Tested-by: jenkins
This commit is contained in:
@@ -450,7 +450,7 @@ static int mem_ap_write(struct adiv5_ap *ap, const uint8_t *buffer, uint32_t siz
|
||||
* @param buffer The data buffer to receive the data. No particular alignment is assumed.
|
||||
* @param size Which access size to use, in bytes. 1, 2 or 4.
|
||||
* @param count The number of reads to do (in size units, not bytes).
|
||||
* @param address Address to be read; it must be readable by the currently selected MEM-AP.
|
||||
* @param adr Address to be read; it must be readable by the currently selected MEM-AP.
|
||||
* @param addrinc Whether the target address should be increased after each read or not. This
|
||||
* should normally be true, except when reading from e.g. a FIFO.
|
||||
* @return ERROR_OK on success, otherwise an error code.
|
||||
|
||||
Reference in New Issue
Block a user