From c4b35b2b61d49a6e04c7b526f33effea1160ca5f Mon Sep 17 00:00:00 2001 From: "qian.sui" Date: Thu, 24 Aug 2017 11:20:49 +0800 Subject: [PATCH] Modify comments for Entry,GenGird,GenItem,GenList,GenListItem,Window Change-Id: Id36ac90cd881410fc7644b96d68635f3dddc6803 Signed-off-by: qian.sui --- src/ElmSharp/ElmSharp/Entry.cs | 6 +++--- src/ElmSharp/ElmSharp/GenGrid.cs | 6 +++--- src/ElmSharp/ElmSharp/GenItem.cs | 3 +++ src/ElmSharp/ElmSharp/GenList.cs | 5 ++--- src/ElmSharp/ElmSharp/GenListItem.cs | 5 ++--- src/ElmSharp/ElmSharp/Window.cs | 6 +++--- 6 files changed, 16 insertions(+), 15 deletions(-) mode change 100644 => 100755 src/ElmSharp/ElmSharp/GenGrid.cs mode change 100644 => 100755 src/ElmSharp/ElmSharp/GenItem.cs mode change 100644 => 100755 src/ElmSharp/ElmSharp/GenList.cs mode change 100644 => 100755 src/ElmSharp/ElmSharp/GenListItem.cs mode change 100644 => 100755 src/ElmSharp/ElmSharp/Window.cs diff --git a/src/ElmSharp/ElmSharp/Entry.cs b/src/ElmSharp/ElmSharp/Entry.cs index 50f3c4a..9604687 100755 --- a/src/ElmSharp/ElmSharp/Entry.cs +++ b/src/ElmSharp/ElmSharp/Entry.cs @@ -728,10 +728,10 @@ namespace ElmSharp /// /// Hides the input panel (virtual keyboard). /// - /// + /// /// 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). - /// + /// public void HideInputPanel() { Interop.Elementary.elm_entry_input_panel_hide(RealHandle); @@ -868,7 +868,7 @@ namespace ElmSharp /// /// This removes a custom item provider to the list for that entry. /// - /// This function is used to provide items. + /// This function is used to provide items. public void RemoveItemProvider(Func func) { if (_itemsProvider.ContainsKey(func)) diff --git a/src/ElmSharp/ElmSharp/GenGrid.cs b/src/ElmSharp/ElmSharp/GenGrid.cs old mode 100644 new mode 100755 index 2b1a6ee..fc1f3fc --- a/src/ElmSharp/ElmSharp/GenGrid.cs +++ b/src/ElmSharp/ElmSharp/GenGrid.cs @@ -471,7 +471,7 @@ namespace ElmSharp /// /// The itemClass defines how to display the data. /// The item data. - /// User defined comparison function that defines the sort order based on gengrid item and its data. + /// User defined comparison function that defines the sort order based on gengrid item and its data. /// Return a gengrid item that contains data and itemClass. public GenGridItem InsertSorted(GenItemClass itemClass, object data, Comparison comparison) { @@ -543,10 +543,10 @@ namespace ElmSharp /// /// The input x coordinate /// The input y coordinate - /// The position relative to the item returned here. + /// 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). /// - /// The position relative to the item returned here + /// 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). /// /// diff --git a/src/ElmSharp/ElmSharp/GenItem.cs b/src/ElmSharp/ElmSharp/GenItem.cs old mode 100644 new mode 100755 index ac609b0..90b3325 --- a/src/ElmSharp/ElmSharp/GenItem.cs +++ b/src/ElmSharp/ElmSharp/GenItem.cs @@ -18,6 +18,9 @@ using System; namespace ElmSharp { + /// + /// Enumeration for select mode of GenItem. + /// public enum GenItemSelectionMode { /// diff --git a/src/ElmSharp/ElmSharp/GenList.cs b/src/ElmSharp/ElmSharp/GenList.cs old mode 100644 new mode 100755 index ecb20e4..161580c --- a/src/ElmSharp/ElmSharp/GenList.cs +++ b/src/ElmSharp/ElmSharp/GenList.cs @@ -484,7 +484,6 @@ namespace ElmSharp /// The itemClass defines how to display the data. /// The item data. /// The genlist item type. - /// The parent item, otherwise null if there is no parent item. /// Return a new added genlist item that contains data and itemClass. public GenListItem Prepend(GenItemClass itemClass, object data, GenListItemType type) { @@ -567,7 +566,7 @@ namespace ElmSharp /// /// The itemClass defines how to display the data. /// The item data. - /// The item after which to place this new one. + /// The item after which to place this new one. /// The genlist item type. /// The parent item, otherwise null if there is no parent item. /// Return a new added genlist item that contains data and itemClass. @@ -594,7 +593,7 @@ namespace ElmSharp /// /// The itemClass defines how to display the data. /// The item data. - /// User defined comparison function that defines the sort order based on genlist item and its data. + /// User defined comparison function that defines the sort order based on genlist item and its data. /// The genlist item type. /// The parent item, otherwise null if there is no parent item. /// Return a genlist item that contains data and itemClass. diff --git a/src/ElmSharp/ElmSharp/GenListItem.cs b/src/ElmSharp/ElmSharp/GenListItem.cs old mode 100644 new mode 100755 index d1f7a85..f12ff86 --- a/src/ElmSharp/ElmSharp/GenListItem.cs +++ b/src/ElmSharp/ElmSharp/GenListItem.cs @@ -121,7 +121,6 @@ namespace ElmSharp /// /// Demote an item to the end of the list. /// - /// The genlistitem object public void DemoteItem() { Interop.Elementary.elm_genlist_item_demote(Handle); @@ -285,9 +284,9 @@ namespace ElmSharp /// /// Remove all sub-items (children) of the given item. /// - /// + /// /// This removes all items that are children (and their descendants) of the given item it. - /// + /// public void ClearSubitems() { Interop.Elementary.elm_genlist_item_subitems_clear(Handle); diff --git a/src/ElmSharp/ElmSharp/Window.cs b/src/ElmSharp/ElmSharp/Window.cs old mode 100644 new mode 100755 index 71d18f5..ef7b649 --- a/src/ElmSharp/ElmSharp/Window.cs +++ b/src/ElmSharp/ElmSharp/Window.cs @@ -891,10 +891,10 @@ namespace ElmSharp /// /// Create a socket to provide the service for Plug widget. /// - /// A service name - /// A number (any value, 0 being the common default) to differentiate multiple instances of services with the same name. + /// A service name + /// A number (any value, 0 being the common default) to differentiate multiple instances of services with the same name. /// 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. - /// + /// If true, create successfull, otherwise false public bool CreateServiceSocket(string name, int number, bool systemWide) { return Interop.Elementary.elm_win_socket_listen(RealHandle, name, number, systemWide); -- 2.7.4