docs: Fix typos and some wrong expressions in API reference doc.
authorYeongjong Lee <yj34.lee@samsung.com>
Mon, 3 Sep 2018 00:23:30 +0000 (09:23 +0900)
committersubhransu mohanty <sub.mohanty@samsung.com>
Mon, 10 Sep 2018 04:21:59 +0000 (13:21 +0900)
Change-Id: I3305a4a119b9664f918a04dd3af437bf6bb46d78

src/lib/edje/Edje_Common.h
src/lib/eet/Eet.h
src/lib/eina/eina_log.h
src/lib/eina/eina_module.h
src/lib/eina/eina_rectangle.h
src/lib/elementary/Elementary_GL_Helpers.h
src/lib/elementary/efl_ui_spin_button_private.h
src/lib/elementary/elm_atspi_bridge.h
src/lib/elementary/elm_cnp.h
src/lib/elementary_tizen/elm_genlist.c

index 8dd6e95..b89a1cb 100644 (file)
@@ -2345,7 +2345,7 @@ EAPI void         edje_message_signal_process             (void);
  *
  * @brief Functions that deal with 3D projection of an 2D object.
  *
- * Perspective is a graphical tool that makes objets represented in 2D
+ * Perspective is a graphical tool that makes objects represented in 2D
  * look like they have a 3D appearance.
  *
  * Edje allows us to use perspective on any edje object. This group of
@@ -2612,7 +2612,7 @@ EAPI void *edje_object_signal_callback_seat_data_get(void);
  *
  * @remarks Tizen only feature (2015.07.16)
  *
- * @remarks Applications NEVER USE THESE APIs for private purporse.
+ * @remarks Applications NEVER USE THESE APIs for private purpose.
  *
  * @see edje_object_part_text_thaw()
  */
