Skip to content

Commit 033b85e

Browse files
UncleGrumpyUncleGrumpy
committed
Documentation updates for feature/smp branch
Udates the API doc generators to include new functions in the `feature/smp` branch and removes documentaton for fuctions from `master` that are not part of the `feature/smp` code base. Minor typo corrections in doxgen comments of varios source files. Signed-off-by: Winford <[email protected]>
1 parent 66dcbae commit 033b85e

File tree

6 files changed

+181
-30
lines changed

6 files changed

+181
-30
lines changed

‎doc/src/apidocs/libatomvm/data_structures.rst‎

Lines changed: 31 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,41 @@ Data Strucures
99
:maxdepth: 3
1010
:caption: Structs
1111

12+
.. doxygenstruct:: AtomsHashTable
1213
.. doxygenstruct:: AtomStringIntPair
13-
1414
.. doxygenstruct:: CContext
15+
.. doxygenstruct:: Heap
16+
.. doxygenstruct:: HeapFragment
17+
.. doxygenstruct:: HNode
18+
.. doxygenstruct:: IFFRecord
19+
.. doxygenstruct:: LineRefOffset
20+
.. doxygenstruct:: Mailbox
21+
.. doxygenstruct:: MailboxMessage
22+
.. doxygenstruct:: Message
23+
.. doxygenstruct:: RegisteredProcess
24+
.. doxygenstruct:: RefcBinary
25+
.. doxygenstruct:: RefSignal
26+
.. doxygenstruct:: SpinLock
27+
.. doxygenstruct:: TimerList
28+
.. doxygenstruct:: ValuesHashTable
1529

1630
.. toctree::
1731
:maxdepth: 3
1832
:caption: Enums
1933

20-
.. doxygenenum::
34+
.. doxygenenum:: BitstringFlags
35+
.. doxygenenum:: ContextFlags
36+
.. doxygenenum:: DictionaryFunctionResult
37+
.. doxygenenum:: ExternalTermOpts
38+
.. doxygenenum:: ExternalTermResult
39+
.. doxygenenum:: FunctionType
40+
.. doxygenenum:: InteropFunctionResult
41+
.. doxygenenum:: MemoryAllocMode
42+
.. doxygenenum:: MemoryGCResult
43+
.. doxygenenum:: MessageType
44+
.. doxygenenum:: ModuleLoadResult
45+
.. doxygenenum:: NativeHandlerResult
46+
.. doxygenenum:: RefcBinaryFlags
47+
.. doxygenenum:: TempStackResult
48+
.. doxygenenum:: TermCompareOpts
49+
.. doxygenenum:: TermCompareResult

‎doc/src/apidocs/libatomvm/functions.rst‎

