doc: add missing parameters and fix references for some elm widgets 34/157334/2
authorThiep Ha <thiepha@gmail.com>
Tue, 24 Oct 2017 06:13:07 +0000 (15:13 +0900)
committerGerrit Code Review <gerrit@review.ap-northeast-2.compute.internal>
Wed, 25 Oct 2017 04:19:57 +0000 (04:19 +0000)
Change-Id: Iced4250100d557e0fd180f554683558f3c8e93dc

src/lib/elm_button.h
src/lib/elm_calendar.h
src/lib/elm_check.h
src/lib/elm_colorselector.h
src/lib/elm_config.h
src/lib/elm_conform.h
src/lib/elm_entry.h
src/lib/elm_entry_legacy.h
src/lib/elm_layout.h

index 2639c255b4c1a25328b3e67ea40f6b0e713d2b06..ae1b96e1efe2089ca26b57cd4472bd842148b508 100644 (file)
@@ -19,7 +19,7 @@
  * functions acting on it also work for button objects.
  *
  * This widget emits the following signals, besides the ones sent from
- * @ref Elm_Layout:
+ * @ref Elm_Layout :
  * @li "clicked": the user clicked the button (press/release).
  * @li "repeated": the user pressed the button without releasing it.
  * @li "pressed": button was pressed.
index b52cc323ca15426644e27838d218b8758a67a157..113a48c80982ae0b0e282ba77bc189d52d1909b0 100644 (file)
@@ -21,7 +21,7 @@
  * functions acting on it also work for calendar objects.
  *
  * This widget emits the following signals, besides the ones sent from
- * @ref Elm_Layout:
+ * @ref Elm_Layout :
  * - @c "changed" - emitted when the date in the calendar is changed.
  * - @c "display,changed" - emitted when the current month displayed in the
  * calendar is changed.
index 10c4899476bada99908e265e5856b08b9a3ad6dd..114f712a4a72eabb9c0ffdcf40cd487d90b297fa 100644 (file)
@@ -27,7 +27,7 @@
  * functions acting on it also work for check objects.
  *
  * This widget emits the following signals, besides the ones sent from
- * @ref Elm_Layout:
+ * @ref Elm_Layout :
  * - @c "changed" - This is called whenever the user changes the state of
  *             the check objects (@p event_info is always @c NULL).
  * - @c "focused" - When the check has received focus. (since 1.8)
index c58dda12e957e4a9976e90425250dd5462164c6e..8c08eca4493323fc9514b8dc475a7d9a72ba189a 100644 (file)
@@ -19,7 +19,7 @@
  * functions acting on it also work for check objects.
  *
  * This widget emits the following signals, besides the ones sent from
- * @ref Elm_Layout:
+ * @ref Elm_Layout :
  * - @c "changed" - When the color value changes on selector
  *   event_info is NULL.
  * - @c "color,item,selected" - When user clicks on color item. The
index 3644cab876060ccf26523a8c8d46759d53e3f836..efd618c37c305f6495cf6b3f713bb25c33aa797a 100644 (file)
@@ -355,6 +355,9 @@ EAPI void         elm_config_scroll_page_scroll_friction_set(double friction);
  * Get enable status of context menu disabled.
  *
  * @see elm_config_context_menu_disabled_set()
+ *
+ * @return @c EINA_TRUE if context menu is disabled, otherwise @c EINA_FALSE.
+ *
  * @ingroup Elm_Entry
  * @since 1.17
  */
index 7f9f84998217208ca19da5d9c53d0c520d4cddda..ce16fd440a0d1a9f10f2d657cc2bbdf44174f382 100644 (file)
@@ -23,7 +23,7 @@
  * functions acting on it also work for conformant objects.
  *
  * This widget emits the following signals, besides the ones sent from
- * @ref Elm_Layout:
+ * @ref Elm_Layout :
  * @li "virtualkeypad,state,on": if virtualkeypad state is switched to "on".
  * (since 1.8)
  * @li "virtualkeypad,state,off": if virtualkeypad state is switched to "off".
index a1ffade472c2379274cb5e5f7ec3dec82c7d616b..dc93374b3173ff0bf2e691295aa7590a3bea5c30 100644 (file)
  * @section entry-signals Emitted signals
  *
  * This widget emits the following signals, besides the ones sent from
- * @ref Elm_Layout:
+ * @ref Elm_Layout :
  * @li "aborted": The escape key was pressed on a single line entry. (since 1.7)
  * @li "activated": The enter key was pressed on a single line entry.
  * @li "anchor,clicked": An anchor has been clicked. The event_info
index 218eb09884221d89cd3c6d0f620d51280f4b49db..468887f46d475aa0db1218a8539d178cbdda0946 100644 (file)
@@ -65,6 +65,7 @@ EAPI const char        *elm_entry_entry_get(const Evas_Object *obj);
  *
  * @ingroup Elm_Entry
  *
+ * @param[in] obj The entry object
  * @param[in] file The path to the file to load and save
  * @param[in] format The file format
  *
@@ -83,6 +84,7 @@ EAPI Eina_Bool          elm_entry_file_set(Evas_Object *obj, const char *file, E
  *
  * @ingroup Elm_Entry
  *
+ * @param[in] obj The entry object
  * @param[out] file The path to the file to load and save
  * @param[out] format The file format
  *
index 3eb1f73ce2953a147ab8bc0935d71489f34e7853..47781c719ddcdc575ca8a28bc2e36696d4227218 100644 (file)
  * table by specifying the row and column where the object should be
  * added, and any column or row span, if necessary.
  *
- * Again, we could have this design by adding a @ref table widget to a
+ * Again, we could have this design by adding a @ref Elm_Table widget to a
  * @c SWALLOW part, using elm_layout_content_set(). The same
  * difference happens here when choosing to use the layout table (a
- * @c TABLE part) instead of the @ref table in a @c SWALLOW part. It's
+ * @c TABLE part) instead of the @ref Elm_Table in a @c SWALLOW part. It's
  * just a matter of convenience.
  *
  * The layout table can be used through the @c elm_layout_table_* set of