Update the function documentation in the header files

lv_app/lv_app.h

@@ -9,6 +9,7 @@
 /*********************
  *      INCLUDES
  *********************/
+
 #include "lvgl/lvgl.h"
 
 #if LV_APP_ENABLE != 0
@@ -82,7 +83,6 @@ typedef struct {
 	lv_labels_t sc_title_style;
     lv_labels_t sc_txt_style;
 
-
 	opa_t menu_opa;
 	opa_t menu_btn_opa;
 	opa_t sc_opa;
@@ -101,28 +101,130 @@ typedef struct {
 /**********************
  * GLOBAL PROTOTYPES
  **********************/
+
+/**
+ * Initialize the application system
+ */
 void lv_app_init(void);
+
+/**
+ * Run an application according to 'app_dsc'
+ * @param app_dsc pointer to an application descriptor
+ * @param conf pointer to an application specific configuration structure or NULL if unused
+ * @return pointer to the opened application or NULL if any error occurred
+ */
 lv_app_inst_t * lv_app_run(const lv_app_dsc_t * app_dsc, void * conf);
+
+/**
+ * Close a running application. Close the Window and the Shortcut too if opened.
+ * @param app pointer to an application
+ */
 void lv_app_close(lv_app_inst_t * app);
-uint16_t lv_app_com_send(lv_app_inst_t * app_send, lv_app_com_type_t type , const void * data, uint32_t size);
+
+/**
+ * Open a shortcut for an application
+ * @param app pointer to an application
+ * @return pointer to the shortcut
+ */
 lv_obj_t * lv_app_sc_open(lv_app_inst_t * app);
+
+/**
+ * Close the shortcut of an application
+ * @param app pointer to an application
+ */
 void lv_app_sc_close(lv_app_inst_t * app);
+
+/**
+ * Open the application in a window
+ * @param app pointer to an application
+ * @return pointer to the shortcut
+ */
 lv_obj_t * lv_app_win_open(lv_app_inst_t * app);
+
+/**
+ * Close the window of an application
+ * @param app pointer to an application
+ */
 void lv_app_win_close(lv_app_inst_t * app);
-lv_obj_t * lv_app_win_get_from_obj(lv_obj_t * obj);
+
+/**
+ * Send data to other applications
+ * @param app_send pointer to the application which is sending the message
+ * @param type type of data from 'lv_app_com_type_t' enum
+ * @param data pointer to the sent data
+ * @param size length of 'data' in bytes
+ * @return number application which were received the message
+ */
+uint16_t lv_app_com_send(lv_app_inst_t * app_send, lv_app_com_type_t type , const void * data, uint32_t size);
+
+/**
+ * Test an application communication connection
+ * @param sender pointer to an application which sends data
+ * @param receiver pointer to an application which receives data
+ * @return false: no connection, true: there is connection
+ */
+bool lv_app_con_check(lv_app_inst_t * sender, lv_app_inst_t * receiver);
+
+/**
+ * Create a new connection between two applications
+ * @param sender pointer to a data sender application
+ * @param receiver pointer to a data receiver application
+ */
+void lv_app_con_set(lv_app_inst_t * sender, lv_app_inst_t * receiver);
+
+/**
+ * Delete a communication connection
+ * @param sender pointer to a data sender application or NULL to be true for all sender
+ * @param receiver pointer to a data receiver application  or NULL to be true for all receiver
+ */
+void lv_app_con_del(lv_app_inst_t * sender, lv_app_inst_t * receiver);
+
+/**
+ * Get the application descriptor from its name
+ * @param name name of the app. dsc.
+ * @return pointer to the app. dsc.
+ */
 const lv_app_dsc_t * lv_app_dsc_get(const char * name);
 
-bool lv_app_con_check(lv_app_inst_t * sender, lv_app_inst_t * receiver);
-void lv_app_con_set(lv_app_inst_t * sender, lv_app_inst_t * receiver);
-void lv_app_con_del(lv_app_inst_t * sender, lv_app_inst_t * receiver);
-lv_app_style_t * lv_app_style_get(void);
+/**
+ * Rename an application
+ * @param app pointer to an application
+ * @param name a string with the new name
+ */
 void lv_app_rename(lv_app_inst_t * app, const char * name);
-void lv_app_style_refr(void);
 
+/**
+ * Get the window object from an object located on the window
+ * @param obj pointer to an object on the window
+ * @return pointer to the window of 'obj'
+ */
+lv_obj_t * lv_app_win_get_from_obj(lv_obj_t * obj);
+
+/**
+ * Read the list of the running applications. (Get he next element)
+ * @param prev the previous application (at the first call give NULL to get the first application)
+ * @param dsc pointer to an application descriptor to filer the applications (NULL to do not filter)
+ * @return pointer to the next running application or NULL if no more
+ */
 lv_app_inst_t * lv_app_get_next(lv_app_inst_t * prev, lv_app_dsc_t * dsc);
+
+/**
+ * Read the list of applications descriptors. (Get he next element)
+ * @param prev the previous application descriptors(at the first call give NULL to get the first)
+ * @return pointer to the next application descriptors or NULL if no more
+ */
 lv_app_dsc_t ** lv_app_dsc_get_next(lv_app_dsc_t ** prev);
 
-const lv_app_dsc_t * lv_app_example_init(void);
+/**
+ * Refresh the style of the applications
+ * */
+void lv_app_style_refr(void);
+
+/**
+ * Get a pointer to the application style structure. If modified then 'lv_app_refr_style' should be called
+ * @return pointer to the application style structure
+ */
+lv_app_style_t * lv_app_style_get(void);
 
 /**********************
  *      MACROS

lv_app/lv_app_util/lv_app_fsel.h

@@ -23,9 +23,27 @@
 /**********************
  * GLOBAL PROTOTYPES
  **********************/
+
+/**
+ * Initialize the File selector utility
+ */
 void lv_app_fsel_init(void);
-void lv_app_fsel_open(const char * path, const char * filter, void * param, void (*ok_action)(void *, const char *));
-void lv_app_fsel_close();
+
+/**
+ * Open the File selector
+ * @param path start path
+ * @param filter show only files with a specific extension, e.g. "wav".
+ *               "/" means filter to folders.
+ * @param param a free parameter which will be added to 'ok_action'
+ * @param ok_action an action to call when a file or folder is chosen
+ */
+void lv_app_fsel_open(const char * path, const char * filter, void * param,
+                       void (*ok_action)(void *, const char *));
+
+/**
+ * Close the File selector
+ */
+void lv_app_fsel_close(void);
 
 /**********************
  *      MACROS

lv_app/lv_app_util/lv_app_kb.c

@@ -73,6 +73,9 @@ static lv_btnms_t kb_btnms;
  *   GLOBAL FUNCTIONS
  **********************/
 
+/**
+ * Initialize the application keyboard
+ */
 void lv_app_kb_init(void)
 {
     lv_btnms_get(LV_BTNMS_DEF, &kb_btnms);

lv_app/lv_app_util/lv_app_kb.h

@@ -28,8 +28,25 @@ typedef enum
 /**********************
  * GLOBAL PROTOTYPES
  **********************/
+
+/**
+ * Initialize the application keyboard
+ */
 void lv_app_kb_init(void);
+
+/**
+ * Open a keyboard for a text area object
+ * @param ta pointer to a text area object
+ * @param mode 'OR'd values of 'lv_app_kb_mode_t' enum
+ * @param close a function to call when the keyboard is closed
+ * @param ok a function to called when the "Ok" button is pressed
+ */
 void lv_app_kb_open(lv_obj_t * ta, lv_app_kb_mode_t mode, void (*close)(lv_obj_t *), void (*ok)(lv_obj_t *));
+
+/**
+ * Close the keyboard
+ * @param ok true: call the ok function, false: call the close function
+ */
 void lv_app_kb_close(bool ok);
 
 /**********************

lv_app/lv_app_util/lv_app_notice.h

@@ -24,7 +24,17 @@
 /**********************
  * GLOBAL PROTOTYPES
  **********************/
+
+/**
+ * Initialize the Notifications
+ */
 void lv_app_notice_init(void);
+
+/**
+ * Add a notification with a given text
+ * @param format pritntf-like format string
+ * @return pointer the notice which is a message box (lv_mbox) object
+ */
 lv_obj_t *  lv_app_notice_add(const char * format, ...);
 
 /**********************