From 3f28b2c2acfe5cbd6c2b6377ad76eb13db0a8b29 Mon Sep 17 00:00:00 2001 From: "JunSeok, Kim" Date: Fri, 14 Jul 2017 17:04:11 +0900 Subject: [PATCH] code refactoring: add comments for configs(e_config, e_comp_cfdata) Change-Id: I0bec811f87b192514d7252e321ce84bf8d7efb28 --- src/bin/e_comp_cfdata.h | 18 ++++++++-------- src/bin/e_config.h | 56 ++++++++++++++++++++++++------------------------- 2 files changed, 37 insertions(+), 37 deletions(-) diff --git a/src/bin/e_comp_cfdata.h b/src/bin/e_comp_cfdata.h index 92d65cf..152aa8e 100644 --- a/src/bin/e_comp_cfdata.h +++ b/src/bin/e_comp_cfdata.h @@ -10,10 +10,10 @@ struct _E_Comp_Config { int version; const char *shadow_style; - const char *effect_file; - const char *effect_style; - const char *depth_in_style; - const char *bg_effect_style; + const char *effect_file; // effect edj path for effect object + const char *effect_style; // name of effect group to apply + const char *depth_in_style; // name of effect group to apply for depth in type + const char *bg_effect_style; // name of effect group for background int engine; int max_unmapped_time; int min_unmapped_time; @@ -32,11 +32,11 @@ struct _E_Comp_Config unsigned char nocomp_use_timer; double nocomp_begin_timeout; unsigned char hwc; - unsigned char hwc_use_multi_plane; - unsigned char hwc_deactive; - unsigned char hwc_reuse_cursor_buffer; - unsigned char hwc_sync_mode_change; - unsigned char hwc_ignore_primary; + unsigned char hwc_use_multi_plane; // 0: regards hwc layer is single. comp or nocomp switches only, 1: regards hwc layer is multiple + unsigned char hwc_deactive; // 0: run hwc policy if capable of, 1: not to run hwc policy + unsigned char hwc_reuse_cursor_buffer; // 0: none, 1: reuse hwc cursor buffer when cursor image is changed + unsigned char hwc_sync_mode_change; // 0: none, 1: synchronize scanout buffer when hwc mode change in reserved memory plane + unsigned char hwc_ignore_primary; // 0: none, 1: hwc use plane has lowest zpos and support rgb to default ui layer unsigned char smooth_windows; unsigned char nofade; double first_draw_delay; diff --git a/src/bin/e_config.h b/src/bin/e_config.h index 7b83e6a..4ddc65f 100644 --- a/src/bin/e_config.h +++ b/src/bin/e_config.h @@ -29,7 +29,7 @@ typedef struct _E_Config_Aux_Hint_Supported E_Config_Aux_Hint_Supported; struct _E_Config { - int config_version; + int config_version; // INTERNAL const char *desktop_default_background; const char *desktop_default_name; const char *desktop_default_window_profile; @@ -127,15 +127,15 @@ struct _E_Config int only_label; const char *default_model; Eina_Bool dont_touch_my_damn_keyboard; - Eina_Bool use_cache; - unsigned int delay_held_key_input_to_focus; + Eina_Bool use_cache; // use a cached keymap file insteads generate a new keymap file + unsigned int delay_held_key_input_to_focus; // delay in milliseconds that sends the key press event when the focus window is changed struct { - const char *rules; - const char *model; - const char *layout; - const char *variant; - const char *options; + const char *rules; // enlightenment's default xkb rules + const char *model; // enlightenment's default xkb model + const char *layout; // enlightenment's default xkb layout + const char *variant; // enlightenment's default xkb variant + const char *options; // enlightenment's default xkb options } default_rmlvo; } xkb; struct @@ -147,11 +147,11 @@ struct _E_Config #ifdef _F_ZONE_WINDOW_ROTATION_ unsigned char wm_win_rotation; #endif - unsigned int screen_rotation_pre; - unsigned int screen_rotation_setting; - Eina_Bool eom_enable; - int use_cursor_timer; - int cursor_timer_interval; + unsigned int screen_rotation_pre; // screen-rotation value as default (0/90/180/270) + unsigned int screen_rotation_setting; // screen-rotation value which is set in runtime (0/90/180/270) + Eina_Bool eom_enable; // 0: eom disable, 1: eom enable + int use_cursor_timer; // boolean value for enabling cursor timer (default : disable : 0) + int cursor_timer_interval; // time value the cursor will be displayed in second (default : 5) Eina_List *client_types; const char *comp_shadow_file; int sleep_for_dri; @@ -163,26 +163,26 @@ struct _E_Config int opmode; } comp_canvas_bg; int delayed_load_idle_count; - Eina_Bool use_buffer_flush; - Eina_Bool use_desk_smart_obj; - Eina_List *sock_accesses; - Eina_List *aux_hint_supported; + Eina_Bool use_buffer_flush; // 0: none, 1: let a client flush buffer when it is changed into iconic state to save memory + Eina_Bool use_desk_smart_obj; // 0: none, 1: make e_desk as a smart object + Eina_List *sock_accesses; // list of socket(wayland-0, tbm-drm-auto, tbm-socket) to grant permission without systemd + Eina_List *aux_hint_supported; // pre-defined aux hint list for a client launched ahead of delayed e-module loading struct { - Eina_Bool qp; /* quickpanel */ + Eina_Bool qp; // whether to use extra quickpanel module for handling quickpanel } use_module_srv; - double launchscreen_timeout; - Eina_Bool enable_conformant_ack; - double conformant_ack_timeout; - Eina_Bool calc_vis_without_effect; + double launchscreen_timeout; // time to dismiss launchscreen + Eina_Bool enable_conformant_ack; // 0: no ack check, 1: conformant region show/hide delay until ack + double conformant_ack_timeout; // not to wait conformant ack if timer expires + Eina_Bool calc_vis_without_effect; // 0: none, 1: send visibility event to a client eventhough running effect due to performance issue. Eina_Bool save_win_buffer; Eina_Bool hold_prev_win_img; - const char *indicator_plug_name; - Eina_Bool launchscreen_without_timer; - int log_type; - int rsm_buffer_release_mode; /* 0:none, 1:release on free, 2:release on hide */ - Eina_Bool deiconify_approve; /* 0:none, 1:wait render commit when deiconify*/ - Eina_Bool use_pp_zoom; + const char *indicator_plug_name; // name of indicator ecore_evas_plug such as "elm_indicator" + Eina_Bool launchscreen_without_timer; // 0: dismiss launchscreen when timer expires, 1: it doesn't use timer + int log_type; // where to print dlog (0: default log, 1: system log) + int rsm_buffer_release_mode; // 0:none, 1:release on free, 2:release on hide + Eina_Bool deiconify_approve; // 0:none, 1:wait render commit when deiconify + Eina_Bool use_pp_zoom; // 0: pp zoom disable, 1: pp zoom enable }; struct _E_Config_Desklock_Background -- 2.7.4