Merge branch 'ofw_dev' into dev p1

furi/core/check.h

@@ -43,7 +43,7 @@ FURI_NORETURN void __furi_halt_implementation();
 
 /** Crash system
  *
- * @param      optional  message (const char*)
+ * @param      ... optional  message (const char*)
  */
 #define furi_crash(...) M_APPLY(__furi_crash, M_IF_EMPTY(__VA_ARGS__)((NULL), (__VA_ARGS__)))
 
@@ -57,7 +57,7 @@ FURI_NORETURN void __furi_halt_implementation();
 
 /** Halt system
  *
- * @param      optional  message (const char*)
+ * @param      ... optional  message (const char*)
  */
 #define furi_halt(...) M_APPLY(__furi_halt, M_IF_EMPTY(__VA_ARGS__)((NULL), (__VA_ARGS__)))
 
@@ -71,8 +71,7 @@ FURI_NORETURN void __furi_halt_implementation();
 
 /** Check condition and crash if failed
  *
- * @param      condition to check
- * @param      optional  message (const char*)
+ * @param      ... condition to check and optional  message (const char*)
  */
 #define furi_check(...) \
     M_APPLY(__furi_check, M_DEFAULT_ARGS(2, (__FURI_CHECK_MESSAGE_FLAG), __VA_ARGS__))
@@ -97,8 +96,7 @@ FURI_NORETURN void __furi_halt_implementation();
  *
  * @warning    only will do check if firmware compiled in debug mode
  *
- * @param      condition to check
- * @param      optional  message (const char*)
+ * @param      ... condition to check and optional  message (const char*)
  */
 #define furi_assert(...) \
     M_APPLY(__furi_assert, M_DEFAULT_ARGS(2, (__FURI_ASSERT_MESSAGE_FLAG), __VA_ARGS__))

furi/core/kernel.h

@@ -79,7 +79,7 @@ void furi_delay_tick(uint32_t ticks);
  *
  * @warning This should never be called in interrupt request context.
  *
- * @param[in]  ticks  The tick until which kerel should delay task execution
+ * @param[in]  tick  The tick until which kerel should delay task execution
  *
  * @return     The furi status.
  */

furi/core/log.h

@@ -51,7 +51,7 @@ void furi_log_init(void);
 
 /** Add log TX callback
  *
- * @param[in]  callback  The callback
+ * @param[in]  handler  The callback and its context
  *
  * @return     true on success, false otherwise
  */
@@ -59,7 +59,7 @@ bool furi_log_add_handler(FuriLogHandler handler);
 
 /** Remove log TX callback
  *
- * @param[in]  callback  The callback
+ * @param[in]  handler  The callback and its context
  *
  * @return     true on success, false otherwise
  */
@@ -112,15 +112,16 @@ FuriLogLevel furi_log_get_level(void);
 /** Log level to string
  *
  * @param[in]  level  The level
+ * @param[out] str    String representation of the level
  *
- * @return     The string
+ * @return     True if success, False otherwise
  */
 bool furi_log_level_to_string(FuriLogLevel level, const char** str);
 
 /** Log level from string
  *
  * @param[in]  str    The string
- * @param      level  The level
+ * @param[out] level  The level
  * 
  * @return     True if success, False otherwise
  */

furi/core/memmgr_heap.h

@@ -18,13 +18,13 @@ extern "C" {
  *
  * @param      thread_id  - thread id to track
  */
-void memmgr_heap_enable_thread_trace(FuriThreadId taks_handle);
+void memmgr_heap_enable_thread_trace(FuriThreadId thread_id);
 
 /** Memmgr heap disable thread allocation tracking
  *
  * @param      thread_id  - thread id to track
  */
-void memmgr_heap_disable_thread_trace(FuriThreadId taks_handle);
+void memmgr_heap_disable_thread_trace(FuriThreadId thread_id);
 
 /** Memmgr heap get allocatred thread memory
  *
@@ -32,7 +32,7 @@ void memmgr_heap_disable_thread_trace(FuriThreadId taks_handle);
  *
  * @return     bytes allocated right now
  */
-size_t memmgr_heap_get_thread_memory(FuriThreadId taks_handle);
+size_t memmgr_heap_get_thread_memory(FuriThreadId thread_id);
 
 /** Memmgr heap get the max contiguous block size on the heap
  *

furi/core/message_queue.h

@@ -32,7 +32,6 @@ void furi_message_queue_free(FuriMessageQueue* instance);
  * @param      instance  pointer to FuriMessageQueue instance
  * @param[in]  msg_ptr   The message pointer
  * @param[in]  timeout   The timeout
- * @param[in]  msg_prio  The message prio
  *
  * @return     The furi status.
  */
@@ -43,7 +42,6 @@ FuriStatus
  *
  * @param      instance  pointer to FuriMessageQueue instance
  * @param      msg_ptr   The message pointer
- * @param      msg_prio  The message prioority
  * @param[in]  timeout   The timeout
  *
  * @return     The furi status.

furi/core/string.h

@@ -102,7 +102,7 @@ void furi_string_reserve(FuriString* string, size_t size);
 /**
  * @brief Reset string.
  * Make the string empty.
- * @param s 
+ * @param string
  */
 void furi_string_reset(FuriString* string);
 

furi/core/thread.h

@@ -235,8 +235,6 @@ int32_t furi_thread_get_return_code(FuriThread* thread);
 /** Thread related methods that doesn't involve FuriThread directly */
 
 /** Get FreeRTOS FuriThreadId for current thread
- *
- * @param      thread  FuriThread instance
  *
  * @return     FuriThreadId or NULL
  */
@@ -263,7 +261,7 @@ uint32_t furi_thread_flags_wait(uint32_t flags, uint32_t options, uint32_t timeo
  * @brief Enumerate threads
  * 
  * @param thread_array array of FuriThreadId, where thread ids will be stored
- * @param array_items array size
+ * @param array_item_count array size
  * @return uint32_t threads count
  */
 uint32_t furi_thread_enumerate(FuriThreadId* thread_array, uint32_t array_item_count);