Lines changed: 104 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -12,63 +12,156 @@ Functions
1212
.. doxygenfunction:: atom_are_equals
1313
.. doxygenfunction:: atom_string_to_c
1414
.. doxygenfunction:: atom_write_mfa
15+
.. doxygenfunction:: atomshashtable_get_value
16+
.. doxygenfunction:: atomshashtable_has_key
17+
.. doxygenfunction:: atomshashtable_insert
1518
.. doxygenfunction:: avmpack_find_section_by_flag
1619
.. doxygenfunction:: avmpack_find_section_by_name
1720
.. doxygenfunction:: avmpack_fold
1821
.. doxygenfunction:: avmpack_is_valid
22+
.. doxygenfunction:: bitstring_utf16_decode
23+
.. doxygenfunction:: bitstring_utf16_encode
24+
.. doxygenfunction:: bitstring_utf32_decode
25+
.. doxygenfunction:: bitstring_utf32_encode
26+
.. doxygenfunction:: bitstring_utf8_decode
27+
.. doxygenfunction:: bitstring_utf8_encode
28+
.. doxygenfunction:: context_demonitor
1929
.. doxygenfunction:: context_destroy
2030
.. doxygenfunction:: context_execute_loop
31+
.. doxygenfunction:: context_get_process_info
2132
.. doxygenfunction:: context_message_queue_len
33+
.. doxygenfunction:: context_monitor
2234
.. doxygenfunction:: context_new
35+
.. doxygenfunction:: context_process_flush_monitor_signal
36+
.. doxygenfunction:: context_process_kill_signal
37+
.. doxygenfunction:: context_process_process_info_request_signal
38+
.. doxygenfunction:: context_process_signal_trap_answer
2339
.. doxygenfunction:: context_size
40+
.. doxygenfunction:: context_update_flags
2441
.. doxygenfunction:: debug_dump_context
2542
.. doxygenfunction:: debug_dump_heap
2643
.. doxygenfunction:: debug_dump_memory
2744
.. doxygenfunction:: debug_dump_registers
2845
.. doxygenfunction:: debug_dump_stack
2946
.. doxygenfunction:: debug_print_processes_list
47+
.. doxygenfunction:: dictionary_destroy
48+
.. doxygenfunction:: dictionary_erase
49+
.. doxygenfunction:: dictionary_get
50+
.. doxygenfunction:: dictionary_put
3051
.. doxygenfunction:: externalterm_from_binary
3152
.. doxygenfunction:: externalterm_to_binary
3253
.. doxygenfunction:: externalterm_to_term
3354
.. doxygenfunction:: globalcontext_atomstring_from_term
55+
.. doxygenfunction:: globalcontext_demonitor
3456
.. doxygenfunction:: globalcontext_destroy
3557
.. doxygenfunction:: globalcontext_existing_term_from_atom_string
3658
.. doxygenfunction:: globalcontext_get_module
37-
.. doxygenfunction:: globalcontext_get_new_process_id
38-
.. doxygenfunction:: globalcontext_get_process
59+
.. doxygenfunction:: globalcontext_get_module_by_index
60+
.. doxygenfunction:: globalcontext_get_process_lock
61+
.. doxygenfunction:: globalcontext_get_process_unlock
3962
.. doxygenfunction:: globalcontext_get_registered_process
63+
.. doxygenfunction:: globalcontext_init_process
4064
.. doxygenfunction:: globalcontext_insert_atom
4165
.. doxygenfunction:: globalcontext_insert_atom_maybe_copy
4266
.. doxygenfunction:: globalcontext_insert_module
4367
.. doxygenfunction:: globalcontext_is_atom_index_equal_to_atom_string
4468
.. doxygenfunction:: globalcontext_new
69+
.. doxygenfunction:: globalcontext_process_exists
4570
.. doxygenfunction:: globalcontext_register_process
71+
.. doxygenfunction:: globalcontext_send_message
72+
.. doxygenfunction:: globalcontext_send_message_nolock
73+
.. doxygenfunction:: globalcontext_unlink
4674
.. doxygenfunction:: globalcontext_unregister_process
4775
.. doxygenfunction:: iff_is_valid_beam
48-
.. doxygenfunction:: mailbox_dequeue
49-
.. doxygenfunction:: mailbox_destroy_message
76+
.. doxygenfunction:: interop_atom_term_select_int
77+
.. doxygenfunction:: interop_kv_get_value_default
78+
.. doxygenfunction:: mailbox_crashdump
79+
.. doxygenfunction:: mailbox_destroy
80+
.. doxygenfunction:: mailbox_first
81+
.. doxygenfunction:: mailbox_init
82+
.. doxygenfunction:: mailbox_len
83+
.. doxygenfunction:: mailbox_message_dispose
84+
.. doxygenfunction:: mailbox_message_to_heap_fragment
85+
.. doxygenfunction:: mailbox_next
5086
.. doxygenfunction:: mailbox_peek
51-
.. doxygenfunction:: mailbox_receive
52-
.. doxygenfunction:: mailbox_remove
87+
.. doxygenfunction:: mailbox_process_outer_list
88+
.. doxygenfunction:: mailbox_remove_message
89+
.. doxygenfunction:: mailbox_reset
5390
.. doxygenfunction:: mailbox_send
91+
.. doxygenfunction:: mailbox_send_built_in_atom_request_signal
92+
.. doxygenfunction:: mailbox_send_built_in_atom_signal
93+
.. doxygenfunction:: mailbox_send_empty_body_signal
94+
.. doxygenfunction:: mailbox_send_ref_signal
95+
.. doxygenfunction:: mailbox_send_term_signal
96+
.. doxygenfunction:: mailbox_size
97+
.. doxygenfunction:: memory_copy_term_tree
98+
.. doxygenfunction:: memory_copy_term_tree_to_storage
99+
.. doxygenfunction:: memory_ensure_free_with_roots
100+
.. doxygenfunction:: memory_estimate_usage
101+
.. doxygenfunction:: memory_heap_append_fragment
102+
.. doxygenfunction:: memory_init_heap
103+
.. doxygenfunction:: memory_init_heap_root_fragment
104+
.. doxygenfunction:: memory_sweep_mso_list
54105
.. doxygenfunction:: module_load_literal
55106
.. doxygenfunction:: module_new_from_iff_binary
56107
.. doxygenfunction:: module_resolve_function
57108
.. doxygenfunction:: module_search_exported_function
109+
.. doxygenfunction:: platform_nifs_get_nif
110+
.. doxygenfunction:: port_ensure_available
111+
.. doxygenfunction:: port_heap_create_error_tuple
112+
.. doxygenfunction:: port_heap_create_ok_tuple
113+
.. doxygenfunction:: port_heap_create_reply
114+
.. doxygenfunction:: port_heap_create_sys_error_tuple
115+
.. doxygenfunction:: port_heap_create_tuple2
116+
.. doxygenfunction:: port_heap_create_tuple3
117+
.. doxygenfunction:: port_heap_create_tuple_n
118+
.. doxygenfunction:: port_is_standard_port_command
119+
.. doxygenfunction:: port_send_message
120+
.. doxygenfunction:: port_send_message_nolock
121+
.. doxygenfunction:: refc_binary_create_binary_info
122+
.. doxygenfunction:: refc_binary_create_refc
123+
.. doxygenfunction:: refc_binary_decrement_refcount
124+
.. doxygenfunction:: refc_binary_get_data
125+
.. doxygenfunction:: refc_binary_increment_refcount
126+
.. doxygenfunction:: refc_binary_total_size
58127
.. doxygenfunction:: reg_type_c
59128
.. doxygenfunction:: scan_iff
60-
.. doxygenfunction:: scheduler_make_ready
61-
.. doxygenfunction:: scheduler_make_waiting
129+
.. doxygenfunction:: scheduler_cancel_timeout
130+
.. doxygenfunction:: scheduler_entry_point
131+
.. doxygenfunction:: scheduler_init_ready
132+
.. doxygenfunction:: scheduler_kill
62133
.. doxygenfunction:: scheduler_next
134+
.. doxygenfunction:: scheduler_run
63135
.. doxygenfunction:: scheduler_set_timeout
136+
.. doxygenfunction:: scheduler_signal_message
137+
.. doxygenfunction:: scheduler_stop_all
64138
.. doxygenfunction:: scheduler_terminate
65139
.. doxygenfunction:: scheduler_wait
66-
.. doxygenfunction:: schudule_processes_count
67-
.. doxygenfunction:: sys_consume_pending_events
140+
.. doxygenfunction:: smp_condvar_create
141+
.. doxygenfunction:: smp_condvar_destroy
142+
.. doxygenfunction:: smp_condvar_signal
143+
.. doxygenfunction:: smp_condvar_wait
144+
.. doxygenfunction:: smp_get_online_processors
145+
.. doxygenfunction:: smp_is_main_thread
146+
.. doxygenfunction:: smp_mutex_create
147+
.. doxygenfunction:: smp_mutex_destroy
148+
.. doxygenfunction:: smp_mutex_lock
149+
.. doxygenfunction:: smp_mutex_trylock
150+
.. doxygenfunction:: smp_mutex_unlock
151+
.. doxygenfunction:: smp_rwlock_create
152+
.. doxygenfunction:: smp_rwlock_destroy
153+
.. doxygenfunction:: smp_rwlock_rdlock
154+
.. doxygenfunction:: smp_rwlock_unlock
155+
.. doxygenfunction:: smp_rwlock_wrlock
156+
.. doxygenfunction:: smp_scheduler_start
68157
.. doxygenfunction:: sys_create_port
158+
.. doxygenfunction:: sys_free_platform
69159
.. doxygenfunction:: sys_get_info
160+
.. doxygenfunction:: sys_init_platform
70161
.. doxygenfunction:: sys_load_module
71162
.. doxygenfunction:: sys_monotonic_time
163+
.. doxygenfunction:: sys_poll_events
164+
.. doxygenfunction:: sys_signal
72165
.. doxygenfunction:: sys_time
73166
.. doxygenfunction:: term_alloc_refc_binary
74167
.. doxygenfunction:: term_alloc_sub_binary
@@ -77,3 +170,4 @@ Functions
77170
.. doxygenfunction:: term_fprint
78171
.. doxygenfunction:: term_funprint
79172
.. doxygenfunction:: term_snprint
173+
.. doxygenfunction:: timer_list_next