@@ -2625,7 +2625,7 @@ EAPI void                    edje_object_part_text_freeze    (Evas_Object *obj,
  *
  * @remarks Tizen only feature (2015.07.16)
  *
- * @remarks Applications NEVER USE THESE APIs for private purporse.
+ * @remarks Applications NEVER USE THESE APIs for private purpose.
  *
  * @see edje_object_part_text_freeze()
  */
index 8711339..9a9d7b6 100644 (file)
@@ -4062,7 +4062,7 @@ eet_data_descriptor_encode(Eet_Data_Descriptor *edd,
  * be defined. If the the type is not know at the time of restoring it, eet will still call
  * type_set of @p unified_type but the pointer will be set to a serialized binary representation
  * of what eet know. This make it possible, to save this pointer again by just returning the string
- * given previously and telling it by setting unknow to EINA_TRUE.
+ * given previously and telling it by setting unknown to EINA_TRUE.
  *
  * @since 1.2.4
  * @see Eet_Data_Descriptor_Class
index 36a2c32..86206f9 100644 (file)
@@ -545,13 +545,13 @@ static inline Eina_Bool eina_log_level_check(int level);
  * @brief Checks if current thread is the main thread.
  *
  * If there is no thread support (compiled with --disable-pthreads) or
- * threads were not enabled, then #EINA_TRUE is returned. The only case where 
- * #EINA_FALSE is returned is when threads were successfully enabled but the 
- * current thread is not the one that called eina_log_threads_init() (the 
+ * threads were not enabled, then #EINA_TRUE is returned. The only case where
+ * #EINA_FALSE is returned is when threads were successfully enabled but the
+ * current thread is not the one that called eina_log_threads_init() (the
  * main thread).
- * 
- * @return #EINA_TRUE if the current thread is the one that called 
- * eina_log_threads_init(), otherwise #EINA_FALSE. 
+ *
+ * @return #EINA_TRUE if the current thread is the one that called
+ * eina_log_threads_init(), otherwise #EINA_FALSE.
  */
 EAPI Eina_Bool          eina_log_main_thread_check(void) EINA_CONST EINA_WARN_UNUSED_RESULT;
 
@@ -845,14 +845,14 @@ EAPI void eina_log_vprint(int            domain,
 /**
  * @brief Alternative logging method, this will output to standard output stream.
  *
- * @param[in] d The domain.
- * @param[in] level The level.
- * @param[in] file The file which is logged.
- * @param[in] fnc The function which is logged.
- * @param[in] line The line which is logged.
- * @param[in] fmt The output format to use.
- * @param[in] data Not used.
- * @param[in] args The arguments needed by the format.
+ * @param d The domain.
+ * @param level The level.
+ * @param file The file which is logged.
+ * @param fnc The function which is logged.
+ * @param line The line which is logged.
+ * @param fmt The output format to use.
+ * @param data Not used.
+ * @param args The arguments needed by the format.
  *
  * This method will colorize output based on domain provided color and
  * message logging level. To disable color, set environment variable
@@ -880,14 +880,14 @@ EAPI void eina_log_print_cb_stdout(const Eina_Log_Domain *d,
 /**
  * @brief Default logging method, this will output to standard error stream.
  *
- * @param[in] d The domain.
- * @param[in] level The level.
- * @param[in] file The file which is logged.
- * @param[in] fnc The function which is logged.
- * @param[in] line The line which is logged.
- * @param[in] fmt The output format to use.
- * @param[in] data Not used.
- * @param[in] args The arguments needed by the format.
+ * @param d The domain.
+ * @param level The level.
+ * @param file The file which is logged.
+ * @param fnc The function which is logged.
+ * @param line The line which is logged.
+ * @param fmt The output format to use.
+ * @param data Not used.
+ * @param args The arguments needed by the format.
  *
  * This method will colorize output based on domain provided color and
  * message logging level.
@@ -922,14 +922,14 @@ EAPI void eina_log_print_cb_stderr(const Eina_Log_Domain *d,
 /**
  * @brief Alternative logging method, this will output to given file stream.
  *
- * @param[in] d The domain.
- * @param[in] level Not used.
- * @param[in] file The file which is logged.
- * @param[in] fnc The function which is logged.
- * @param[in] line The line which is logged.
- * @param[in] fmt The output format to use.
- * @param[in] data The file which will store the output (as a FILE *).
- * @param[in] args The arguments needed by the format.
+ * @param d The domain.
+ * @param level Not used.
+ * @param file The file which is logged.
+ * @param fnc The function which is logged.
+ * @param line The line which is logged.
+ * @param fmt The output format to use.
+ * @param data The file which will store the output (as a FILE *).
+ * @param args The arguments needed by the format.
  *
  * This method will never output color.
  *
@@ -957,7 +957,7 @@ EAPI void eina_log_print_cb_file(const Eina_Log_Domain *d,
  * @param[in] file The file that is logged
  * @param[in] fnc The function that is logged
  * @param[in] line The line that is logged
- * @param[in] fmt The ouptut format to use
+ * @param[in] fmt The output format to use
  * @param[in] data Not Used
  * @param[in] args The arguments needed by the format
  *
@@ -982,7 +982,7 @@ EAPI void eina_log_print_cb_syslog(const Eina_Log_Domain *d,
  * @param[in] file The file that is logged
  * @param[in] fnc The function that is logged
  * @param[in] line The line that is logged
- * @param[in] fmt The ouptut format to use
+ * @param[in] fmt The output format to use
  * @param[in] data Not Used
  * @param[in] args The arguments needed by the format
  *
@@ -1004,14 +1004,14 @@ EAPI void eina_log_print_cb_dlog(const Eina_Log_Domain *d,
 /**
  * @brief Alternative logging method, this will output to systemd journal.
  *
- * @param[in] d The domain.
- * @param[in] level Not used.
- * @param[in] file The file which is logged.
- * @param[in] fnc The function which is logged.
- * @param[in] line The line which is logged.
- * @param[in] fmt The output format to use.
- * @param[in] data The file which will store the output (as a FILE *).
- * @param[in] args The arguments needed by the format.
+ * @param d The domain.
+ * @param level Not used.
+ * @param file The file which is logged.
+ * @param fnc The function which is logged.
+ * @param line The line which is logged.
+ * @param fmt The output format to use.
+ * @param data The file which will store the output (as a FILE *).
+ * @param args The arguments needed by the format.
  *
  * This method will never output color.
  *
@@ -1050,7 +1050,7 @@ extern EAPI const char *_eina_log_state_init;
 extern EAPI const char *_eina_log_state_shutdown;
 /**
  * @def EINA_LOG_STATE_INIT
- * String that indicates the log system is initializing 
+ * String that indicates the log system is initializing
  *
  * @if MOBILE @since_tizen 3.0
  * @elseif WEARABLE @since_tizen 3.0
index 9040054..cd54320 100644 (file)
@@ -209,9 +209,8 @@ EAPI const char *
 /**
  * @brief Defines if on module load we should expose all symbol
  *
- * @param[in,out] module The module to turn off/on symbol to be exposed
- * @param[in] global @c true to turn on symbol to be exposed, @c false otherwise
- *
+ * @param module The module to turn off/on symbol to be exposed
+ * @param global @c true to turn on symbol to be exposed, @c false otherwise
  * @since 1.11
  */
 EAPI void eina_module_symbol_global_set(Eina_Module *module, Eina_Bool global) EINA_ARG_NONNULL(1);
index a5902b3..0df6bf6 100644 (file)
@@ -286,7 +286,7 @@ static inline int         eina_rectangle_max_x(Eina_Rectangle *rect) EINA_ARG_NO
  * @param[in] rect The rectangle.
  * @return The maximum Y coordinate.
  *
- * This function calculates the maximum Y coordinate of the rectangle by summing
+ * This function calculates the maximum y coordinate of the rectangle by summing
  * the @p height with the current @p y coordinate of the rectangle.
  */
 static inline int         eina_rectangle_max_y(Eina_Rectangle *rect) EINA_ARG_NONNULL(1);
index b7f3791..3eb1197 100644 (file)
@@ -272,7 +272,7 @@ glview_create(Evas_Object *parent)
  * OpenGL-ES in an EFL application.
  *
  *
- * @subsection elm_opengl_evasglexample Evas GL initialiation with GLView
+ * @subsection elm_opengl_evasglexample Evas GL initialization with GLView
  *
  * When using @ref Elm_GLView, EFL will take care of the tedious creation of all
  * the surfaces and contexts. Also, EFL hides the underlying display system
index 5122070..7f01dfd 100644 (file)
@@ -8,7 +8,7 @@ struct _Efl_Ui_Spin_Button_Data
    Evas_Object          *ent, *inc_button, *dec_button, *text_button;
    Ecore_Timer          *delay_change_timer; /**< a timer for a delay,changed smart callback */
    Ecore_Timer          *spin_timer; /**< a timer for a repeated spinner value change on mouse down */
-   Ecore_Timer          *longpress_timer; /**< a timer to detect long press. After longress timeout,
+   Ecore_Timer          *longpress_timer; /**< a timer to detect long press. After longpress timeout,
                                           start continuous change of values until mouse up */
    Efl_Ui_Dir            dir;
 
index 2931d9b..d0b2f0c 100644 (file)
@@ -14,7 +14,7 @@
 /**
  * This callback type is used to provide reading status information.
  * @param data The data specified as the last param when setting this callback
- * @param say_signal The signal decribes reading status information
+ * @param say_signal The signal describes reading status information
  * @see elm_atspi_bridge_utils_say
  * @ingroup Elm_Atspi_Bridge
  * @if MOBILE @since_tizen 4.0 @elseif WEARABLE @since_tizen 3.0 @endif
index 975d8f8..960264d 100644 (file)
@@ -81,16 +81,17 @@ typedef Efl_Selection_Format Elm_Sel_Format;
  * Defines the kind of action associated with the drop data if for XDND
  * @since 1.8
  */
-typedef Efl_Selection_Action Elm_Xdnd_Action;
-
-#define ELM_XDND_ACTION_UNKNOWN EFL_SELECTION_ACTION_UNKNOWN
-#define ELM_XDND_ACTION_COPY EFL_SELECTION_ACTION_COPY
-#define ELM_XDND_ACTION_MOVE EFL_SELECTION_ACTION_MOVE
-#define ELM_XDND_ACTION_PRIVATE EFL_SELECTION_ACTION_PRIVATE
-#define ELM_XDND_ACTION_ASK EFL_SELECTION_ACTION_ASK
-#define ELM_XDND_ACTION_LIST EFL_SELECTION_ACTION_LIST
-#define ELM_XDND_ACTION_LINK EFL_SELECTION_ACTION_LINK
-#define ELM_XDND_ACTION_DESCRIPTION EFL_SELECTION_ACTION_DESCRIPTION
+typedef enum
+{
+   ELM_XDND_ACTION_UNKNOWN, /**< Action type is unknown */
+   ELM_XDND_ACTION_COPY, /**< Copy the data */
+   ELM_XDND_ACTION_MOVE, /**< Move the data */
+   ELM_XDND_ACTION_PRIVATE, /**< Private action type */
+   ELM_XDND_ACTION_ASK, /**< Ask the user what to do */
+   ELM_XDND_ACTION_LIST, /**< List the data */
+   ELM_XDND_ACTION_LINK, /**< Link the data */
+   ELM_XDND_ACTION_DESCRIPTION /**< Describe the data */
+} Elm_Xdnd_Action;
 
 /**
  * Structure holding the info about selected data.
index 87299e8..9a8ef45 100644 (file)
@@ -8155,7 +8155,7 @@ _elm_genlist_item_item_class_update(Eo *eo_it EINA_UNUSED, Elm_Gen_Item *it,
    if (!GL_IT(it)->block) return;
 
    // FIXME(160711): orignal edje object updated by _view_theme_update
-   // cannot recieve signal emit properly. This edje bug must be fixed.
+   // cannot receive signal emit properly. This edje bug must be fixed.
    _item_cache_all_free(sd);
 
    sd->no_cache = EINA_TRUE;