Modify comments for Entry,GenGird,GenItem,GenList,GenListItem,Window 15/145815/2
authorqian.sui <qian.sui@samsung.com>
Thu, 24 Aug 2017 03:20:49 +0000 (11:20 +0800)
committerqian.sui <qian.sui@samsung.com>
Thu, 24 Aug 2017 03:51:18 +0000 (11:51 +0800)
Change-Id: Id36ac90cd881410fc7644b96d68635f3dddc6803
Signed-off-by: qian.sui <qian.sui@samsung.com>
src/ElmSharp/ElmSharp/Entry.cs
src/ElmSharp/ElmSharp/GenGrid.cs [changed mode: 0644->0755]
src/ElmSharp/ElmSharp/GenItem.cs [changed mode: 0644->0755]
src/ElmSharp/ElmSharp/GenList.cs [changed mode: 0644->0755]
src/ElmSharp/ElmSharp/GenListItem.cs [changed mode: 0644->0755]
src/ElmSharp/ElmSharp/Window.cs [changed mode: 0644->0755]

index 50f3c4a..9604687 100755 (executable)
@@ -728,10 +728,10 @@ namespace ElmSharp
         /// <summary>
         /// Hides the input panel (virtual keyboard).
         /// </summary>
-        /// <remark>
+        /// <remarks>
         /// Note that the input panel is shown or hidden automatically according to the focus state of the entry widget.
         /// This API can be used in case of manually controlling by using SetInputPanelEnabled(false).
-        /// </remark>
+        /// </remarks>
         public void HideInputPanel()
         {
             Interop.Elementary.elm_entry_input_panel_hide(RealHandle);
@@ -868,7 +868,7 @@ namespace ElmSharp
         /// <summary>
         /// This removes a custom item provider to the list for that entry.
         /// </summary>
-        /// <param name="itemProvider">This function is used to provide items.</param>
+        /// <param name="func">This function is used to provide items.</param>
         public void RemoveItemProvider(Func<string, EvasObject> func)
         {
             if (_itemsProvider.ContainsKey(func))
old mode 100644 (file)
new mode 100755 (executable)
index 2b1a6ee..fc1f3fc
@@ -471,7 +471,7 @@ namespace ElmSharp
         /// </summary>
         /// <param name="itemClass">The itemClass defines how to display the data.</param>
         /// <param name="data">The item data.</param>
-        /// <param name="func">User defined comparison function that defines the sort order based on gengrid item and its data.</param>
+        /// <param name="comparison">User defined comparison function that defines the sort order based on gengrid item and its data.</param>
         /// <returns>Return a gengrid item that contains data and itemClass.</returns>
         public GenGridItem InsertSorted(GenItemClass itemClass, object data, Comparison<object> comparison)
         {
@@ -543,10 +543,10 @@ namespace ElmSharp
         /// </summary>
         /// <param name="x">The input x coordinate</param>
         /// <param name="y">The input y coordinate</param>
-        /// <param name="positionX">The position relative to the item returned here.
+        /// <param name="portionX">The position relative to the item returned here.
         /// -1, 0 or 1, depending if the coordinate is on the left portion of that item(-1), on the middle section(0) or on the right part(1).
         /// </param>
-        /// <param name="positionY">The position relative to the item returned here
+        /// <param name="portionY">The position relative to the item returned here
         /// -1, 0 or 1, depending if the coordinate is on the upper portion of that item (-1), on the middle section (0) or on the lower part (1).
         /// </param>
         /// <returns></returns>
old mode 100644 (file)
new mode 100755 (executable)
index ac609b0..90b3325
@@ -18,6 +18,9 @@ using System;
 
 namespace ElmSharp
 {
+    /// <summary>
+    /// Enumeration for select mode of GenItem.
+    /// </summary>
     public enum GenItemSelectionMode
     {
         /// <summary>
old mode 100644 (file)
new mode 100755 (executable)
index ecb20e4..161580c
@@ -484,7 +484,6 @@ namespace ElmSharp
         /// <param name="itemClass">The itemClass defines how to display the data.</param>
         /// <param name="data">The item data.</param>
         /// <param name="type">The genlist item type.</param>
-        /// <param name="parent">The parent item, otherwise null if there is no parent item.</param>
         /// <returns>Return a new added genlist item that contains data and itemClass.</returns>
         public GenListItem Prepend(GenItemClass itemClass, object data, GenListItemType type)
         {
@@ -567,7 +566,7 @@ namespace ElmSharp
         /// </summary>
         /// <param name="itemClass">The itemClass defines how to display the data.</param>
         /// <param name="data">The item data.</param>
-        /// <param name="before">The item after which to place this new one.</param>
+        /// <param name="after">The item after which to place this new one.</param>
         /// <param name="type">The genlist item type.</param>
         /// <param name="parent">The parent item, otherwise null if there is no parent item.</param>
         /// <returns>Return a new added genlist item that contains data and itemClass.</returns>
@@ -594,7 +593,7 @@ namespace ElmSharp
         /// </summary>
         /// <param name="itemClass">The itemClass defines how to display the data.</param>
         /// <param name="data">The item data.</param>
-        /// <param name="func">User defined comparison function that defines the sort order based on genlist item and its data.</param>
+        /// <param name="comparison">User defined comparison function that defines the sort order based on genlist item and its data.</param>
         /// <param name="type">The genlist item type.</param>
         /// <param name="parent">The parent item, otherwise null if there is no parent item.</param>
         /// <returns>Return a genlist item that contains data and itemClass.</returns>
old mode 100644 (file)
new mode 100755 (executable)
index d1f7a85..f12ff86
@@ -121,7 +121,6 @@ namespace ElmSharp
         /// <summary>
         /// Demote an item to the end of the list.
         /// </summary>
-        /// <param name="item">The genlistitem object</param>
         public void DemoteItem()
         {
             Interop.Elementary.elm_genlist_item_demote(Handle);
@@ -285,9 +284,9 @@ namespace ElmSharp
         /// <summary>
         /// Remove all sub-items (children) of the given item.
         /// </summary>
-        /// <remark>
+        /// <remarks>
         /// This removes all items that are children (and their descendants) of the given item it.
-        /// </remark>
+        /// </remarks>
         public void ClearSubitems()
         {
             Interop.Elementary.elm_genlist_item_subitems_clear(Handle);
old mode 100644 (file)
new mode 100755 (executable)
index 71d18f5..ef7b649
@@ -891,10 +891,10 @@ namespace ElmSharp
         /// <summary>
         /// Create a socket to provide the service for Plug widget.
         /// </summary>
-        /// <param name="serviceName">A service name</param>
-        /// <param name="serviceNumber">A number (any value, 0 being the common default) to differentiate multiple instances of services with the same name.</param>
+        /// <param name="name">A service name</param>
+        /// <param name="number">A number (any value, 0 being the common default) to differentiate multiple instances of services with the same name.</param>
         /// <param name="systemWide">A boolean that if true, specifies to create a system-wide service all users can connect to, otherwise the service is private to the user id that created the service.</param>
-        /// <returns></returns>
+        /// <returns>If true, create successfull, otherwise false</returns>
         public bool CreateServiceSocket(string name, int number, bool systemWide)
         {
             return Interop.Elementary.elm_win_socket_listen(RealHandle, name, number, systemWide);