‎doc/src/apidocs/libatomvm/macros.rst‎

Lines changed: 23 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -11,29 +11,39 @@ MACROS
1111
.. doxygendefine:: AT8U
1212

1313
.. doxygendefine:: ATOM_STR
14-
14+
.. doxygendefine:: BEGIN_WITH_STACK_HEAP
15+
.. doxygendefine:: END_WITH_STACK_HEAP
1516
.. doxygendefine:: CODE
16-
17+
.. doxygendefine:: CONTAINER_OF
1718
.. doxygendefine:: EXPT
18-
1919
.. doxygendefine:: FUNT
20-
2120
.. doxygendefine:: GET_LIST_ENTRY
22-
2321
.. doxygendefine:: IFF_SECTION_HEADER_SIZE
24-
2522
.. doxygendefine:: IMPT
26-
2723
.. doxygendefine:: LINT
28-
24+
.. doxygendefine:: LIST_FOR_EACH
2925
.. doxygendefine:: LITT
30-
3126
.. doxygendefine:: LITU
32-
3327
.. doxygendefine:: LOCT
34-
3528
.. doxygendefine:: MAX_OFFS
36-
3729
.. doxygendefine:: MAX_SIZES
38-
30+
.. doxygendefine:: MUTABLE_LIST_FOR_EACH
31+
.. doxygendefine:: PROCESS_MAYBE_TRAP_RETURN_VALUE
32+
.. doxygendefine:: PROCESS_MAYBE_TRAP_RETURN_VALUE_LAST
33+
.. doxygendefine:: PROCESS_MAYBE_TRAP_RETURN_VALUE_RESTORE_I
34+
.. doxygendefine:: RAISE_ERROR
35+
.. doxygendefine:: READ_16_UNALIGNED
36+
.. doxygendefine:: READ_32_ALIGNED
37+
.. doxygendefine:: READ_32_UNALIGNED
38+
.. doxygendefine:: SCHEDULE_NEXT
39+
.. doxygendefine:: SET_ERROR
3940
.. doxygendefine:: STRT
41+
.. doxygendefine:: SWAP_KV_PAIR
42+
.. doxygendefine:: VALIDATE_VALUE
43+
.. doxygendefine:: VERIFY_IS_ANY_INTEGER
44+
.. doxygendefine:: VERIFY_IS_BINARY
45+
.. doxygendefine:: VERIFY_IS_INTEGER
46+
.. doxygendefine:: VERIFY_IS_MATCH_OR_BINARY
47+
.. doxygendefine:: VERIFY_IS_MATCH_STATE
48+
.. doxygendefine:: WRITE_16_UNALIGNED
49+
.. doxygendefine:: WRITE_32_UNALIGNED

