Doxygen style comments for data/system

Change-Id: I9a3aa58991c4517474acc1c7a82068301baf84ae
Signed-off-by: Piotr Pruski <p.pruski@samsung.com>

diff --git a/include/data/settings_picture.h b/include/data/settings_picture.h
index 7e26172..c79b6c4 100644 (file)
--- a/include/data/settings_picture.h
+++ b/include/data/settings_picture.h
@@ -42,200 +42,199 @@ typedef enum _picture_mode {
 extern const char *screen_adj_names[SCREEN_ADJ_OPTS_COUNT];
 
 /**
-* @brief 
+* @brief Sets system picture mode.
 *
-* @param mode_to_set
+* @param mode_to_set Picture mode to set
 */
 void settings_picture_set_picture_mode(settings_picture_mode mode_to_set);
 
 /**
-* @brief 
+* @brief Sets contrast of the picture.
 *
-* @param val
+* @param val New contrast value
 */
 void settings_picture_set_contrast(int val);
 
 /**
-* @brief 
+* @brief Sets brightness of the picture.
 *
-* @param val
+* @param val New brightness value
 */
 void settings_picture_set_brightness(int val);
 
 /**
-* @brief 
+* @brief Sets sharpness of the picture.
 *
-* @param val
+* @param val New sharpness value
 */
 void settings_picture_set_sharpness(int val);
 
 /**
-* @brief 
+* @brief Sets color of the picture.
 *
-* @param val
+* @param val New color value
 */
 void settings_picture_set_color(int val);
 
 /**
-* @brief 
+* @brief Sets tint of the picture.
 *
-* @param val
+* @param val New tint value
 */
 void settings_picture_set_tint_g(int val);
 
 
 /**
-* @brief 
+* @brief Gets picture mode.
 *
-* @return 
+* @return Picture mode
 */
 settings_picture_mode settings_picture_get_picture_mode(void);
 
 /**
-* @brief 
+* @brief Gets picture contrast value.
 *
-* @return 
+* @return Picture contrast value
 */
 int settings_picture_get_contrast(void);
 
 /**
-* @brief 
+* @brief Gets picture contrast relative value.
 *
-* @return 
+* @return Picture contrast relative value
 */
 float settings_picture_get_contrast_relative(void);
 
 /**
-* @brief 
+* @brief Gets picture brightness value.
 *
-* @return 
+* @return Picture brightness value
 */
 int settings_picture_get_brightness(void);
 
 /**
-* @brief 
+* @brief Gets picture brightness relative value.
 *
-* @return 
+* @return Picture brightness ralative value
 */
 float settings_picture_get_brightness_relative(void);
 
 /**
-* @brief 
+* @brief Gets picture max brightness value.
 *
-* @return 
+* @return Picture max brightness value
 */
 int settings_picture_get_max_brightness(void);
 
 /**
-* @brief 
+* @brief Gets picture sharpness value.
 *
-* @return 
+* @return Picture sharpness value
 */
 int settings_picture_get_sharpness(void);
 
 /**
-* @brief 
+* @brief Gets picture sharpness relative value.
 *
-* @return 
+* @return Picture sharpness relative value
 */
 float settings_picture_get_sharpness_relative(void);
 
 /**
-* @brief 
+* @brief Gets picture color value.
 *
-* @return 
+* @return Picture color value
 */
 int settings_picture_get_color(void);
 
 /**
-* @brief 
+* @brief Gets picture color relative value.
 *
-* @return 
+* @return Picture color relative value
 */
 float settings_picture_get_color_relative(void);
 
 /**
-* @brief 
+* @brief Gets picture tint value.
 *
-* @return 
+* @return Picture tint value
 */
 int settings_picture_get_tint_g(void);
 
 /**
-* @brief 
+* @brief Gets picture tint relative value
 *
-* @return 
+* @return Picture tint relative value
 */
 float settings_picture_get_tint_relative(void);
 
 /**
-* @brief 
+* @brief Sets screen adjust
 *
 * @param adj
 */
 void settings_picture_set_screen_adjust(int adj);
 
 /**
-* @brief 
+* @brief Gets picture screen adjust
 *
-* @return 
+* @return Picture screen adjust
 */
 int settings_picture_get_screen_adjust(void);
 
 /**
-* @brief 
+* @brief Gets picture screen adjust in string
 *
-* @return 
+* @return String with picture screen adjust
 */
 const char *settings_picture_get_screen_adjust_str(void);
 
-/* Sets callbacks for menumgr_update when proper setting changes in system. */
 /**
-* @brief 
+* @brief Sets picture mode update callback
 *
-* @param data
+* @param data Data to be passed to the handler callbacks.
 */
 void settings_picture_set_picture_mode_update_callbacks(void *data);
 
 /**
-* @brief 
+* @brief Sets picture contrast update callback
 *
-* @param data
+* @param data Data to be passed to the handler callbacks.
 */
 void settings_picture_set_contrast_update_callbacks(void *data);
 
 /**
-* @brief 
+* @brief Sets picture brightness update callback
 *
-* @param data
+* @param data Data to be passed to the handler callbacks.
 */
 void settings_picture_set_brightness_update_callbacks(void *data);
 
 /**
-* @brief 
+* @brief Sets picture sharpness update callback
 *
-* @param data
+* @param data Data to be passed to the handler callbacks.
 */
 void settings_picture_set_sharpness_update_callbacks(void *data);
 
 /**
-* @brief 
+* @brief Sets picture color update callback
 *
-* @param data
+* @param data Data to be passed to the handler callbacks.
 */
 void settings_picture_set_color_update_callbacks(void *data);
 
 /**
-* @brief 
+* @brief Sets picture tint update callback
 *
-* @param data
+* @param data Data to be passed to the handler callbacks.
 */
 void settings_picture_set_tint_update_callbacks(void *data);
 
 /**
-* @brief 
+* @brief Sets picture screen adjust update callback
 *
-* @param data
+* @param data Data to be passed to the handler callbacks.
 */
 void settings_picture_set_screen_adj_update_callbacks(void *data);
 

diff --git a/include/data/settings_preferences.h b/include/data/settings_preferences.h
index ecf4ce5..8df7881 100644 (file)
--- a/include/data/settings_preferences.h
+++ b/include/data/settings_preferences.h
@@ -18,22 +18,22 @@
 #define __AIR_SETTINGS_PREFERENCES_H__
 
 /**
-* @brief 
+* @brief Gets settings preferences of tab order
 *
-* @param tab_index
-* @param ret_value
+* @param tab_index[in] Tab index
+* @param ret_value[out] Settings preferences
 *
-* @return
+* @return True on success, false otherwise.
 */
 bool settings_preferences_tab_order_get(int tab_index, char **ret_value);
 
 /**
-* @brief
+* @brief Sets settings preferences of tab order
 *
-* @param tab_index
-* @param new_value
+* @param tab_index Tab index
+* @param new_value New tab index
 *
-* @return
+* @return True on success, false otherwise.
 */
 bool settings_preferences_tab_order_set(int tab_index, const char *new_value);
 

diff --git a/include/data/system/data_wireless.h b/include/data/system/data_wireless.h
index 64dfb79..ed4a247 100644 (file)
--- a/include/data/system/data_wireless.h
+++ b/include/data/system/data_wireless.h
@@ -35,9 +35,9 @@ struct wifi_ap_info {
 };
 
 /**
-* @brief 
+* @brief Get the pointer to the wireless data_class object
 *
-* @return 
+* @return The pointer to data_class
 */
 struct data_class *get_wireless_data_class(void);
 

diff --git a/include/data/system/settings_clock.h b/include/data/system/settings_clock.h
index da89c78..1aef626 100644 (file)
--- a/include/data/system/settings_clock.h
+++ b/include/data/system/settings_clock.h
@@ -5,72 +5,71 @@
 #include <time.h>
 
 /**
-* @brief 
+* @brief Check if settings clock is set to be 24h format.
 *
 * @param h24
 *
-* @return 
+* @return True on success, false otherwise.
 */
 bool settings_clock_is_24h_set(bool *h24);
 
 /**
-* @brief 
+* @brief Sets clock format.
 *
-* @param h24
+* @param h24 If true, the 24h time format is selected
 *
-* @return 
+* @return True on success, false otherwise.
 */
 bool settings_clock_set_24h(bool h24);
 
 /**
-* @brief 
+* @brief Check if settings clock is set to automatic time.
 *
-* @param automatic
+* @param The Automatic time state
 *
-* @return 
+* @return True on success, false otherwise.
 */
 bool settings_clock_is_time_automatic(bool *automatic);
 
 /**
-* @brief 
+* @brief Sets settings clock to automatic synchronization.
 *
-* @param automatic
+* @param automatic If true, the time will be updated automatically
 *
-* @return 
+* @return True on success, false otherwise.
 */
 bool settings_clock_set_time_automatic(bool automatic);
 
 /**
-* @brief 
+* @brief Gets current time.
 *
-* @param current_time
+* @param current_time The datetime strucure
 *
-* @return 
+* @return True on success, false otherwise.
 */
 bool settings_clock_get_current_time(struct tm *current_time);
 
 /**
-* @brief 
+* @brief Sets current time.
 *
-* @param current_time
+* @param current_time The datatime structure
 *
-* @return 
+* @return True on success, false otherwise.
 */
 bool settings_clock_set_current_time(struct tm *current_time);
 
 /**
-* @brief 
+* @brief Gets string representation of time
 *
-* @return 
+* @return Character array with time
 */
 char *settings_clock_get_clock_status_str();
 
-/* Set callbacks to call menumgr_update() when status changed
- * (system settings changes and minute update) */
 /**
-* @brief 
+* @brief Sets callbacks to call menumgr_update() when status changed
+*  (system settings changes and minute update)
 *
-* @param data
+* @param data Data to be passed to the handler callbacks.
 */
 void settings_clock_set_state_update_callbacks(void *data);
 

diff --git a/include/data/system/settings_language.h b/include/data/system/settings_language.h
index a3395f7..8d10863 100644 (file)
--- a/include/data/system/settings_language.h
+++ b/include/data/system/settings_language.h
@@ -26,76 +26,66 @@ typedef enum _language_type {
        LANG_TYPE_MAX
 } settings_language_type;
 
-/* Sets current language */
 /**
-* @brief 
+* @brief Sets current language.
 *
-* @param lang_type
+* @param[in] lang_type Language type.
 */
 void settings_language_set_language(settings_language_type lang_type);
 
-/* Gets current language ID */
 /**
-* @brief 
+* @brief Gets current language ID.
 *
-* @return 
+* @return ID of language type.
 */
 settings_language_type settings_language_get_language_id(void);
 
-/* Gets current locale language string.
- * Note that the returned string needs to be freed after use. */
 /**
-* @brief 
+* @brief Gets current locale language string.
 *
-* @return 
+* @return String with name of current language.
 */
 char *settings_language_get_language_locale_str(void);
 
-/* Gets current display language string. */
 /**
-* @brief 
+* @brief Gets current display language string.
 *
-* @return 
+* @return String with current language.
 */
 char *settings_language_get_language_display_str(void);
 
-/* Sets current subtitle language */
 /**
-* @brief 
+* @brief Sets current subtitle language.
 *
-* @param lang_type
+* @param[in] lang_type Language type.
 */
 void settings_language_set_subtitle_language(settings_language_type lang_type);
 
-/* Gets current subtitle language ID */
 /**
-* @brief 
+* @brief Gets current subtitle language ID.
 *
-* @return 
+* @return Language type for subtitle.
 */
 settings_language_type settings_language_get_subtitle_language_id(void);
 
-/* Gets current display subtitlelanguage string. */
 /**
-* @brief 
+* @brief Gets current display subtitle language string.
 *
-* @return 
+* @return String with current subtitle language.
 */
 char *settings_language_get_subtitle_language_display_str(void);
 
-/* Sets callback for menumgr_update when language system setting changes. */
 /**
-* @brief 
+* @brief Sets callback for menumgr_update when language system setting changes.
 *
-* @param data
+* @param[in] data Data to be passed to input callbacks handler.
 */
 void settings_language_set_state_update_callbacks(void *data);
 
-/* Sets callback for menumgr_update when subtitle system setting changes. */
 /**
-* @brief 
+* @brief Sets callback for menumgr_update when subtitle system setting changes.
 *
-* @param data
+* @param[in] data Data to be passed to input callbacks handler.
 */
 void settings_language_set_subtitle_state_update_callbacks(void *data);
 

diff --git a/include/data/system/settings_pincode.h b/include/data/system/settings_pincode.h
index e789f69..181e68a 100644 (file)
--- a/include/data/system/settings_pincode.h
+++ b/include/data/system/settings_pincode.h
@@ -4,21 +4,21 @@
 #include <stdbool.h>
 
 /**
-* @brief 
+* @brief Check if pincode which was inputted matches the saved one.
 *
 * @param pin
 *
-* @return 
+* @return True on success, false otherwise.
 */
 bool settings_pincode_verify(const int *pin);
 
 /**
-* @brief 
+* @brief Compare two pincodes
 *
 * @param pin1
 * @param pin2
 *
-* @return 
+* @return True on success, false otherwise.
 */
 bool settings_pincode_compare(const int *pin1, const int *pin2);
 

diff --git a/include/data/system/settings_wakeup_timer.h b/include/data/system/settings_wakeup_timer.h
index 905f68d..4aad95e 100644 (file)
--- a/include/data/system/settings_wakeup_timer.h
+++ b/include/data/system/settings_wakeup_timer.h
@@ -49,55 +49,54 @@ enum tmp_channel {
 };
 
 /**
-* @brief 
+* @brief Gets wakeup timer setup type.
 *
-* @return 
+* @return wakeup timer setup type.
 */
 int settings_wakeup_timer_get_setup(void);
 
 /**
-* @brief 
+* @brief Gets string for displayed time in settings view.
 *
-* @return 
+* @return String with time to be displayed in settings view.
 */
 char *settings_wakeup_timer_display_str(void);
 
 /**
-* @brief 
+* @brief Gets time set on the wakeup timer.
 *
-* @param def_time
+* @param[in] def_time
 *
-* @return 
+* @return True on succes, false otherwise.
 */
 bool settings_wakeup_timer_get_time(struct tm *def_time);
 
 /**
-* @brief 
+* @brief Gets volume for the wakeup timer.
 *
-* @return 
+* @return Volume power.
 */
 int settings_wakeup_timer_get_volume(void);
 
 /**
-* @brief 
+* @brief Gets source for the wakeup timer.
 *
-* @return 
+* @return Video source type
 */
 int settings_wakeup_timer_get_source(void);
 
 /**
-* @brief 
+* @brief Gets channel number.
 *
-* @return 
+* @return Channel number
 */
 int settings_wakeup_timer_get_channel(void);
 //@TODO settings_wakeup_timer_set_timer()
 
-/* Sets callback for menumgr_update when setting changes in system. */
 /**
-* @brief 
+* @brief Sets callback for menumgr_update when wakeup timer settings change in system.
 *
-* @param data
+* @param[in] data Data to be passed to the handler callbacks.
 */
 void settings_wakeup_timer_set_state_update_callbacks(void *data);