Skip to content

Commit 75e5b65

Browse files
committed
[platform] Fix doxygen errors in mbed_mem_trace.h
1 parent dcbb6f6 commit 75e5b65

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

platform/mbed_mem_trace.h

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -80,15 +80,15 @@ void *mbed_mem_trace_malloc(void *res, size_t size, void *caller);
8080
* @param res the result of running 'realloc'.
8181
* @param ptr the 'ptr' argument given to 'realloc'.
8282
* @param size the 'size' argument given to 'realloc'.
83-
*
83+
* @param caller the caller of the memory operation.
8484
* @return 'res' (the first argument).
8585
*/
8686
void *mbed_mem_trace_realloc(void *res, void *ptr, size_t size, void *caller);
8787

8888
/**
8989
* Trace a call to 'calloc'.
9090
* @param res the result of running 'calloc'.
91-
* @param nmemb the 'nmemb' argument given to 'calloc'.
91+
* @param num the 'nmemb' argument given to 'calloc'.
9292
* @param size the 'size' argument given to 'calloc'.
9393
* @param caller the caller of the memory operation.
9494
* @return 'res' (the first argument).
@@ -108,13 +108,13 @@ void mbed_mem_trace_free(void *ptr, void *caller);
108108
*
109109
* The default callback outputs trace data using 'printf', in a format that's
110110
* easily parsable by an external tool. For each memory operation, the callback
111-
* outputs a line that begins with '#<op>:<0xresult>;<0xcaller>-':
111+
* outputs a line that begins with "#<op>:<0xresult>;<0xcaller>-":
112112
*
113113
* - 'op' identifies the memory operation ('m' for 'malloc', 'r' for 'realloc',
114114
* 'c' for 'calloc' and 'f' for 'free').
115115
* - 'result' (base 16) is the result of the memor operation. This is always NULL
116116
* for 'free', since 'free' doesn't return anything.
117-
* -'caller' (base 16) is the caller of the memory operation. Note that the value
117+
* - 'caller' (base 16) is the caller of the memory operation. Note that the value
118118
* of 'caller' might be unreliable.
119119
*
120120
* The rest of the output depends on the operation being traced:
@@ -126,9 +126,9 @@ void mbed_mem_trace_free(void *ptr, void *caller);
126126
*
127127
* Examples:
128128
*
129-
* - '#m:0x20003240;0x600d-50' encodes a 'malloc' that returned 0x20003240, was called
129+
* - "#m:0x20003240;0x600d-50" encodes a 'malloc' that returned 0x20003240, was called
130130
* by the instruction at 0x600D with a the 'size' argument equal to 50.
131-
* - '#f:0x0;0x602f-0x20003240' encodes a 'free' that was called by the instruction at
131+
* - "#f:0x0;0x602f-0x20003240" encodes a 'free' that was called by the instruction at
132132
* 0x602f with the 'ptr' argument equal to 0x20003240.
133133
*/
134134
void mbed_mem_trace_default_callback(uint8_t op, void *res, void *caller, ...);

0 commit comments

Comments
 (0)