‎doc/src/apidocs/libatomvm/types.rst‎

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,27 @@ Types
99
:maxdepth: 3
1010
:caption: Types
1111

12+
.. doxygentypedef:: AtomString
13+
.. doxygentypedef:: avm_float_t
14+
.. doxygentypedef:: avm_int64_t
15+
.. doxygentypedef:: avm_int_t
16+
.. doxygentypedef:: avm_uint64_t
17+
.. doxygentypedef:: avm_uint_t
1218
.. doxygentypedef:: avmpack_fold_fun
13-
1419
.. doxygentypedef:: CContext
15-
20+
.. doxygentypedef:: CondVar
21+
.. doxygentypedef:: dreg_t
22+
.. doxygentypedef:: func_ptr_t
23+
.. doxygentypedef:: GlobalContext
24+
.. doxygentypedef:: Heap
25+
.. doxygentypedef:: HeapFragment
26+
.. doxygentypedef:: MailboxMessage
27+
.. doxygentypedef:: Message
28+
.. doxygentypedef:: Module
29+
.. doxygentypedef:: Mutex
30+
.. doxygentypedef:: native_handler_f
31+
.. doxygentypedef:: NativeHandlerResult
32+
.. doxygentypedef:: RWLock
33+
.. doxygentypedef:: SpinLock
1634
.. doxygentypedef:: term
17-
1835
.. doxygentypedef:: term_ref

‎src/libAtomVM/context.h‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -196,8 +196,9 @@ static inline void context_ensure_fpregs(Context *c)
196196
*
197197
* @details Start executing bytecode for the specified function, this function will block until it terminates. The outcome is saved to x[0] register.
198198
* @param ctx the context that will be used to run the specified functions, x registers must be set to function arguments.
199+
* @param mod the module name C string.
199200
* @param function_name the function name C string.
200-
* @param the function arity (number of arguments that are required).
201+
* @param arity the function arity (number of arguments that are required).
201202
* @returns 1 if an error occurred, otherwise 0 is always returned.
202203
*/
203204
int context_execute_loop(Context *ctx, Module *mod, const char *function_name, int arity);

‎src/libAtomVM/smp.h‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -225,7 +225,7 @@ int smp_get_online_processors();
225225
* global context.
226226
* @param glb the global context
227227
*/
228-
void smp_scheduler_start(GlobalContext *ctx);
228+
void smp_scheduler_start(GlobalContext *glb);
229229

230230
/**
231231
* @brief Determine if caller is in the main thread, i.e. thread that was not

0 commit comments

Comments
 (0)