Skip to content

Commit 6c061b7

Browse files
committed
Fix several Doxygen documentation entries in source files
Fixes several warning by removing occourences of the unrecocognisied `@end` directive, and typos in direcive names. Adds missing parameters. Signed-off-by: Winford <winford@object.stream>
1 parent 1f06efc commit 6c061b7

File tree

5 files changed

+4
-5
lines changed

5 files changed

+4
-5
lines changed

src/libAtomVM/memory.h

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -339,6 +339,7 @@ static inline void memory_heap_append_heap(Heap *target, Heap *source)
339339
* the copy of a term to or from a process mailbox.
340340
* @param mso_list the list of mark-sweep object in a heap "space"
341341
* @param global the global context
342+
* @param from_task boolean, true if called from a task, false otherwise
342343
*/
343344
void memory_sweep_mso_list(term mso_list, GlobalContext *global, bool from_task);
344345

src/libAtomVM/module.h

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -149,10 +149,11 @@ enum ModuleLoadResult
149149

150150
#ifdef ENABLE_ADVANCED_TRACE
151151
/**
152-
* @briefs Gets imported function module and name
152+
* @brief Gets imported function module and name
153153
*
154154
* @details Gets imported function module and name given its import table index.
155155
* @param this_module the module on which the function will be searched.
156+
* @param index the modules import table offset to begin searching.
156157
* @param module_atom module name atom string.
157158
* @param function_atom function name atom string.
158159
*/
@@ -207,7 +208,7 @@ static inline size_t module_get_exported_functions_list_size(Module *this_module
207208
term module_get_exported_functions(Module *this_module, Heap *heap, GlobalContext *global);
208209

209210
/***
210-
* @brief Destoys an existing Module
211+
* @brief Destroys an existing Module
211212
*
212213
* @details Destroys a module and free Module resources.
213214
* @param module the module that will be freed.

src/libAtomVM/otp_net.c

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,6 @@ static term eai_errno_to_term(int err, GlobalContext *glb)
110110
* @param heap the heap to create terms in, should have sufficient free space
111111
* @details This function is called in a loop to create optimized maps that
112112
* share keys.
113-
* @end
114113
*/
115114
static term make_getaddrinfo_result(term *keys, int ai_protocol, int ai_socktype, term inner_addr, GlobalContext *global, Heap *heap)
116115
{

src/libAtomVM/otp_socket.c

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -442,7 +442,6 @@ static inline int get_protocol(GlobalContext *global, term protocol_term, bool *
442442
* @details This function is meant to be called from a nif that should return
443443
* its result directly, to allow for further processing of a possible out of
444444
* memory exception.
445-
* @end
446445
*/
447446
static inline term make_error_tuple(term reason, Context *ctx)
448447
{

src/libAtomVM/otp_socket.h

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,6 @@ struct LWIPEvent
151151
* so platforms using a queue need a global variable.
152152
* If lwIP callbacks are not called from ISR, calling handler with the event is
153153
* sufficient.
154-
* @end
155154
*/
156155
void otp_socket_lwip_enqueue(struct LWIPEvent *event);
157156

0 commit comments

Comments
 (0)