From: Editor Lionbridge Date: Mon, 11 Dec 2017 08:45:32 +0000 (+0530) Subject: Review Elmsharp API cs files X-Git-Tag: 4.0.1-preview1-00048~4 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=refs%2Fchanges%2F58%2F163458%2F8;p=platform%2Fcore%2Fcsapi%2Ftizenfx.git Review Elmsharp API cs files PS2: Additional Fixes PS4: Additional Fixes PS5: Additional Fixes PS6: Edited as per comment PS7: Feedback Implementation Change-Id: I774e173e2c860918b226f98dc35593a240b4ad58 --- diff --git a/src/ElmSharp/ElmSharp/AccessRole.cs b/src/ElmSharp/ElmSharp/AccessRole.cs index 0d7311d..fdc8b49 100755 --- a/src/ElmSharp/ElmSharp/AccessRole.cs +++ b/src/ElmSharp/ElmSharp/AccessRole.cs @@ -18,89 +18,89 @@ namespace ElmSharp.Accessible { /// - /// Enumeration for AccessRole. + /// Enumeration for the AccessRole. /// /// preview public enum AccessRole { /// - /// Invalid + /// Invalid. /// Invalid, /// - /// AcceleratorLabel role + /// AcceleratorLabel role. /// AcceleratorLabel, /// - /// Alert role + /// Alert role. /// Alert, /// - /// Animation role + /// Animation role. /// Animation, /// - /// Arrow role + /// Arrow role. /// Arrow, /// - /// Calendar role + /// Calendar role. /// Calendar, /// - /// Canvas role + /// Canvas role. /// Canvas, /// - /// CheckBox role + /// CheckBox role. /// CheckBox, /// - /// CheckMenuItem role + /// CheckMenuItem role. /// CheckMenuItem, /// - /// ColorChooser role + /// ColorChooser role. /// ColorChooser, /// - /// ColumnHeader role + /// ColumnHeader role. /// ColumnHeader, /// - /// ComboBox role + /// ComboBox role. /// ComboBox, /// - /// DateEditor role + /// DateEditor role. /// DateEditor, /// - /// DesktopIcon role + /// DesktopIcon role. /// DesktopIcon, /// - /// DesktopFrame role + /// DesktopFrame role. /// DesktopFrame, /// - /// Dial role + /// Dial role. /// Dial, /// - /// Dialog role + /// Dialog role. /// Dialog, /// - /// DirectoryPane role + /// DirectoryPane role. /// DirectoryPane, /// - /// DrawingArea role + /// DrawingArea role. /// DrawingArea, /// - /// FileChooser role + /// FileChooser role. /// FileChooser, /// @@ -108,35 +108,35 @@ namespace ElmSharp.Accessible /// Filler, /// - /// FocusTraversable role + /// FocusTraversable role. /// FocusTraversable, /// - /// FontChooser role + /// FontChooser role. /// FontChooser, /// - /// Frame role + /// Frame role. /// Frame, /// - /// GlassPane role + /// GlassPane role. /// GlassPane, /// - /// HtmlContainer role + /// HtmlContainer role. /// HtmlContainer, /// - /// Icon role + /// Icon role. /// Icon, /// - /// Image role + /// Image role. /// Image, /// - /// InternalFrame role + /// InternalFrame role. /// InternalFrame, /// @@ -144,295 +144,295 @@ namespace ElmSharp.Accessible /// Label, /// - /// LayeredPane role + /// LayeredPane role. /// LayeredPane, /// - /// List role + /// List role. /// List, /// - /// ListItem role + /// ListItem role. /// ListItem, /// - /// Menu role + /// Menu role. /// Menu, /// - /// MenuBar role + /// MenuBar role. /// MenuBar, /// - /// MenuItem role + /// MenuItem role. /// MenuItem, /// - /// OptionPane role + /// OptionPane role. /// OptionPane, /// - /// PageTab role + /// PageTab role. /// PageTab, /// - /// PageTabList role + /// PageTabList role. /// PageTabList, /// - /// Panel role + /// Panel role. /// Panel, /// - /// PasswordText role + /// PasswordText role. /// PasswordText, /// - /// PopupMenu role + /// PopupMenu role. /// PopupMenu, /// - /// ProgressBar role + /// ProgressBar role. /// ProgressBar, /// - /// PushButton role + /// PushButton role. /// PushButton, /// - /// RadioButton role + /// RadioButton role. /// RadioButton, /// - /// RadioMenuItem role + /// RadioMenuItem role. /// RadioMenuItem, /// - /// RootPane role + /// RootPane role. /// RootPane, /// - /// RowHeader role + /// RowHeader role. /// RowHeader, /// - /// ScrollBar role + /// ScrollBar role. /// ScrollBar, /// - /// ScrollPane role + /// ScrollPane role. /// ScrollPane, /// - /// Separator role + /// Separator role. /// Separator, /// - /// Slider role + /// Slider role. /// Slider, /// - /// SpinButton role + /// SpinButton role. /// SpinButton, /// - /// SplitPane role + /// SplitPane role. /// SplitPane, /// - /// StatusBar role + /// StatusBar role. /// StatusBar, /// - /// Table role + /// Table role. /// Table, /// - /// TableCell role + /// TableCell role. /// TableCell, /// - /// TableColumnHeader role + /// TableColumnHeader role. /// TableColumnHeader, /// - /// TableRowHeader role + /// TableRowHeader role. /// TableRowHeader, /// - /// TearoffMenuItem role + /// TearoffMenuItem role. /// TearoffMenuItem, /// - /// Terminal role + /// Terminal role. /// Terminal, /// - /// Text role + /// Text role. /// Text, /// - /// ToggleButton role + /// ToggleButton role. /// ToggleButton, /// - /// ToolBar role + /// ToolBar role. /// ToolBar, /// - /// ToolTip role + /// ToolTip role. /// ToolTip, /// - /// Tree role + /// Tree role. /// Tree, /// - /// TreeTable role + /// TreeTable role. /// TreeTable, /// - /// Unknown + /// Unknown role. /// Unknown, /// - /// Viewport role + /// Viewport role. /// Viewport, /// - /// Window role + /// Window role. /// Window, /// - /// Extended role + /// Extended role. /// Extended, /// - /// Header role + /// Header role. /// Header, /// - /// Footer role + /// Footer role. /// Footer, /// - /// Paragraph + /// Paragraph role. /// Paragraph, /// - /// Ruler role + /// Ruler role. /// Ruler, /// - /// Application role + /// Application role. /// Application, /// - /// Autocomplete role + /// Autocomplete role. /// Autocomplete, /// - /// Editbar role + /// Editbar role. /// Editbar, /// - /// Embedded role + /// Embedded role. /// Embedded, /// - /// Entry role + /// Entry role. /// Entry, /// - /// Chart role + /// Chart role. /// Chart, /// - /// Caption role + /// Caption role. /// Caption, /// - /// DocumentFrame role + /// DocumentFrame role. /// DocumentFrame, /// - /// Heading role + /// Heading role. /// Heading, /// - /// Page role + /// Page role. /// Page, /// - /// Section role + /// Section role. /// Section, /// - /// RedundantObject role + /// RedundantObject role. /// RedundantObject, /// - /// Form role + /// Form role. /// Form, /// - /// Link role + /// Link role. /// Link, /// - /// InputMethodWindow role + /// InputMethodWindow role. /// InputMethodWindow, /// - /// TableRow role + /// TableRow role. /// TableRow, /// - /// TreeItem role + /// TreeItem role. /// TreeItem, /// - /// DocumentSpreadsheet role + /// DocumentSpreadsheet role. /// DocumentSpreadsheet, /// - /// DocumentPresentation role + /// DocumentPresentation role. /// DocumentPresentation, /// - /// DocumentText role + /// DocumentText role. /// DocumentText, /// - /// DocumentWeb role + /// DocumentWeb role. /// DocumentWeb, /// - /// DocumentEmail role + /// DocumentEmail role. /// DocumentEmail, /// - /// Comment role + /// Comment role. /// Comment, /// - /// ListBox role + /// ListBox role. /// ListBox, /// - /// Grouping role + /// Grouping role. /// Grouping, /// - /// ImageMap role + /// ImageMap role. /// ImageMap, /// - /// Notification role + /// Notification role. /// Notification, /// - /// InfoBar role + /// InfoBar role. /// InfoBar } diff --git a/src/ElmSharp/ElmSharp/AccessibleObject.cs b/src/ElmSharp/ElmSharp/AccessibleObject.cs index 18ea109..4114094 100755 --- a/src/ElmSharp/ElmSharp/AccessibleObject.cs +++ b/src/ElmSharp/ElmSharp/AccessibleObject.cs @@ -19,17 +19,17 @@ using System; namespace ElmSharp.Accessible { /// - /// The delegate to define how to provide informations for or . + /// The delegate to define how to provide information for or . /// /// The sender obj. - /// Return information for Name or Description. + /// Return information for name or description. /// preview public delegate string AccessibleInfoProvider (AccessibleObject obj); /// /// It's a base abstract class for . - /// It provides available definitions for the screen reader, such as , , , etc. - /// There's many the relationship between two accessible objects, like , , , , etc. + /// It provides the available definitions for the screen reader, such as , , , etc. + /// There are many relationships between two accessible objects, like , , , , etc. /// /// preview public abstract class AccessibleObject : EvasObject, IAccessibleObject @@ -58,7 +58,7 @@ namespace ElmSharp.Accessible } /// - /// Gets or sets the role of the object in accessibility domain. + /// Gets or sets the role of the object in an accessibility domain. /// AccessRole IAccessibleObject.Role { @@ -74,7 +74,7 @@ namespace ElmSharp.Accessible } /// - /// Gets or sets highlightable of given widget. + /// Gets or sets the highlightable of a given widget. /// bool IAccessibleObject.CanHighlight { @@ -89,10 +89,10 @@ namespace ElmSharp.Accessible } /// - /// Gets or sets the translation domain of "name" and "description" properties. - /// Translation domain should be set if application wants to support i18n for accessibily "name" and "description" properties. - /// When translation domain is set values of "name" and "description" properties will be translated with dgettext function using current translation domain as "domainname" parameter. - /// It is application developer responsibility to ensure that translation files are loaded and binded to translation domain when accessibility is enabled. + /// Gets or sets the translation domain of the "name" and "description" properties. + /// The translation domain should be set if the application wants to support i18n for accessing the "name" and "description" properties. + /// When the translation domain is set, values of the "name" and "description" properties will be translated with dgettext function using the current translation domain as "domainname" parameter. + /// It is the application developers responsibility to ensure that translation files are loaded and binded to the translation domain when accessibility is enabled. /// string IAccessibleObject.TranslationDomain { @@ -122,7 +122,7 @@ namespace ElmSharp.Accessible } /// - /// Gets or sets contextual information about object. + /// Gets or sets the contextual information about an object. /// string IAccessibleObject.Description { @@ -166,7 +166,7 @@ namespace ElmSharp.Accessible } /// - /// Gets or sets the delegate for . + /// Gets or sets the delegate for . /// AccessibleInfoProvider IAccessibleObject.DescriptionProvider { @@ -195,9 +195,9 @@ namespace ElmSharp.Accessible } /// - /// Creates and initializes a new instance of the AccessibleObject class with parent EvasObject class parameter. + /// Creates and initializes a new instance of the AccessibleObject class with the parent EvasObject class parameter. /// - /// Parent EvasObject class + /// Parent EvasObject class. /// preview public AccessibleObject(EvasObject parent) : base(parent) { @@ -213,10 +213,10 @@ namespace ElmSharp.Accessible /// /// Defines the relationship between two accessible objects. - /// Relationships can be queried by Assistive Technology clients to provide customized feedback, improving overall user experience. - /// AppendRelation API is asymmetric, which means that appending, for example, relation from object A to B, do not append relation from object B to object A. + /// Relationships can be queried by the Assistive Technology clients to provide customized feedback, and improving overall user experience. + /// AppendRelation API is asymmetric, which means that appending, for example, relation from object A to B, does not append the relation from object B to object A. /// - /// The relationship between source object and target object of a given type. + /// The relationship between the source object and target object of a given type. void IAccessibleObject.AppendRelation(IAccessibleRelation relation) { if (relation.Target == null) throw new ArgumentException("Target of Accessibility relation can not be null"); @@ -226,7 +226,7 @@ namespace ElmSharp.Accessible /// /// Removes the relationship between two accessible objects. /// - /// The relationship between source object and target object of a given type. + /// The relationship between the source object and target object of a given type. void IAccessibleObject.RemoveRelation(IAccessibleRelation relation) { if (relation.Target == null) throw new ArgumentException("Target of Accessibility relation can not be null"); @@ -234,7 +234,7 @@ namespace ElmSharp.Accessible } /// - /// Highlights accessible widget. + /// Highlights the accessible widget. /// /// preview public void Highlight() @@ -243,7 +243,7 @@ namespace ElmSharp.Accessible } /// - /// Clears highlight of accessible widget. + /// Clears the highlight of the accessible widget. /// /// preview public void Unhighlight() diff --git a/src/ElmSharp/ElmSharp/AccessibleRelation.cs b/src/ElmSharp/ElmSharp/AccessibleRelation.cs index 488cf80..0db85c8 100755 --- a/src/ElmSharp/ElmSharp/AccessibleRelation.cs +++ b/src/ElmSharp/ElmSharp/AccessibleRelation.cs @@ -18,7 +18,7 @@ namespace ElmSharp.Accessible { /// - /// IAccessibleRelation is a interface which defines the relationship between two accessible objects. + /// IAccessibleRelation is an interface, which defines the relationship between two accessible objects. /// /// preview public interface IAccessibleRelation @@ -38,13 +38,13 @@ namespace ElmSharp.Accessible } /// - /// To define label info for accessible object. + /// To define the label info for an accessible object. /// /// preview public class LabelledBy : IAccessibleRelation { /// - /// Gets or sets the target object which is LabelledBy. + /// Gets or sets the target object, which is LabelledBy. /// /// preview public AccessibleObject Target { get; set; } @@ -60,7 +60,7 @@ namespace ElmSharp.Accessible } /// - /// To define label info for accessible object. + /// To define the label info for an accessible object. /// /// preview public class LabelFor : IAccessibleRelation @@ -82,13 +82,13 @@ namespace ElmSharp.Accessible } /// - /// To define control relationship for accessible object. + /// To define the control relationship for an accessible object. /// /// preview public class ControllerFor : IAccessibleRelation { /// - /// Gets or sets the target object which is ControllerFor. + /// Gets or sets the target object, which is ControllerFor. /// /// preview public AccessibleObject Target { get; set; } @@ -104,13 +104,13 @@ namespace ElmSharp.Accessible } /// - /// To define control relationship for accessible object. + /// To define the control relationship for an accessible object. /// /// preview public class ControlledBy : IAccessibleRelation { /// - /// Gets or sets the target object which is ControlledBy. + /// Gets or sets the target object, which is ControlledBy. /// /// preview public AccessibleObject Target { get; set; } @@ -126,13 +126,13 @@ namespace ElmSharp.Accessible } /// - /// To define member relationship for accessible object. + /// To define the member relationship for an accessible object. /// /// preview public class MemberOf : IAccessibleRelation { /// - /// Gets or sets the target object which is MemberOf. + /// Gets or sets the target object, which is MemberOf. /// /// preview public AccessibleObject Target { get; set; } @@ -148,13 +148,13 @@ namespace ElmSharp.Accessible } /// - /// To define tooltip for accessible object. + /// To define the tooltip for an accessible object. /// /// preview public class TooltipFor : IAccessibleRelation { /// - /// Gets or sets the target object which is TooltipFor. + /// Gets or sets the target object, which is TooltipFor. /// /// preview public AccessibleObject Target { get; set; } @@ -170,13 +170,13 @@ namespace ElmSharp.Accessible } /// - /// To define child for accessible object. + /// To define the child for an accessible object. /// /// preview public class ChildOf : IAccessibleRelation { /// - /// Gets or sets the target object which is ChildOf. + /// Gets or sets the target object, which is ChildOf. /// /// preview public AccessibleObject Target { get; set; } @@ -192,13 +192,13 @@ namespace ElmSharp.Accessible } /// - /// To define parent for accessible object. + /// To define the parent for an accessible object. /// /// preview public class ParentOf : IAccessibleRelation { /// - /// Gets or sets the target object which is ParentOf. + /// Gets or sets the target object, which is ParentOf. /// /// preview public AccessibleObject Target { get; set; } @@ -214,19 +214,19 @@ namespace ElmSharp.Accessible } /// - /// To define extend for accessible object. + /// To define the extend for an accessible object. /// /// preview public class Extended : IAccessibleRelation { /// - /// Gets or sets the target object which is Extended. + /// Gets or sets the target object, which is Extended. /// /// preview public AccessibleObject Target { get; set; } /// - /// Gets the Extended type. + /// Gets the extended type. /// /// preview public int Type @@ -242,7 +242,7 @@ namespace ElmSharp.Accessible public class FlowsTo : IAccessibleRelation { /// - /// Gets or sets the target object which is FlowsTo. + /// Gets or sets the target object, which is FlowsTo. /// /// preview public AccessibleObject Target { get; set; } @@ -264,7 +264,7 @@ namespace ElmSharp.Accessible public class FlowsFrom : IAccessibleRelation { /// - /// Gets or sets the target object which is FlowsFrom. + /// Gets or sets the target object, which is FlowsFrom. /// /// preview public AccessibleObject Target { get; set; } @@ -280,13 +280,13 @@ namespace ElmSharp.Accessible } /// - /// To define subwindow for accessible object. + /// To define the subwindow for an accessible object. /// /// preview public class SubwindowOf : IAccessibleRelation { /// - /// Gets or sets the target object which is SubwindowOf. + /// Gets or sets the target object, which is SubwindowOf. /// /// preview public AccessibleObject Target { get; set; } @@ -302,13 +302,13 @@ namespace ElmSharp.Accessible } /// - /// To define embed for accessible object. + /// To define the embed for an accessible object. /// /// preview public class Embeds : IAccessibleRelation { /// - /// Gets or sets the target object which is Embeds. + /// Gets or sets the target object ,which is Embeds. /// /// preview public AccessibleObject Target { get; set; } @@ -324,13 +324,13 @@ namespace ElmSharp.Accessible } /// - /// To define embed for accessible object. + /// To define the embed for an accessible object. /// /// preview public class EmbeddedBy : IAccessibleRelation { /// - /// Gets or sets the target object which is EmbeddedBy. + /// Gets or sets the target object, which is EmbeddedBy. /// /// preview public AccessibleObject Target { get; set; } @@ -346,13 +346,13 @@ namespace ElmSharp.Accessible } /// - /// To define popup for accessible object. + /// To define the popup for an accessible object. /// /// preview public class PopupFor : IAccessibleRelation { /// - /// Gets or sets the target object which is PopupFor. + /// Gets or sets the target object, which is PopupFor. /// /// preview public AccessibleObject Target { get; set; } @@ -368,13 +368,13 @@ namespace ElmSharp.Accessible } /// - /// To define parent window for accessible object. + /// To define the parent window for an accessible object. /// /// preview public class ParentWindowOf : IAccessibleRelation { /// - /// Gets or sets the target object which is ParentWindowOf. + /// Gets or sets the target object, which is ParentWindowOf. /// /// preview public AccessibleObject Target { get; set; } @@ -390,13 +390,13 @@ namespace ElmSharp.Accessible } /// - /// To define description for accessible object. + /// To define the description for an accessible object. /// /// preview public class DescriptionFor : IAccessibleRelation { /// - /// Gets or sets the target object which is DescriptionFor. + /// Gets or sets the target object, which is DescriptionFor. /// /// preview public AccessibleObject Target { get; set; } @@ -412,13 +412,13 @@ namespace ElmSharp.Accessible } /// - /// To define description for accessible object. + /// To define the description for an accessible object. /// /// preview public class DescribedBy : IAccessibleRelation { /// - /// Gets or sets the target object which is DescribedBy. + /// Gets or sets the target object, which is DescribedBy. /// /// preview public AccessibleObject Target { get; set; } diff --git a/src/ElmSharp/ElmSharp/AccessibleUtil.cs b/src/ElmSharp/ElmSharp/AccessibleUtil.cs index 0be2e91..eb82a71 100755 --- a/src/ElmSharp/ElmSharp/AccessibleUtil.cs +++ b/src/ElmSharp/ElmSharp/AccessibleUtil.cs @@ -21,25 +21,25 @@ using System.Threading.Tasks; namespace ElmSharp.Accessible { /// - /// Enumeration for ReadingStatus. + /// Enumeration for the ReadingStatus. /// /// preview public enum ReadingStatus { /// - /// Unknown status + /// Unknown status. /// Unknown, /// - /// Cancelled status + /// Cancelled status. /// Cancelled, /// - /// Stopped status + /// Stopped status. /// Stoppped, /// - /// Skipped status + /// Skipped status. /// Skipped } @@ -76,11 +76,11 @@ namespace ElmSharp.Accessible } /// - /// Reads given text by screen reader. + /// Reads the given text by a screen reader. /// /// The reading text. - /// If true, reading can be discarded by subsequent reading requests, if false the reading must finish before next reading request can be started. - /// Return a task with reading status. + /// If true, reading can be discarded by subsequent reading requests. If false, reading must be finished before the next reading request can be started. + /// Return a task with the reading status. /// preview public static Task Say(string text, bool discardable) { diff --git a/src/ElmSharp/ElmSharp/Background.cs b/src/ElmSharp/ElmSharp/Background.cs index 9f2e955..d6114b7 100755 --- a/src/ElmSharp/ElmSharp/Background.cs +++ b/src/ElmSharp/ElmSharp/Background.cs @@ -28,7 +28,7 @@ namespace ElmSharp /// /// Creates and initializes a new instance of the Background class. /// - /// The EvasObject to which the new Background will be attached as a child. + /// The EvasObject to which the new background will be attached as a child. /// preview public Background(EvasObject parent) : base(parent) { @@ -36,7 +36,7 @@ namespace ElmSharp } /// - /// Sets or gets color to Background. + /// Sets or gets the color to the background. /// /// preview public override Color Color @@ -67,7 +67,7 @@ namespace ElmSharp } /// - /// Sets or gets image to Background. + /// Sets or gets the image to the background. /// /// preview public string File @@ -87,8 +87,8 @@ namespace ElmSharp /// /// /// This sets how the background widget will display its image. - /// This will only work if the File was previously set with an image file on obj. - /// The image can be display tiled, scaled, centered or stretched. scaled by default. + /// This will only work if the file was previously set with an image file on object. + /// The image can be display tiled, scaled, centered, or stretched. Scaled by default. /// /// preview public BackgroundOptions BackgroundOption @@ -104,7 +104,7 @@ namespace ElmSharp } /// - /// Set the size of the pixmap representation of the image set on a given background widget. + /// Sets the size of the pixmap representation of the image set on a given background widget. /// This method just makes sense if an image file was set. /// This is just a hint for the underlying system. /// The real size of the pixmap may differ depending on the type of image being loaded, being bigger than requested. @@ -127,8 +127,8 @@ namespace ElmSharp /// /// Creates a widget handle. /// - /// Parent EvasObject - /// Handle IntPtr + /// Parent EvasObject. + /// Handle IntPtr. /// preview protected override IntPtr CreateHandle(EvasObject parent) { @@ -143,18 +143,18 @@ namespace ElmSharp } /// - /// Enumeration for the background type. + /// Enumeration for the background types. /// /// preview public enum BackgroundOptions { /// - /// Centers the background image + /// Centers the background image. /// Center, /// - /// Scales the background image, retaining the aspect ratio + /// Scales the background image, retaining the aspect ratio. /// Scale, @@ -164,7 +164,7 @@ namespace ElmSharp Stretch, /// - /// Tiles the background image at its original size + /// Tiles the background image at its original size. /// Tile } diff --git a/src/ElmSharp/ElmSharp/Box.cs b/src/ElmSharp/ElmSharp/Box.cs index 19a5a9b..1f86354 100755 --- a/src/ElmSharp/ElmSharp/Box.cs +++ b/src/ElmSharp/ElmSharp/Box.cs @@ -19,7 +19,7 @@ using System; namespace ElmSharp { /// - /// The Box is a container used to arranges UI components in a linear order. + /// The Box is a container that is used to arrange UI components in a linear order. /// /// preview public class Box : Container @@ -36,7 +36,7 @@ namespace ElmSharp } /// - /// Sets or gets IsHorizontal value which describe pack direction, vertical is default. + /// Sets or gets the IsHorizontal value, which describe the pack direction. Vertical is default. /// /// preview public bool IsHorizontal @@ -52,7 +52,7 @@ namespace ElmSharp } /// - /// Sets or gets whether the box to arrange its children homogeneously. + /// Sets or gets whether the box has to arrange its children homogeneously. /// /// preview public bool IsHomogeneous @@ -71,12 +71,12 @@ namespace ElmSharp /// Adds an object at the end of the pack list. /// /// - /// Packs "content" object into the Box, placing it last in the list of children objects. - /// The actual position the object will get on screen depends on the layout used. + /// Packs the "content" object into the Box, placing it last in the list of children objects. + /// The actual position of the object will get on the screen depending on the layout used. /// If no custom layout is set, it will be at the bottom or right, /// depending if the Box is vertical or horizontal, respectively. /// - /// The oject be packed + /// The oject to be packed. /// preview public void PackEnd(EvasObject content) { @@ -85,11 +85,11 @@ namespace ElmSharp } /// - /// Adds an "content" object to the beginning of the pack list. + /// Adds a "content" object to the beginning of the pack list. /// /// - /// Pack "content" object into the Box obj, placing it first in the list of children objects. - /// The actual position the object will get on screen depends on the layout used. + /// Packs the "content" object into the box object, placing it first in the list of children objects. + /// The actual position of the object will get on the screen depending on the layout used. /// If no custom layout is set, it will be at the top or left, /// depending if the Box is vertical or horizontal, respectively. /// @@ -102,15 +102,15 @@ namespace ElmSharp } /// - /// Adds an "content "object to the Box after the "after" object. + /// Adds a "content" object to the box after the "after" object. /// /// - /// This will add the "content" to the Box indicated after the object indicated with "after". - /// If "after" is not already in the Box, results are undefined. - /// After means either to the right of the "after" object or below it depending on orientation. + /// This will add the "content" to the box indicated after the object indicated with "after". + /// If "after" is not already in the box, the results are undefined. + /// After means either to the right of the "after" object or below it, depending on orientation. /// - /// The object will be added in Box - /// The object has been added in Box + /// The object will be added in the box. + /// The object has been added in the box. /// preview public void PackAfter(EvasObject content, EvasObject after) { @@ -119,15 +119,15 @@ namespace ElmSharp } /// - /// Adds an "content "object to the Box before the "before" object. + /// Adds a "content" object to the box before the "before" object. /// /// - /// This will add the "content" to the Box indicated before the object indicated with "before". - /// If "before" is not already in the Box, results are undefined. - /// before means either to the left of the "before" object or below it depending on orientation. + /// This will add the "content" to the box indicated before the object indicated with "before". + /// If "before" is not already in the box, the results are undefined. + /// Before means either to the left of the "before" object or below it, depending on orientation. /// - /// The object will be added in Box - /// The object has been added in Box + /// The object will be added in the box. + /// The object has been added in the box. /// preview public void PackBefore(EvasObject content, EvasObject before) { @@ -136,9 +136,9 @@ namespace ElmSharp } /// - /// Remove the "content" oject from Box without deleting it. + /// Removes the "content" object from the box without deleting it. /// - /// The object to unpack + /// The object to unpack. /// preview public void UnPack(EvasObject content) { @@ -147,7 +147,7 @@ namespace ElmSharp } /// - /// Removes all objects from Box container. + /// Removes all the objects from the Box container. /// /// preview public void UnPackAll() @@ -157,10 +157,10 @@ namespace ElmSharp } /// - /// Whenever anything changes that requires the Box in obj to recalculate the size and position of its elements, + /// Whenever any changes that requires the box in object to recalculate the size and position of its elements, /// the function cb will be called to determine what the layout of the children will be. /// - /// The callback function used for layout + /// The callback function used for layout. /// preview public void SetLayoutCallback(Action action) { @@ -172,7 +172,7 @@ namespace ElmSharp } /// - /// Sets the color of exact part to Box's layout parent. + /// Sets the color of the exact part to the box's layout parent. /// /// The name of part class, it could be 'bg', 'elm.swllow.content'. /// The color value. @@ -186,7 +186,7 @@ namespace ElmSharp } /// - /// Gets the color of exact part of Box's layout parent. + /// Gets the color of the exact part of the box's layout parent. /// /// The name of part class, it could be 'bg', 'elm.swllow.content'. /// @@ -199,9 +199,9 @@ namespace ElmSharp } /// - /// Force the box to recalculate its children packing. - /// If any children was added or removed, box will not calculate the values immediately rather leaving it to the next main loop iteration. - /// While this is great as it would save lots of recalculation, whenever you need to get the position of a just added item you must force recalculate before doing so. + /// Forces the box to recalculate its children packing. + /// If any children were added or removed, the box will not calculate the values immediately, rather leaving it to the next main loop iteration. + /// While this is great as it would save lots of recalculation, whenever you need to get the position of a just added item, you must force recalculate before doing so. /// /// preview public void Recalculate() @@ -210,7 +210,7 @@ namespace ElmSharp } /// - /// Clear the box of all children. + /// Clears the box's of all the children. /// Remove all the elements contained by the box, deleting the respective objects. /// /// preview @@ -223,8 +223,8 @@ namespace ElmSharp /// /// Sets or gets the alignment of the whole bounding box of contents. /// - /// Horizontal alignment - /// Vertical alignment + /// Horizontal alignment. + /// Vertical alignment. /// preview public void SetBoxAlignment(double horizontal, double vertical) { @@ -232,10 +232,10 @@ namespace ElmSharp } /// - /// Sets or gets the space(padding) between the box's elements. + /// Sets or gets the space (padding) between the box's elements. /// - /// Horizontal padding - /// vertical padding + /// Horizontal padding. + /// Vertical padding. /// preview public void SetPadding(int horizontal, int vertical) { @@ -245,8 +245,8 @@ namespace ElmSharp /// /// Creates a widget handle. /// - /// Parent EvasObject - /// Handle IntPtr + /// Parent EvasObject. + /// Handle IntPtr. /// preview protected override IntPtr CreateHandle(EvasObject parent) { diff --git a/src/ElmSharp/ElmSharp/Button.cs b/src/ElmSharp/ElmSharp/Button.cs index 9f6c80b..ae72206 100755 --- a/src/ElmSharp/ElmSharp/Button.cs +++ b/src/ElmSharp/ElmSharp/Button.cs @@ -19,7 +19,7 @@ using System; namespace ElmSharp { /// - /// The Button is a widget works as a clickable input element to trigger events. + /// The Button is a widget that works as a clickable input element to trigger events. /// /// preview public class Button : Layout @@ -65,37 +65,37 @@ namespace ElmSharp } /// - /// Clicked will be triggered when Button is clicked. + /// Clicked will be triggered when the button is clicked. /// /// preview public event EventHandler Clicked; /// - /// Repeated will be triggered when Button is pressed without releasing it. + /// Repeated will be triggered when the button is pressed without releasing it. /// /// preview public event EventHandler Repeated; /// - /// Pressed will be triggered when the Button is pressed. + /// Pressed will be triggered when the button is pressed. /// /// preview public event EventHandler Pressed; /// - /// Released will be triggered when the Button is released after being pressed. + /// Released will be triggered when the button is released after being pressed. /// /// preview public event EventHandler Released; /// - /// Sets or gets the autorepeat feature of a given Button. + /// Sets or gets the autorepeat feature of a given Bbutton. /// /// - /// Autorepeat feature means autorepeat event generated when the button is kept pressed. - /// When set AutoRepeat to false, no autorepeat is performed and buttons will trigger Clicked event when they are clicked. - /// When set to true, keeping a button pressed continuously trigger Repeated event until the button is released. - /// The time it takes until it starts triggering Repeated is given by AutoRepeatInitialTime, + /// Autorepeat feature means the autorepeat event is generated when the button is kept pressed. + /// When set to false, no autorepeat is performed and the buttons will trigger the Clicked event when they are clicked. + /// When set to true, keeping a button pressed continuously will trigger the Repeated event until the button is released. + /// The time it takes until it starts triggering, repeated is given by AutoRepeatInitialTime, /// and the time between each new emission is given by AutoRepeatGapTimeout. /// /// preview @@ -144,9 +144,9 @@ namespace ElmSharp } /// - /// Delete the object color class. + /// Deletes the object Color class. /// - /// The color class to be deleted. + /// The Color class to be deleted. /// preview [Obsolete("DeleteColorClass is obsolete, please use EdjeObject.DeleteColorClass(string)")] public void DeleteColorClass(string part) @@ -155,7 +155,7 @@ namespace ElmSharp } /// - /// Sets or gets the BackgroundColor of a given Button in normal and pressed status. + /// Sets or gets the BackgroundColor of a given button in the normal and pressed status. /// /// preview public override Color BackgroundColor @@ -181,8 +181,8 @@ namespace ElmSharp /// /// Creates a widget handle. /// - /// Parent EvasObject - /// Handle IntPtr + /// Parent EvasObject. + /// Handle IntPtr. /// preview protected override IntPtr CreateHandle(EvasObject parent) { diff --git a/src/ElmSharp/ElmSharp/Calendar.cs b/src/ElmSharp/ElmSharp/Calendar.cs index 3d4a429..ad77992 100755 --- a/src/ElmSharp/ElmSharp/Calendar.cs +++ b/src/ElmSharp/ElmSharp/Calendar.cs @@ -23,50 +23,50 @@ using System.Runtime.InteropServices; namespace ElmSharp { /// - /// Enumeration for event periodicity, used to define if a mark should be repeated beyond event's day. It's set when a mark is added. + /// Enumeration for event periodicity, used to define if a mark should be repeated beyond the event's day. It's set when a mark is added. /// /// preview public enum CalendarMarkRepeatType { /// - /// Default value. Marks will be displayed only on event day. + /// Default value. Marks will be displayed only on the event day. /// Unique, /// - /// Marks will be displayed every day after event day. + /// Marks will be displayed every day after the event day. /// Daily, /// - /// Marks will be displayed every week after event day. + /// Marks will be displayed every week after the event day. /// Weekly, /// - /// Marks will be displayed every month day that coincides to event day. + /// Marks will be displayed every month that coincides to the event day. /// Monthly, /// - /// Marks will be displayed every year that coincides to event day. + /// Marks will be displayed every year that coincides to the event day. /// Annually, /// - /// Marks will be displayed every last day of month after event day. + /// Marks will be displayed every last day of month after the event day. /// LastDayOfMonth } /// - /// Enumeration for the mode, which determine how user could select a day. + /// Enumeration for the mode, which determines how a user could select a day. /// /// preview public enum CalendarSelectMode { /// - /// Default value. a day is always selected. + /// Default value. A day is always selected. /// Default, @@ -81,38 +81,38 @@ namespace ElmSharp None, /// - /// User may have selected a day or not. + /// User may have selected a day. /// OnDemand } /// - /// Enumeration used to define which fields of a tm struct will be taken into account + /// Enumeration for defining which fields of a tm struct will be taken into account. /// /// preview [Flags] public enum CalendarSelectable { /// - /// None will be taken into account + /// None will be taken into account. /// None = 0, /// - /// Year will be taken into account + /// Year will be taken into account. /// Year = 1 << 0, /// - /// Month will be taken into account + /// Month will be taken into account. /// Month = 1 << 1, /// - /// Day will be taken into account + /// Day will be taken into account. /// Day = 1 << 2 } /// - /// The CalendarMark is a Item for marking a Calendar's type,date and repeat type. + /// The CalendarMark is an item for marking a Calendar's type, date, and repeat type. /// /// preview public class CalendarMark @@ -132,7 +132,7 @@ namespace ElmSharp public DateTime Date; /// - /// Repeat the event following this periodicity. + /// Repeats the event following this periodicity. /// /// preview public CalendarMarkRepeatType Repeat; @@ -140,9 +140,9 @@ namespace ElmSharp /// /// Creates and initializes a new instance of the CalendarMark class. /// - /// Type of mark - /// Date of inclusion of the mark - /// Repeat type + /// Type of mark. + /// Date of inclusion of the mark. + /// Repeat type. /// preview public CalendarMark(string type, DateTime date, CalendarMarkRepeatType repeat) { @@ -154,7 +154,7 @@ namespace ElmSharp } /// - /// The Calendar is a widget that helps applications to flexibly display a calender with day of the week, date, year and month. + /// The Calendar is a widget that helps applications to flexibly display a calender with day of the week, date, year, and month. /// /// preview public class Calendar : Layout @@ -171,7 +171,7 @@ namespace ElmSharp /// Creates and initializes a new instance of the Calendar class. /// /// - /// The EvasObject to which the new Calendar will be attached as a child. + /// The EvasObject to which the new calendar will be attached as a child. /// /// preview public Calendar(EvasObject parent) : base(parent) @@ -264,7 +264,7 @@ namespace ElmSharp } /// - /// Sets or gets the first day of week, who are used on Calendar. + /// Sets or gets the first day of the week, which is used on the calendar. /// /// preview public DateTime DisplayedTime @@ -290,7 +290,7 @@ namespace ElmSharp } /// - /// Sets or gets the first day of week, who are used on Calendar. + /// Sets or gets the first day of the week, which is used on the calendar. /// /// preview public DayOfWeek FirstDayOfWeek @@ -306,10 +306,10 @@ namespace ElmSharp } /// - /// Sets or gets the weekdays names to be displayed by the Calendar. + /// Sets or gets the weekdays name to be displayed by the calendar. /// /// - /// The usage should be like this; + /// The usage should be like this: /// weekDayNames = new List() { "S", "M", "T", "W", "T", "F", "S" };]]> /// Calendar.WeekDayNames = weekDayNames; /// @@ -336,7 +336,7 @@ namespace ElmSharp /// Sets or gets the selected date. /// /// - /// Selected date changes when the user goes to next/previous month or select a day pressing over it on calendar. + /// The selected date changes when the user goes to the next/previous month or selects a day pressing over it on the calendar. /// /// preview public DateTime SelectedDate @@ -360,8 +360,8 @@ namespace ElmSharp } /// - /// Sets or gets the interval on time updates for an user mouse button - /// hold on calendar widgets' month/year selection. + /// Sets or gets the interval on time updates for a user mouse button + /// hold, on the calendar widgets' month/year selection. /// /// preview public double Interval @@ -393,7 +393,7 @@ namespace ElmSharp } /// - /// Gets or sets fields of a datetime will be taken into account, when SelectedDate set is invoked. + /// Gets or sets the fields of a datetime that will be taken into account, when SelectedDate set is invoked. /// /// preview public CalendarSelectable Selectable @@ -409,7 +409,7 @@ namespace ElmSharp } /// - /// Gets or sets date format the string that will be used to display month and year. + /// Gets or sets the date format of the string that will be used to display month and year. /// /// preview public DateFormatDelegate DateFormat @@ -433,11 +433,11 @@ namespace ElmSharp } /// - /// Add a new mark to the calendar. + /// Adds a new mark to the calendar. /// - /// A string used to define the type of mark. It will be emitted to the theme, that should display a related modification on these days representation. - /// A time struct to represent the date of inclusion of the mark. For marks that repeats it will just be displayed after the inclusion date in the calendar. - /// Repeat the event following this periodicity. Can be a unique mark (that don't repeat), daily, weekly, monthly or annually. + /// A string used to define the type of mark. It will be emitted to the theme that should display a related modification on these day's representation. + /// A time struct to represent the date of inclusion of the mark. For marks that repeat, it will just be displayed after the inclusion date in the calendar. + /// Repeat the event following this periodicity. Can be a unique mark (that doesn't repeat), daily, weekly, monthly, or annually. /// Item for a calendar mark. /// preview public CalendarMark AddMark(string type, DateTime date, CalendarMarkRepeatType repeat) @@ -451,9 +451,9 @@ namespace ElmSharp } /// - /// Delete mark from the calendar. + /// Deletes a mark from the calendar. /// - /// Item for a calendar mark + /// Item for a calendar mark. /// preview public void DeleteMark(CalendarMark mark) { @@ -461,7 +461,7 @@ namespace ElmSharp } /// - /// Draw calendar marks. + /// Draws the calendar marks. /// /// preview public void DrawMarks() @@ -470,7 +470,7 @@ namespace ElmSharp } /// - /// Remove all calendar's marks. + /// Removes all the calendar's marks. /// /// preview public void ClearMarks() @@ -481,8 +481,8 @@ namespace ElmSharp /// /// Creates a widget handle. /// - /// Parent EvasObject - /// Handle IntPtr + /// Parent EvasObject. + /// Handle IntPtr. /// preview protected override IntPtr CreateHandle(EvasObject parent) { @@ -508,4 +508,4 @@ namespace ElmSharp } } } -} \ No newline at end of file +} diff --git a/src/ElmSharp/ElmSharp/Check.cs b/src/ElmSharp/ElmSharp/Check.cs index b864cbe..92dbfd0 100755 --- a/src/ElmSharp/ElmSharp/Check.cs +++ b/src/ElmSharp/ElmSharp/Check.cs @@ -19,7 +19,7 @@ using System; namespace ElmSharp { /// - /// The check is a widget allows for toggling a value between true and false. + /// The Check is a widget that allows for toggling a value between true and false. /// /// preview public class Check : Layout @@ -31,7 +31,7 @@ namespace ElmSharp /// Creates and initializes a new instance of the Check class. /// /// - /// The EvasObject to which the new Check will be attached as a child. + /// The EvasObject to which the new check will be attached as a child. /// /// preview public Check(EvasObject parent) : base(parent) @@ -44,16 +44,16 @@ namespace ElmSharp } /// - /// StateChanged will be triggered when the IsChecked in the Check is changed. + /// StateChanged will be triggered when the IsChecked in the check is changed. /// /// preview public event EventHandler StateChanged; /// - /// Sets or gets whether the given Check is checked or not. + /// Sets or gets whether the given check is checked or not. /// /// - /// When object is checked, the value will set to true, Conversely will set to false. + /// When an object is checked, the value will be set to true. Conversely, will be set to false. /// /// preview public bool IsChecked @@ -72,8 +72,8 @@ namespace ElmSharp /// /// Creates a widget handle. /// - /// Parent EvasObject - /// Handle IntPtr + /// Parent EvasObject. + /// Handle IntPtr. /// preview protected override IntPtr CreateHandle(EvasObject parent) { diff --git a/src/ElmSharp/ElmSharp/CheckStateChangedEventArgs.cs b/src/ElmSharp/ElmSharp/CheckStateChangedEventArgs.cs index fc8bb4b..a687642 100755 --- a/src/ElmSharp/ElmSharp/CheckStateChangedEventArgs.cs +++ b/src/ElmSharp/ElmSharp/CheckStateChangedEventArgs.cs @@ -20,20 +20,20 @@ namespace ElmSharp { /// /// It inherits System.EventArgs. - /// The CheckStateChangedEventArgs is EventArgs to record Check's state. - /// Include old state and new state. + /// The CheckStateChangedEventArgs is an EventArgs to record the check's state. + /// Include the old state and the new state. /// /// preview public class CheckStateChangedEventArgs : EventArgs { /// - /// Gets the OldState property.The return type is bool. + /// Gets the OldState property. The return type is bool. /// /// preview public bool OldState { get; private set; } /// - /// Gets the NewState property.The return type is bool. + /// Gets the NewState property. The return type is bool. /// /// preview public bool NewState { get; private set; } @@ -41,8 +41,8 @@ namespace ElmSharp /// /// Creates and initializes a new instance of the CheckStateChangedEventArgs class. /// - /// Old state of Check which to use this CheckStateChangedEventArgs. - /// New state of Check which to use this CheckStateChangedEventArgs. + /// Old state of check to use this CheckStateChangedEventArgs. + /// New state of check to use this CheckStateChangedEventArgs. /// preview public CheckStateChangedEventArgs(bool oldState, bool newState) { diff --git a/src/ElmSharp/ElmSharp/Color.cs b/src/ElmSharp/ElmSharp/Color.cs index 1295a38..3749974 100644 --- a/src/ElmSharp/ElmSharp/Color.cs +++ b/src/ElmSharp/ElmSharp/Color.cs @@ -20,7 +20,7 @@ using System.Globalization; namespace ElmSharp { /// - /// The Color is a struct to record Check's state. + /// The Color is a struct to record the check's state. /// /// preview public struct Color @@ -42,7 +42,7 @@ namespace ElmSharp /// Gets a default Color instance. /// /// - /// In default Color instance,Mode type is Default,RGBA all set as -1. + /// In the default Color instance, the mode type is default with RGBA all set as -1. /// /// preview public static Color Default @@ -52,7 +52,7 @@ namespace ElmSharp /// /// Gets whether the Color instance's mode is default or not. - /// Return type is bool. + /// The return type is bool. /// /// preview public bool IsDefault @@ -61,7 +61,7 @@ namespace ElmSharp } /// - /// Gets A value of RGBA. + /// Gets the A value of RGBA. /// A means the Alpha in color. /// /// preview @@ -71,7 +71,7 @@ namespace ElmSharp } /// - /// Gets R value of RGBA. + /// Gets the R value of RGBA. /// R means the Red in color. /// /// preview @@ -81,7 +81,7 @@ namespace ElmSharp } /// - /// Gets G value of RGBA. + /// Gets the G value of RGBA. /// G means the Green in color. /// /// preview @@ -91,7 +91,7 @@ namespace ElmSharp } /// - /// Gets B value of RGBA. + /// Gets the B value of RGBA. /// B means the Blue in color. /// /// preview @@ -101,25 +101,25 @@ namespace ElmSharp } /// - /// Creates and initializes a new instance of the Color class. - /// With RGB parameters. + /// Creates and initializes a new instance of the Color class + /// with RGB parameters. /// - /// Red of RGB - /// Green of RGB - /// Blue of RGB + /// Red of RGB. + /// Green of RGB. + /// Blue of RGB. /// preview public Color(int r, int g, int b) : this(r, g, b, 255) { } /// - /// Creates and initializes a new instance of the Color class. - /// With RGBA parameters. + /// Creates and initializes a new instance of the Color class + /// with RGBA parameters. /// - /// Red of RGBA - /// Green of RGBA - /// Blue of RGBA - /// Alpha of RGBA + /// Red of RGBA. + /// Green of RGBA. + /// Blue of RGBA. + /// Alpha of RGBA. /// preview public Color(int r, int g, int b, int a) : this(r, g, b, a, Mode.Rgb) { @@ -160,7 +160,7 @@ namespace ElmSharp /// /// The object to compare with the current instance. /// - /// true if obj and this instance are the same type and represent the same value. + /// true if the object and this instance are of the same type and represent the same value. /// otherwise, false. /// /// preview @@ -174,12 +174,12 @@ namespace ElmSharp } /// - /// Compare whether two Color instance is same or not. + /// Compares whether the two Color instances are same or not. /// /// A Color instance. /// A Color instance. - /// The result whether two instance is same or not. - /// Return type is bool.If they are same, return true. + /// The result whether the two instances are the same or not. + /// Return type is bool. If they are same, return true. /// /// preview public static bool operator ==(Color a, Color b) @@ -194,12 +194,12 @@ namespace ElmSharp } /// - /// Compare whether two Color instance is different or not. + /// Compares whether the two Color instances are different or not. /// /// A Color instance. /// A Color instance. - /// The result whether two instance is different or not. - /// Return type is bool.If they are different, return true. + /// The result whether the two instances are different or not. + /// Return type is bool. If they are different, return true. /// /// preview public static bool operator !=(Color a, Color b) @@ -228,7 +228,7 @@ namespace ElmSharp /// Gets a Color instance with a hexadecimal string parameter. /// /// Hexadecimal string. - /// New instance of Color struct. + /// New instance of the Color struct. /// preview public static Color FromHex(string hex) { @@ -249,10 +249,10 @@ namespace ElmSharp } /// - /// Gets a Color instance with a Unsigned integer parameter. + /// Gets a Color instance with an unsigned integer parameter. /// /// Unsigned integer indicates RGBA. - /// New instance of Color struct. + /// New instance of the Color struct. /// preview public static Color FromUint(uint argb) { @@ -262,11 +262,11 @@ namespace ElmSharp /// /// Gets a Color instance with R,G,B,A parameters. /// - /// Red in RGBA. - /// Green in RGBA. - /// Blue in RGBA. - /// Alpha in RGBA. - /// New instance of Color struct. + /// Red of RGBA. + /// Green of RGBA. + /// Blue of RGBA. + /// Alpha of RGBA. + /// New instance of the Color struct. /// preview public static Color FromRgba(int r, int g, int b, int a) { @@ -274,12 +274,12 @@ namespace ElmSharp } /// - /// Gets a Color instance with R,G,B,A parameters. + /// Gets a Color instance with R,G,B parameters. /// - /// Red in RGB. - /// Green in RGB. - /// Blue in RGB. - /// New instance of Color struct. + /// Red of RGB. + /// Green of RGB. + /// Blue of RGB. + /// New instance of the Color struct. /// preview public static Color FromRgb(int r, int g, int b) { @@ -293,97 +293,97 @@ namespace ElmSharp #region Color Definitions /// - /// The Tansparent is a predefined Color, it's rgba value is (0, 0, 0, 0). + /// The Tansparent is a predefined Color instance. It's RGBA value is (0, 0, 0, 0). /// /// preview public static readonly Color Transparent = FromRgba(0, 0, 0, 0); /// - /// The Aqua is a predefined Color instance, it's rgb value is (0, 255, 255). + /// The Aqua is a predefined Color instance. It's RGB value is (0, 255, 255). /// /// preview public static readonly Color Aqua = FromRgb(0, 255, 255); /// - /// The Black is a predefined Color instance, it's rgb value is (0, 0, 0). + /// The Black is a predefined Color instance. It's RGB value is (0, 0, 0). /// /// preview public static readonly Color Black = FromRgb(0, 0, 0); /// - /// The Blue is a predefined Color instance, it's rgb value is (0, 0, 255). + /// The Blue is a predefined Color instance. It's RGB value is (0, 0, 255). /// /// preview public static readonly Color Blue = FromRgb(0, 0, 255); /// - /// The Fuchsia is a predefined Color instance, it's rgb value is (255, 0, 255). + /// The Fuchsia is a predefined Color instance. It's RGB value is (255, 0, 255). /// /// preview public static readonly Color Fuchsia = FromRgb(255, 0, 255); /// - /// The Gray is a predefined Color instance, it's rgb value is (128, 128, 128). + /// The Gray is a predefined Color instance. It's RGB value is (128, 128, 128). /// /// preview public static readonly Color Gray = FromRgb(128, 128, 128); /// - /// The Green is a predefined Color instance, it's rgb value is (0, 128, 0). + /// The Green is a predefined Color instance. It's RGB value is (0, 128, 0). /// /// preview public static readonly Color Green = FromRgb(0, 128, 0); /// - /// The Lime is a predefined Color instance, it's rgb value is (0, 255, 0). + /// The Lime is a predefined Color instance. It's RGB value is (0, 255, 0). /// /// preview public static readonly Color Lime = FromRgb(0, 255, 0); /// - /// The Maroon is a predefined Color instance, it's rgb value is (128, 0, 0). + /// The Maroon is a predefined Color instance. It's RGB value is (128, 0, 0). /// /// preview public static readonly Color Maroon = FromRgb(128, 0, 0); /// - /// The Navy is a predefined Color instance, it's rgb value is (0, 0, 128). + /// The Navy is a predefined Color instance. It's RGB value is (0, 0, 128). /// /// preview public static readonly Color Navy = FromRgb(0, 0, 128); /// - /// The Olive is a predefined Color instance, it's rgb value is (128, 128, 0). + /// The Olive is a predefined Color instance. It's RGB value is (128, 128, 0). /// /// preview public static readonly Color Olive = FromRgb(128, 128, 0); /// - /// The Orange is a predefined Color instance, it's rgb value is (255, 165, 0). + /// The Orange is a predefined Color instance. It's RGB value is (255, 165, 0). /// /// preview public static readonly Color Orange = FromRgb(255, 165, 0); /// - /// The Purple is a predefined Color instance, it's rgb value is (128, 0, 128). + /// The Purple is a predefined Color instance. It's RGB value is (128, 0, 128). /// /// preview public static readonly Color Purple = FromRgb(128, 0, 128); /// - /// The Pink is a predefined Color instance, it's rgb value is (255, 102, 255). + /// The Pink is a predefined Color instance. It's RGB value is (255, 102, 255). /// /// preview public static readonly Color Pink = FromRgb(255, 102, 255); /// - /// The Red is a predefined Color instance, it's rgb value is (255, 0, 0). + /// The Red is a predefined Color instance. It's RGB value is (255, 0, 0). /// /// preview public static readonly Color Red = FromRgb(255, 0, 0); /// - /// The Silver is a predefined Color instance, it's rgb value is (192, 192, 192). + /// The Silver is a predefined Color instance. It's RGB value is (192, 192, 192). /// /// preview public static readonly Color Silver = FromRgb(192, 192, 192); /// - /// The Teal is a predefined Color instance, it's rgb value is (0, 128, 128). + /// The Teal is a predefined Color instance. It's RGB value is (0, 128, 128). /// /// preview public static readonly Color Teal = FromRgb(0, 128, 128); /// - /// The White is a predefined Color instance, it's rgb value is (255, 255, 255). + /// The White is a predefined Color instance. It's RGB value is (255, 255, 255). /// /// preview public static readonly Color White = FromRgb(255, 255, 255); /// - /// The Yellow is a predefined Color instance, it's rgb value is (255, 255, 0). + /// The Yellow is a predefined Color instance. It's RGB value is (255, 255, 0). /// /// preview public static readonly Color Yellow = FromRgb(255, 255, 0); diff --git a/src/ElmSharp/ElmSharp/ColorChangedEventArgs.cs b/src/ElmSharp/ElmSharp/ColorChangedEventArgs.cs index 5311a1a..7c91069 100755 --- a/src/ElmSharp/ElmSharp/ColorChangedEventArgs.cs +++ b/src/ElmSharp/ElmSharp/ColorChangedEventArgs.cs @@ -20,20 +20,20 @@ namespace ElmSharp { /// /// It inherits System.EventArgs. - /// Event ColorChanged of ColorSelector contain ColorChangedEventArgs as a parameter. + /// Event ColorChanged of the ColorSelector contains ColorChangedEventArgs as a parameter. /// Refer to type. /// /// preview public class ColorChangedEventArgs : EventArgs { /// - /// Gets old color in color changed event. + /// Gets an old color in the color changed event. /// /// preview public Color OldColor { get; private set; } /// - /// Gets new color in color changed event. + /// Gets a new color in the color changed event. /// /// preview public Color NewColor { get; private set; } @@ -41,8 +41,8 @@ namespace ElmSharp /// /// Creates and initializes a new instance of the ColorChangedEventArgs class. /// - /// old color - /// new color + /// Old color. + /// New color. /// preview public ColorChangedEventArgs(Color oldColor, Color newColor) { diff --git a/src/ElmSharp/ElmSharp/ColorSelector.cs b/src/ElmSharp/ElmSharp/ColorSelector.cs index 1ea8f5d..db4a2f3 100755 --- a/src/ElmSharp/ElmSharp/ColorSelector.cs +++ b/src/ElmSharp/ElmSharp/ColorSelector.cs @@ -19,42 +19,42 @@ using System; namespace ElmSharp { /// - /// Enumeration for mode of ColorSelector + /// Enumeration for the modes of ColorSelector. /// /// preview public enum ColorSelectorMode { /// - /// Only color palette is displayed, default + /// Only the color palette is displayed, by default. /// Palette, /// - /// Only color selector is displayed + /// Only the color selector is displayed. /// [Obsolete("Components is obsolete as of version 1.2.3 and is no longer supported.")] Components, /// - /// Both Palette and selector is displayed + /// Both the palette and the selector is displayed. /// [Obsolete("Both is obsolete as of version 1.2.3 and is no longer supported.")] Both, /// - /// Only color picker is displayed + /// Only the color picker is displayed. /// [Obsolete("Picker is obsolete as of version 1.2.3 and is no longer supported.")] Picker, /// - /// This mode is not supported. If you use this, nothing will be shown + /// This mode is not supported. If you use this, nothing will be shown. /// [Obsolete("Plane is obsolete as of version 1.2.3 and is no longer supported.")] Plane, /// - /// This mode is not supported. If you use this, it will be shown same with Palette mode + /// This mode is not supported. If you use this, it will be shown same with the Palette mode. /// [Obsolete("PallettePlane is obsolete as of version 1.2.3 and is no longer supported.")] PallettePlane, /// - /// This mode is not supported. If you use this, it will be shown same with Palette mode + /// This mode is not supported. If you use this, it will be shown same with the Palette mode. /// [Obsolete("All is obsolete as of version 1.2.3 and is no longer supported.")] All @@ -62,12 +62,12 @@ namespace ElmSharp /// /// The ColorSelector is a widget to set a series of colors. - /// It also allows to load/save colors from/to config with a unique identifier. + /// It also allows to load/save colors from/to the configuration with a unique identifier. /// /// - /// By default, the colors are loaded/saved from/to config using "default" identifier. - /// The colors can be picked by user from the color set by clicking on individual - /// color item on the palette or by selecting it from selector. + /// By default, the colors are loaded/saved from/to configuration using the "default" identifier. + /// The colors can be picked by the user from the color set by clicking on individual + /// color items on the palette, or by selecting it from the selector. /// /// preview public class ColorSelector : Layout @@ -89,7 +89,7 @@ namespace ElmSharp } /// - /// ColorChanged will be triggered when the SelectedColor changed. + /// ColorChanged will be triggered when the SelectedColor is changed. /// /// preview public event EventHandler ColorChanged @@ -99,7 +99,7 @@ namespace ElmSharp } /// - /// Gets or sets color of colorselector. + /// Gets or sets the color of colorselector. /// /// preview public Color SelectedColor @@ -119,7 +119,7 @@ namespace ElmSharp } /// - /// Gets Alpha of a default Color Class(Value is -1). + /// Gets the Alpha of a default Color class (value is -1). /// /// preview public override int Opacity @@ -136,7 +136,7 @@ namespace ElmSharp } /// - /// Gets or sets Colorselector's mode. + /// Gets or sets the Colorselector's mode. /// /// preview public ColorSelectorMode Mode @@ -155,7 +155,7 @@ namespace ElmSharp } /// - /// Get or set current palette's name. + /// Gets or sets the current palette's name. /// /// preview public string PaletteName @@ -171,9 +171,9 @@ namespace ElmSharp } /// - /// Adds a new color item to palette. + /// Adds a new color item to the palette. /// - /// Color item to add + /// The color item to add. /// A new color palette Item. /// preview public ColorSelectorItem AddPaletteColor(Color color) @@ -184,7 +184,7 @@ namespace ElmSharp } /// - /// Clear the palette items. + /// Clears the palette items. /// /// preview public void ClearPalette() @@ -195,8 +195,8 @@ namespace ElmSharp /// /// Creates a widget handle. /// - /// Parent EvasObject - /// Handle IntPtr + /// Parent EvasObject. + /// Handle IntPtr. /// preview protected override IntPtr CreateHandle(EvasObject parent) { diff --git a/src/ElmSharp/ElmSharp/ColorSelectorItem.cs b/src/ElmSharp/ElmSharp/ColorSelectorItem.cs index 075c92f..4ec12c4 100755 --- a/src/ElmSharp/ElmSharp/ColorSelectorItem.cs +++ b/src/ElmSharp/ElmSharp/ColorSelectorItem.cs @@ -19,7 +19,7 @@ using System; namespace ElmSharp { /// - /// A instance to the ColorSelector item added. + /// An instance to the ColorSelector item gets added. /// /// preview public class ColorSelectorItem : ItemObject @@ -29,7 +29,7 @@ namespace ElmSharp } /// - /// Gets or sets the Palette item's color + /// Gets or sets the palette item's color. /// /// preview public Color Color diff --git a/src/ElmSharp/ElmSharp/Conformant.cs b/src/ElmSharp/ElmSharp/Conformant.cs index c40cc87..e717b4c 100755 --- a/src/ElmSharp/ElmSharp/Conformant.cs +++ b/src/ElmSharp/ElmSharp/Conformant.cs @@ -19,7 +19,7 @@ using System; namespace ElmSharp { /// - /// The check is a widget that can be used in elementary apps + /// The Conformant is a widget that can be used in elementary applications /// to account for space taken up by the indicator, /// virtual keypad & softkey windows when running the illume2 module of E17. /// @@ -29,8 +29,8 @@ namespace ElmSharp /// /// Creates and initializes a new instance of the Conformant class. /// - /// The parent is a given container which will be attached by Conformant - /// as a child.It's type. + /// The parent is a given container, which will be attached by Conformant + /// as a child. It's type. /// preview public Conformant(Window parent) : base(parent) { @@ -42,8 +42,8 @@ namespace ElmSharp /// /// Creates a widget handle. /// - /// Parent EvasObject - /// Handle IntPtr + /// Parent EvasObject. + /// Handle IntPtr. /// preview protected override IntPtr CreateHandle(EvasObject parent) { diff --git a/src/ElmSharp/ElmSharp/Container.cs b/src/ElmSharp/ElmSharp/Container.cs index 20aee3a..764310f 100755 --- a/src/ElmSharp/ElmSharp/Container.cs +++ b/src/ElmSharp/ElmSharp/Container.cs @@ -21,8 +21,8 @@ namespace ElmSharp { /// /// It inherits . - /// The Container is a abstract class. - /// Other class inherits it to Elementary is about displaying + /// The Container is an abstract class. + /// The other class inherits it to elementary, which is about displaying /// its widgets in a nice layout. /// /// preview @@ -31,17 +31,17 @@ namespace ElmSharp HashSet _children = new HashSet(); /// - /// Creates and initializes a new instance of class which inherit from Container. + /// Creates and initializes a new instance of the class, which inherit from the Container. /// - /// The parent is a given object which will be attached by Container - /// as a child.It's type. + /// The parent is a given object, which will be attached by the Container + /// as a child. It's type. /// preview public Container(EvasObject parent) : base(parent) { } /// - /// Creates and initializes a new instance of Container class. + /// Creates and initializes a new instance of the Container class. /// /// preview protected Container() : base() @@ -69,15 +69,15 @@ namespace ElmSharp } /// - /// Gets the collection of child EvasObject of the Container. + /// Gets the collection of a child EvasObject of the Container. /// /// preview protected IEnumerable Children => _children; /// - /// Add an EvasObject object as a child of Container. + /// Add the EvasObject object as a child of the Container. /// - /// The EvasObject object to be added + /// The EvasObject object to be added. /// preview protected void AddChild(EvasObject obj) { @@ -86,9 +86,9 @@ namespace ElmSharp } /// - /// Remove an EvasObject object as a child of Container. + /// Removes the EvasObject object as a child of the Container. /// - /// The EvasObject object to be removed + /// The EvasObject object to be removed. /// preview protected void RemoveChild(EvasObject obj) { @@ -96,7 +96,7 @@ namespace ElmSharp } /// - /// Clear all children of the Container. + /// Clears all the children of the Container. /// /// preview protected void ClearChildren() @@ -105,9 +105,9 @@ namespace ElmSharp } /// - /// The Container Callback that is invoked when a child is removed. + /// The Container callback that is invoked when a child is removed. /// - /// The called Container + /// The called Container. /// void OnChildDeleted(object sender, EventArgs a) { diff --git a/src/ElmSharp/ElmSharp/ContextPopup.cs b/src/ElmSharp/ElmSharp/ContextPopup.cs index 06e9dce..5b89aea 100755 --- a/src/ElmSharp/ElmSharp/ContextPopup.cs +++ b/src/ElmSharp/ElmSharp/ContextPopup.cs @@ -20,36 +20,36 @@ using System.Collections.Generic; namespace ElmSharp { /// - /// Enumeration of ContextPopup direction type. + /// Enumeration for the ContextPopup direction types. /// /// preview public enum ContextPopupDirection { /// - /// ContextPopup show appear below clicked area + /// The ContextPopup appears below the clicked area. /// /// Down, /// - /// ContextPopup show appear to the right of the clicked area + /// The ContextPopup appears to the right of the clicked area. /// Right, /// - /// ContextPopup show appear to the left of the clicked area + /// The ContextPopup appears to the left of the clicked area. /// Left, /// - /// ContextPopup show appear above the clicked area + /// The ContextPopup appears above the clicked area. /// Up, /// - /// ContextPopup does not determine it's direction yet + /// The ContextPopup does not determine it's direction yet. /// Unknown } /// /// It inherits . - /// The ContextPopup is a widget that when it shown, pops up a list of items. + /// The ContextPopup is a widget that when shown, pops up a list of items. /// /// preview public class ContextPopup : Layout @@ -61,8 +61,8 @@ namespace ElmSharp /// /// Creates and initializes a new instance of the ContextPopup class. /// - /// The parent is a given container which will be attached by ContextPopup - /// as a child.It's type. + /// The parent is a given container, which will be attached by ContextPopup + /// as a child. It's type. /// preview public ContextPopup(EvasObject parent) : base(parent) { @@ -82,7 +82,7 @@ namespace ElmSharp /// Dismissed is raised when the ContextPopup item is dismissed. /// /// - /// Outside of ContextPopup was clicked or it's parent area is changed or the language is changed. and then ContextPopup is dismissed. + /// Outside of ContextPopup is clicked or it's parent area is changed or the language is changed, and then ContextPopup is dismissed. /// /// preview public event EventHandler Dismissed; @@ -91,7 +91,7 @@ namespace ElmSharp /// Gets the current direction of a ContextPopup. /// /// - /// Once the ContextPopup showed up, the direction would be determined. + /// Once the ContextPopup shows up, the direction would be determined. /// /// preview public ContextPopupDirection Direction @@ -103,8 +103,8 @@ namespace ElmSharp } /// - /// Gets or sets the value of current ContextPopup object's orientation. - /// True for horizontal mode, False for vertical mode (or errors) + /// Gets or sets the value of the current ContextPopup object's orientation. + /// True for horizontal mode, False for vertical mode (or errors). /// /// preview public bool IsHorizontal @@ -120,8 +120,8 @@ namespace ElmSharp } /// - /// Gets or sets whether ContextPopup hide automatically - /// or not when parent of ContextPopup is resized. + /// Gets or sets whether the ContextPopup hides automatically + /// or not when the parent of the ContextPopup is resized. /// /// /// Default value of AutoHide is False. @@ -140,7 +140,7 @@ namespace ElmSharp } /// - /// Clears all items in the given ContextPopup object. + /// Clears all the items in a given ContextPopup object. /// /// preview public void Clear() @@ -151,10 +151,10 @@ namespace ElmSharp /// /// Sets the direction priority of a ContextPopup. /// - /// 1st priority of direction - /// 2nd priority of direction - /// 3th priority of direction - /// 4th priority of direction + /// 1st priority of the direction. + /// 2nd priority of the direction. + /// 3th priority of the direction. + /// 4th priority of the direction. /// preview public void SetDirectionPriorty(ContextPopupDirection first, ContextPopupDirection second, ContextPopupDirection third, ContextPopupDirection fourth) { @@ -164,10 +164,10 @@ namespace ElmSharp /// /// Gets the direction priority of a ContextPopup. /// - /// 1st priority of direction to be returned - /// 2nd priority of direction to be returned - /// 2nd priority of direction to be returned - /// 4th priority of direction to be returned + /// 1st priority of the direction to be returned. + /// 2nd priority of the direction to be returned. + /// 2nd priority of the direction to be returned. + /// 4th priority of the direction to be returned. /// preview public void GetDirectionPriority(out ContextPopupDirection first, out ContextPopupDirection second, out ContextPopupDirection third, out ContextPopupDirection fourth) { @@ -180,11 +180,11 @@ namespace ElmSharp } /// - /// Adds a new item to a ContextPopup object with label. + /// Adds a new item to a ContextPopup object with the label. /// - /// The Label of the new item + /// Label of the new item. /// - /// A ContextPopupItem added or NULL, on errors + /// A ContextPopupItem added, or null on errors. /// /// preview public ContextPopupItem Append(string label) @@ -193,11 +193,11 @@ namespace ElmSharp } /// - /// Adds a new item to a ContextPopup object with label and icon. + /// Adds a new item to a ContextPopup object with the label and icon. /// - /// The Label of the new item - /// Icon to be set on new item - /// A ContextPopupItem added or NULL, on errors + /// Label of the new item. + /// Icon to be set on the new item. + /// A ContextPopupItem added, or null on errors. /// preview public ContextPopupItem Append(string label, EvasObject icon) { @@ -208,7 +208,7 @@ namespace ElmSharp } /// - /// Dismiss a ContextPopup object. The ContextPopup will be hidden and the "clicked" signal will be emitted. + /// Dismisses a ContextPopup object. The ContextPopup will be hidden and the "clicked" signal will be emitted. /// /// preview public void Dismiss() @@ -217,11 +217,11 @@ namespace ElmSharp } /// - /// Gets the possibility that the direction would be available + /// Gets the possibility that the direction would be available. /// - /// A direction user wants to check + /// A direction that the user wants to check. /// - /// Get false if you cannot put it in the direction. Gets true if it's possible. + /// Get false if you cannot put it in the direction. Get true if it's possible. /// /// preview public bool IsAvailableDirection(ContextPopupDirection direction) @@ -230,7 +230,7 @@ namespace ElmSharp } /// - /// Gets Alpha of a default Color Class. + /// Gets the Alpha of a default Color class. /// /// preview public override int Opacity @@ -249,8 +249,8 @@ namespace ElmSharp /// /// Creates a widget handle. /// - /// Parent EvasObject - /// Handle IntPtr + /// Parent EvasObject. + /// Handle IntPtr. /// preview protected override IntPtr CreateHandle(EvasObject parent) { diff --git a/src/ElmSharp/ElmSharp/ContextPopupItem.cs b/src/ElmSharp/ElmSharp/ContextPopupItem.cs index 7767892..91c62d6 100755 --- a/src/ElmSharp/ElmSharp/ContextPopupItem.cs +++ b/src/ElmSharp/ElmSharp/ContextPopupItem.cs @@ -20,7 +20,7 @@ namespace ElmSharp { /// /// It inherits . - /// A instance to the ContextPopup item added. + /// An instance to the ContextPopup item is added. /// /// preview public class ContextPopupItem : ItemObject @@ -38,13 +38,13 @@ namespace ElmSharp public string Text { get; internal set; } /// - /// Gets the Icon(type is ) property of the given ContextPopupItem. + /// Gets the Icon (type is ) property of the given ContextPopupItem. /// /// preview public EvasObject Icon { get; internal set; } /// - /// Selected will be triggered when the ContextPopupItem is Selected. + /// Selected will be triggered when the ContextPopupItem is selected. /// /// preview public event EventHandler Selected; diff --git a/src/ElmSharp/ElmSharp/DateChangedEventArgs.cs b/src/ElmSharp/ElmSharp/DateChangedEventArgs.cs index 939bd43..85d9913 100755 --- a/src/ElmSharp/ElmSharp/DateChangedEventArgs.cs +++ b/src/ElmSharp/ElmSharp/DateChangedEventArgs.cs @@ -20,8 +20,8 @@ namespace ElmSharp { /// /// It inherits System.EventArgs. - /// The DateChanged event in Calendar and DateTimeChanged event in DateTimeSelector. - /// contain DateChangedEventArgs as a parameter. + /// The DateChanged event in the Calendar and the DateTimeChanged event in DateTimeSelector + /// contain the DateChangedEventArgs as a parameter. /// /// preview public class DateChangedEventArgs : EventArgs @@ -42,10 +42,10 @@ namespace ElmSharp /// Creates and initializes a new instance of the DateChangedEventArgs class. /// /// - /// Old date when DateChanged event or DateTimeChanged event triggered + /// Old date when the DateChanged event or DateTimeChanged event triggered. /// /// - /// New date when DateChanged event or DateTimeChanged event triggered + /// New date when the DateChanged event or DateTimeChanged event triggered. /// /// preview public DateChangedEventArgs(DateTime oldDate, DateTime newDate) diff --git a/src/ElmSharp/ElmSharp/DateTimeSelector.cs b/src/ElmSharp/ElmSharp/DateTimeSelector.cs index 9559037..4ba39ca 100755 --- a/src/ElmSharp/ElmSharp/DateTimeSelector.cs +++ b/src/ElmSharp/ElmSharp/DateTimeSelector.cs @@ -19,42 +19,42 @@ using System; namespace ElmSharp { /// - /// Enumeration of datetime field types for DateTimeSelector. + /// Enumeration for the datetime field types for DateTimeSelector. /// /// preview public enum DateTimeFieldType { /// - /// Indicates Year field. + /// Indicates the Year field. /// Year, /// - /// Indicates Month field. + /// Indicates the Month field. /// Month, /// - /// Indicates Date field. + /// Indicates the Date field. /// Date, /// - /// Indicates Hour field. + /// Indicates the Hour field. /// Hour, /// - /// Indicates Minute field. + /// Indicates the Minute field. /// Minute, /// - /// Indicates AM/PM field. + /// Indicates the AM/PM field. /// AmPm } /// - /// It inherits - /// DateTimeSelector is a widget to display and input date & time values. - /// This widget displays date and time as per the system's locale settings - /// (Date includes Day, Month & Year along with the defined separators and Time includes Hour, Minute & AM/PM fields. Separator for AM/PM field is ignored. + /// It inherits . + /// The DateTimeSelector is a widget to display and input the date & time values. + /// This widget displays the date and time as per the system's locale settings + /// (Date includes Day, Month & Year) along with the defined separators and time including hour, minute & AM/PM fields. Separator for the AM/PM field is ignored. /// /// preview public class DateTimeSelector : Layout @@ -65,15 +65,15 @@ namespace ElmSharp /// /// Creates and initializes a new instance of the DateTimeSelector class. /// - /// The parent is a given container which will be attached by DateTimeSelector - ///as a child.It's type. + /// The parent is a given container, which will be attached by the DateTimeSelector + /// as a child. It's type. /// preview public DateTimeSelector(EvasObject parent) : base(parent) { } /// - /// Creates and initializes a new instance of DateTimeSelector class. + /// Creates and initializes a new instance of the DateTimeSelector class. /// /// preview protected DateTimeSelector() : base() @@ -81,7 +81,7 @@ namespace ElmSharp } /// - /// ItemSelected is raised when Datetime field value changed. + /// ItemSelected is raised when the DateTime field value is changed. /// /// preview public event EventHandler DateTimeChanged; @@ -90,7 +90,7 @@ namespace ElmSharp /// Gets or sets the datetime format. /// /// - /// format is a combination of allowed LIBC date format specifiers like: "%b %d, %Y %I : %M %p". + /// Format is a combination of the allowed LIBC date format specifiers like: "%b %d, %Y %I : %M %p". /// /// preview public string Format @@ -106,7 +106,7 @@ namespace ElmSharp } /// - /// Gets or sets the upper boundary of DateTime field. + /// Gets or sets the upper boundary of the DateTime field. /// /// preview public DateTime MaximumDateTime @@ -125,7 +125,7 @@ namespace ElmSharp } /// - /// Gets or sets the lower boundary of DateTime field. + /// Gets or sets the lower boundary of the DateTime field. /// /// preview public DateTime MinimumDateTime @@ -144,7 +144,7 @@ namespace ElmSharp } /// - /// Gets or sets the current value of DateTime field. + /// Gets or sets the current value of the DateTime field. /// /// preview public DateTime DateTime @@ -166,10 +166,10 @@ namespace ElmSharp /// /// Gets whether a field can be visible. /// - /// Enumeration + /// Enumeration for . /// /// The field is visible or not. - /// Type is bool.If visible, return true. + /// Type is bool. If visible, return true. /// /// preview public bool IsFieldVisible(DateTimeFieldType type) @@ -180,9 +180,9 @@ namespace ElmSharp /// /// Sets the field limits of a field. /// - /// Enumeration - /// minimum limit - /// maximum limit + /// Enumeration for . + /// The minimum limit. + /// The maximum limit. /// preview public void SetFieldLimit(DateTimeFieldType type, int minimum, int maximum) { @@ -192,8 +192,8 @@ namespace ElmSharp /// /// Gets whether a field can be visible. /// - /// Enumeration - /// When set as true, the field type visible. + /// Enumeration for . + /// When set as true, the field type is visible. /// preview public void SetFieldVisible(DateTimeFieldType type, bool visible) { @@ -201,7 +201,7 @@ namespace ElmSharp } /// - /// The callback of Realized Event + /// The callback of the Realized event. /// /// preview protected override void OnRealized() @@ -219,8 +219,8 @@ namespace ElmSharp /// /// Creates a widget handle. /// - /// Parent EvasObject - /// Handle IntPtr + /// Parent EvasObject. + /// Handle IntPtr. /// preview protected override IntPtr CreateHandle(EvasObject parent) { diff --git a/src/ElmSharp/ElmSharp/DisplayedMonthChangedEventArgs.cs b/src/ElmSharp/ElmSharp/DisplayedMonthChangedEventArgs.cs index 0a2be88..d113221 100755 --- a/src/ElmSharp/ElmSharp/DisplayedMonthChangedEventArgs.cs +++ b/src/ElmSharp/ElmSharp/DisplayedMonthChangedEventArgs.cs @@ -20,7 +20,7 @@ namespace ElmSharp { /// /// It inherits System.EventArgs. - /// The DisplayedMonthChangedEvent in Calendar contain + /// The DisplayedMonthChangedEvent in a calendar contains the /// DisplayedMonthChangedEventArgs as a parameter. /// /// preview @@ -42,10 +42,10 @@ namespace ElmSharp /// Creates and initializes a new instance of the DisplayedMonthChangedEventArgs class. /// /// - /// old month of date when DisplayedMonthChangedEvent triggered. + /// Old month of the date when the DisplayedMonthChangedEvent triggered. /// /// - /// new month of date when DisplayedMonthChangedEvent triggered. + /// New month of the date when the DisplayedMonthChangedEvent triggered. /// /// preview public DisplayedMonthChangedEventArgs(int oldMonth, int newMonth) diff --git a/src/ElmSharp/ElmSharp/EcoreAnimator.cs b/src/ElmSharp/ElmSharp/EcoreAnimator.cs index 06c9a1c..cf0b8dc 100755 --- a/src/ElmSharp/ElmSharp/EcoreAnimator.cs +++ b/src/ElmSharp/ElmSharp/EcoreAnimator.cs @@ -20,7 +20,7 @@ using System.Collections.Generic; namespace ElmSharp { /// - /// EcoreAnimator is a helper class, it provides functions to manager animations. + /// EcoreAnimator is a helper class. It provides the functions to manage animations. /// /// preview public static class EcoreAnimator @@ -37,7 +37,7 @@ namespace ElmSharp } /// - /// Gets current system time as a floating point value in seconds. + /// Gets the current system time as a floating point value in seconds. /// /// Current system time /// preview @@ -47,10 +47,10 @@ namespace ElmSharp } /// - /// Adds an animator to call at every animation tick during main loop execution. + /// Adds an animator to call at every animation tick during the main loop execution. /// - /// The function to call when it ticks off - /// A handle to the new animator + /// The function to call when it ticks off. + /// A handle to the new animator. /// preview public static IntPtr AddAnimator(Func handler) { @@ -61,7 +61,7 @@ namespace ElmSharp /// /// Removes the specified animator from the animator list. /// - /// The specified animator handle + /// The specified animator handle. /// preview public static void RemoveAnimator(IntPtr anim) { diff --git a/src/ElmSharp/ElmSharp/EcoreEvent.cs b/src/ElmSharp/ElmSharp/EcoreEvent.cs index 16e7b0e..bdd73b4 100755 --- a/src/ElmSharp/ElmSharp/EcoreEvent.cs +++ b/src/ElmSharp/ElmSharp/EcoreEvent.cs @@ -22,7 +22,7 @@ using System.Runtime.InteropServices; namespace ElmSharp { /// - /// The EcoreEventType is type of EcoreEvent. + /// The EcoreEventType is a type of EcoreEvent. /// It includes some predefined instance. /// /// preview @@ -110,14 +110,14 @@ namespace ElmSharp } /// - /// The EcoreEvent is a class to help to create events are being notified of events. + /// The EcoreEvent is a class to help create events that are being notified of events. /// - /// Kinds of EventArgs + /// Kinds of EventArgs. /// preview public class EcoreEvent : IDisposable where TEventArgs : EventArgs { /// - /// EventInfoParser delegate of EcoreEvent class + /// EventInfoParser delegate of the EcoreEvent class. /// /// IntPtr /// EcoreEventType @@ -153,7 +153,7 @@ namespace ElmSharp } /// - /// Destructor for EcoreEvent class. + /// Destructor for the EcoreEvent class. /// ~EcoreEvent() { @@ -168,7 +168,7 @@ namespace ElmSharp } /// - /// On Event Handler of EcoreEvent. + /// On Event Handler of the EcoreEvent. /// /// preview public event EventHandler On @@ -196,11 +196,11 @@ namespace ElmSharp } /// - /// Releases all resources currently used by this instance. + /// Releases all the resources currently used by this instance. /// /// - /// true if managed resources should be disposed - /// otherwise, false. + /// true if the managed resources should be disposed, + /// otherwise false. /// /// preview protected virtual void Dispose(bool disposing) @@ -221,7 +221,7 @@ namespace ElmSharp } /// - /// Destroy current object + /// Destroys the current object. /// /// preview public void Dispose() @@ -232,7 +232,7 @@ namespace ElmSharp } /// - /// Event class for EcoreEvent + /// The event class for EcoreEvent. /// /// preview public class EcoreEvent : EcoreEvent diff --git a/src/ElmSharp/ElmSharp/EcoreKeyEventArgs.cs b/src/ElmSharp/ElmSharp/EcoreKeyEventArgs.cs index 64ee150..12106e7 100755 --- a/src/ElmSharp/ElmSharp/EcoreKeyEventArgs.cs +++ b/src/ElmSharp/ElmSharp/EcoreKeyEventArgs.cs @@ -21,18 +21,18 @@ namespace ElmSharp { /// /// It inherits System.EventArgs. - /// The EcoreKeyEventArgs is a EventArgs to record Ecore event's key name and key code. + /// The EcoreKeyEventArgs is an EventArgs to record the Ecore event's key name and key code. /// /// preview public class EcoreKeyEventArgs : EventArgs { /// - /// Gets the KeyName property.The return type is string. + /// Gets the KeyName property. The return type is string. /// /// preview public string KeyName { get; private set; } /// - /// Gets the KeyCode property.The return type is int. + /// Gets the KeyCode property. The return type is int. /// /// preview public int KeyCode { get; private set; } @@ -42,8 +42,8 @@ namespace ElmSharp /// /// data /// type - /// information - /// new instance of the EcoreKeyEventArgs class + /// information + /// New instance of the EcoreKeyEventArgs class. /// preview public static EcoreKeyEventArgs Create(IntPtr data, EcoreEventType type, IntPtr info) { diff --git a/src/ElmSharp/ElmSharp/EcoreMainloop.cs b/src/ElmSharp/ElmSharp/EcoreMainloop.cs index 60202fa..00660cb 100644 --- a/src/ElmSharp/ElmSharp/EcoreMainloop.cs +++ b/src/ElmSharp/ElmSharp/EcoreMainloop.cs @@ -20,7 +20,7 @@ using System.Collections.Concurrent; namespace ElmSharp { /// - /// EcoreMainloop is a helper class, it provide functions relative Ecore's main loop. + /// EcoreMainloop is a helper class, which provides the functions relative to Ecore's main loop. /// /// preview public static class EcoreMainloop @@ -42,7 +42,7 @@ namespace ElmSharp /// /// Checks if you are calling this function from the main thread. /// - /// True is the calling function is the same thread, false otherwise. + /// True if the calling function is the same thread, false otherwise. /// preview public static bool IsMainThread => Interop.Eina.eina_main_loop_is(); @@ -56,7 +56,7 @@ namespace ElmSharp } /// - /// Quits the main loop once all the events currently on the queue have been processed. + /// Quits the main loop, once all the events currently on the queue have been processed. /// /// preview public static void Quit() @@ -67,7 +67,7 @@ namespace ElmSharp /// /// Adds an idler handler. /// - /// The action to call when idling + /// The action to call when idle. /// preview public static void Post(Action task) { @@ -76,9 +76,9 @@ namespace ElmSharp } /// - /// Calls callback asynchronously in the main loop. + /// Calls the callback asynchronously in the main loop. /// - /// The action wanted to be called + /// The action wanted to be called. /// preview public static void PostAndWakeUp(Action task) { @@ -87,9 +87,9 @@ namespace ElmSharp } /// - /// Calls callback synchronously in the main loop. + /// Calls the callback synchronously in the main loop. /// - /// The action wanted to be called + /// The action wanted to be called. /// preview public static void Send(Action task) { @@ -102,7 +102,7 @@ namespace ElmSharp /// /// The interval in seconds. /// The given function. - /// A timer object handler on success, NULL on failure. + /// A timer object handler on success, or null on failure. /// preview public static IntPtr AddTimer(double interval, Func handler) { diff --git a/src/ElmSharp/ElmSharp/EcoreSynchronizationContext.cs b/src/ElmSharp/ElmSharp/EcoreSynchronizationContext.cs index eae11c1..6185243 100755 --- a/src/ElmSharp/ElmSharp/EcoreSynchronizationContext.cs +++ b/src/ElmSharp/ElmSharp/EcoreSynchronizationContext.cs @@ -20,7 +20,7 @@ namespace ElmSharp { /// - /// Provides a synchronization context for the efl application. + /// Provides a synchronization context for the EFL application. /// /// preview public class EcoreSynchronizationContext : SynchronizationContext @@ -34,7 +34,7 @@ namespace ElmSharp } /// - /// Initilizes a new EcoreSynchronizationContext and install into current thread + /// Initilizes a new EcoreSynchronizationContext and installs into the current thread. /// /// /// It is equivalent @@ -64,7 +64,7 @@ namespace ElmSharp } /// - /// Dispatches a synchronous message to a Ecore main loop + /// Dispatches an synchronous message to a Ecore main loop. /// /// The SendOrPostCallback delegate to call. /// The object passed to the delegate. diff --git a/src/ElmSharp/ElmSharp/EcoreTimelineAnimator.cs b/src/ElmSharp/ElmSharp/EcoreTimelineAnimator.cs index 5343230..c0e3b2b 100644 --- a/src/ElmSharp/ElmSharp/EcoreTimelineAnimator.cs +++ b/src/ElmSharp/ElmSharp/EcoreTimelineAnimator.cs @@ -19,7 +19,7 @@ using System; namespace ElmSharp { /// - /// EcoreTimelineAnimator is a helper class, it provides functions to manager animations. + /// EcoreTimelineAnimator is a helper class, which provides the functions to manage animations. /// /// preview public class EcoreTimelineAnimator @@ -39,8 +39,8 @@ namespace ElmSharp /// /// Creates and initializes a new instance of the EcoreTimelineAnimator class. /// - /// The time to run in seconds - /// Functions called at each time line + /// The time to run in seconds. + /// Functions called at each time line. /// preview public EcoreTimelineAnimator(double runtime, Action timelineCallback) { @@ -63,7 +63,7 @@ namespace ElmSharp public double Position => _position; /// - /// Starts an animator that runs for a limited time.for a limited time. + /// Starts an animator that runs for a limited time. /// /// preview public void Start() @@ -73,7 +73,7 @@ namespace ElmSharp } /// - /// Stops an animator that running. + /// Stops an animator that is running. /// /// preview public void Stop() @@ -101,7 +101,7 @@ namespace ElmSharp } /// - /// Callback that is called when ticks off + /// Callback is called when it ticks off. /// /// preview protected void OnTimeline() diff --git a/src/ElmSharp/ElmSharp/EdjeObject.cs b/src/ElmSharp/ElmSharp/EdjeObject.cs index 9e04e87..fbbafa1 100644 --- a/src/ElmSharp/ElmSharp/EdjeObject.cs +++ b/src/ElmSharp/ElmSharp/EdjeObject.cs @@ -21,7 +21,7 @@ using System.Collections.Generic; namespace ElmSharp { /// - /// The EdjeObject is a class that evas object exist in + /// The EdjeObject is a class that the evas object exists in. /// /// preview public class EdjeObject @@ -38,9 +38,9 @@ namespace ElmSharp /// Checks whether an edje part exists in a given edje object's group definition. /// This function returns if a given part exists in the edje group bound to object obj /// - /// This call is useful, for example, when one could expect a given GUI element, depending on the theme applied to obj. - /// The part's name to check for existence in obj's group - /// TRUE, if the edje part exists in obj's group, otherwise FALSE + /// This call is useful, for example, when one could expect a given GUI element, depending on the theme applied to object. + /// The part's name to check for existence in object's group. + /// TRUE, if the edje part exists in the object's group, otherwise FALSE. /// preview public EdjeTextPartObject this[string part] { @@ -55,7 +55,7 @@ namespace ElmSharp } /// - /// Sends/emits an edje signal to a given edje object. + /// Sends or emits an edje signal to a given edje object. /// /// The signal's "emission" string /// The signal's "source" string @@ -66,11 +66,11 @@ namespace ElmSharp } /// - /// Deletes the object color class. - /// This function deletes any values at the object level for the specified object and color class. + /// Deletes the object Color class. + /// This function deletes any values at the object level for the specified object and Color class. /// - /// Deleting the color class defined in the theme file. - /// The color class to be deleted + /// Deleting the Color class defined in the theme file. + /// The Color class to be deleted. /// preview public void DeleteColorClass(string part) { @@ -78,22 +78,22 @@ namespace ElmSharp } /// - /// Sets the object color class. + /// Sets the object Color class. /// - /// The color class name. - /// The object Red value. - /// The object Green value. - /// The object Blue value. - /// The object Alpha value. - /// The outline Red value. - /// The outline Green value. - /// The outline Blue value. - /// The outline Alpha value. - /// The shadow Red value. - /// The shadow Green value. - /// The shadow Blue value. - /// The shadow Alpha value. - /// True if succeed, otherwise False + /// The Color class name. + /// The object red value. + /// The object green value. + /// The object blue value. + /// The object alpha value. + /// The outline red value. + /// The outline green value. + /// The outline blue value. + /// The outline alpha value. + /// The shadow red value. + /// The shadow green value. + /// The shadow blue value. + /// The shadow alpha value. + /// True if succeeds, otherwise False. /// preview public bool SetColorClass(string colorClass, int red, int green, int blue, int alpha, int outlineRed, int outlineGreen, int outlineBlue, int outlineAlpha, int shadowRed, int shadowGreen, int shadowBlue, int shadowAlpha) @@ -103,22 +103,22 @@ namespace ElmSharp } /// - /// Gets the object color class. + /// Gets the object Color class. /// - /// The color class name. - /// The object Red value. - /// The object Green value. - /// The object Blue value. - /// The object Alpha value. - /// The outline Red value. - /// The outline Green value. - /// The outline Blue value. - /// The outline Alpha value. - /// The shadow Red value. - /// The shadow Green value. - /// The shadow Blue value. - /// The shadow Alpha value. - /// True if succeed, otherwise False + /// The Color class name. + /// The object red value. + /// The object green value. + /// The object blue value. + /// The object alpha value. + /// The outline red value. + /// The outline green value. + /// The outline blue value. + /// The outline alpha value. + /// The shadow red value. + /// The shadow green value. + /// The shadow blue value. + /// The shadow alpha value. + /// True if succeeds, otherwise False. /// preview public bool GetColorClass(string colorClass, out int red, out int green, out int blue, out int alpha, out int outlineRed, out int outlineGreen, out int outlineBlue, out int outlineAlpha, out int shadowRed, out int shadowGreen, out int shadowBlue, out int shadowAlpha) @@ -128,12 +128,12 @@ namespace ElmSharp } /// - /// Sets Edje text class. + /// Sets the Edje text class. /// /// The text class name. - /// Font name. + /// Font name. /// Font size. - /// True if succeed, otherwise False + /// True if succeeds, otherwise False. /// preview public bool SetTextClass(string textClass, string font, int fontSize) { @@ -141,12 +141,12 @@ namespace ElmSharp } /// - /// Gets Edje text class. + /// Gets the Edje text class. /// /// The text class name. /// Font name. /// Font size. - /// True if succeed, otherwise False + /// True if succeeds, otherwise False. /// preview public bool GetTextClass(string textClass, out string font, out int fontSize) { @@ -156,9 +156,9 @@ namespace ElmSharp /// /// Adds Action for an arriving edje signal, emitted by a given Ejde object. /// - /// The signal's "emission" string - /// The signal's "source" string - /// The action to be executed when the signal is emitted + /// The signal's "emission" string. + /// The signal's "source" string. + /// The action to be executed when the signal is emitted. /// preview public void AddSignalAction(string emission, string source, Action action) { @@ -181,9 +181,9 @@ namespace ElmSharp /// /// Deletes a signal-triggered action from an object. /// - /// The signal's "emission" string - /// The signal's "source" string - /// The action to be executed when the signal is emitted + /// The signal's "emission" string. + /// The signal's "source" string. + /// The action to be executed when the signal is emitted. /// preview public void DeleteSignalAction(string emission, string source, Action action) { @@ -221,7 +221,7 @@ namespace ElmSharp /// /// The object to compare with the current instance. /// - /// true if obj and this instance are the same type and represent the same value. + /// true if the object and this instance are of the same type and represent the same value. /// otherwise, false. /// public override bool Equals(object obj) @@ -245,7 +245,7 @@ namespace ElmSharp } /// - /// An EdjeTextPartObject is a class dealing with parts of type text. + /// The EdjeTextPartObject is a class dealing with parts of type text. /// /// preview public class EdjeTextPartObject @@ -260,7 +260,7 @@ namespace ElmSharp } /// - /// Gets the name of the EdjeTextPartObject + /// Gets the name of the EdjeTextPartObject. /// /// preview public string Name { get { return _part; } } diff --git a/src/ElmSharp/ElmSharp/EffectBase.cs b/src/ElmSharp/ElmSharp/EffectBase.cs index 362e60d..8194aec 100755 --- a/src/ElmSharp/ElmSharp/EffectBase.cs +++ b/src/ElmSharp/ElmSharp/EffectBase.cs @@ -19,13 +19,13 @@ using System; namespace ElmSharp { /// - /// EffectBase class for the TransitEffect + /// The EffectBase class for TransitEffect. /// /// preview public abstract class EffectBase { /// - /// EffectEneded event will be triggered when be effect ended. + /// EffectEnded event will be triggered when the effect has ended. /// /// preview public event EventHandler EffectEnded; diff --git a/src/ElmSharp/ElmSharp/Elementary.cs b/src/ElmSharp/ElmSharp/Elementary.cs index ef66745..ccf4f9a 100755 --- a/src/ElmSharp/ElmSharp/Elementary.cs +++ b/src/ElmSharp/ElmSharp/Elementary.cs @@ -21,29 +21,29 @@ using System.IO; namespace ElmSharp { /// - /// Focus Autoscroll Mode + /// Focus Autoscroll mode. /// /// preview public enum FocusAutoScrollMode { /// - /// Directly show the focused region or item automatically + /// Directly show the focused region or item automatically. /// Show, /// - /// Do not show the focused region or item automatically + /// Do not show the focused region or item automatically. /// None, /// - /// Bring in the focused region or item automatically which might invole the scrolling + /// Bring in the focused region or item automatically, which might involve the scrolling. /// BringIn } /// - /// The Elementary is a General Elementary,a VERY SIMPLE toolkit. + /// The Elementary is a general elementary, a VERY SIMPLE toolkit. /// /// preview public static class Elementary @@ -67,7 +67,7 @@ namespace ElmSharp } /// - /// Gets or sets the enable status of the focus highlight animation + /// Gets or sets the enable status of the focus highlight animation. /// /// preview public static bool IsFocusHighlightAnimation @@ -148,7 +148,7 @@ namespace ElmSharp } /// - /// Gets or sets the amount of inertia a scroller imposes during region bring animations. + /// Gets or sets the amount of inertia, a scroller imposes during a region to bring animations. /// /// preview public static double BringInScrollFriction @@ -164,7 +164,7 @@ namespace ElmSharp } /// - /// Gets of sets focus auto scroll mode. + /// Gets or sets the focus on autoscroll mode. /// /// preview public static FocusAutoScrollMode FocusAutoScrollMode @@ -198,7 +198,7 @@ namespace ElmSharp } /// - /// Runs Elementary's main loop. + /// Runs the elementary's main loop. /// /// preview public static void Run() @@ -207,7 +207,7 @@ namespace ElmSharp } /// - /// Prepends a theme overlay to the list of overlays + /// Prepends a theme overlay to the list of overlays. /// /// preview [EditorBrowsable(EditorBrowsableState.Never)] @@ -220,9 +220,9 @@ namespace ElmSharp } /// - /// Prepends a theme overlay to the list of overlays + /// Prepends a theme overlay to the list of overlays. /// - /// The Edje file path to be used. + /// The edje file path to be used. /// preview public static void AddThemeOverlay(string filePath) { @@ -230,7 +230,7 @@ namespace ElmSharp } /// - /// Delete a theme overlay from the list of overlays + /// Deletes a theme overlay from the list of overlays. /// /// The name of the theme overlay. /// preview @@ -240,7 +240,7 @@ namespace ElmSharp } /// - /// Free a theme + /// Frees a theme. /// /// preview public static void FreeTheme() @@ -249,10 +249,10 @@ namespace ElmSharp } /// - /// Set the theme search order for the given theme + /// Sets the theme search order for the given theme. /// - /// Theme search string - /// This sets the search string for the theme in path-notation from first theme to search, to last, delimited by the : character. Example:"shiny:/path/to/file.edj:default" + /// Theme search string. + /// This sets the search string for the theme in path-notation from the first theme to search, to last, delimited by the : character. For example, "shiny:/path/to/file.edj:default". /// preview public static void SetTheme(string theme) { @@ -260,7 +260,7 @@ namespace ElmSharp } /// - /// Flush the current theme. + /// Flushes the current theme. /// /// preview public static void FlushTheme() @@ -269,7 +269,7 @@ namespace ElmSharp } /// - /// This flushes all themes (default and specific ones). + /// This flushes all the themes (default and specific ones). /// /// preview public static void FlushAllThemes() @@ -288,7 +288,7 @@ namespace ElmSharp } /// - /// Gets the amount of inertia a scroller imposes during region bring animations. + /// Gets the amount of inertia that a scroller imposes during region to bring animations. /// /// preview [EditorBrowsable(EditorBrowsableState.Never)] @@ -298,7 +298,7 @@ namespace ElmSharp } /// - /// Sets the amount of inertia a scroller imposes during region bring animations. + /// Sets the amount of inertia that a scroller imposes during the region bring animations. /// /// preview [EditorBrowsable(EditorBrowsableState.Never)] @@ -309,7 +309,7 @@ namespace ElmSharp } /// - /// Get Elementary's profile in use + /// Gets the elementary's profile in use. /// /// preview [EditorBrowsable(EditorBrowsableState.Never)] @@ -319,7 +319,7 @@ namespace ElmSharp } /// - /// Set the global scaling factor + /// Sets the global scaling factor. /// /// preview [EditorBrowsable(EditorBrowsableState.Never)] @@ -329,7 +329,7 @@ namespace ElmSharp } /// - /// Get the global scaling factor + /// Gets the global scaling factor. /// /// preview [EditorBrowsable(EditorBrowsableState.Never)] @@ -339,8 +339,8 @@ namespace ElmSharp } /// - /// Flush all caches. - /// Frees all data that was in cache and is not currently being used to reduce memory usage. This frees Edje's, Evas' and Eet's cache. + /// Flushes all the cache. + /// Frees all data that was in cache and is not currently being used, to reduce memory usage. This frees Edje's, Evas', and Eet's cache. /// /// preview public static void FlushAllCashe() @@ -351,7 +351,7 @@ namespace ElmSharp /// /// Changes the language of the current application. /// - /// The language to set, must be the full name of the locale. + /// The language to set must be the full name of the locale. /// preview public static void SetLanguage(string language) { @@ -361,8 +361,8 @@ namespace ElmSharp /// /// Sets a new policy's value (for a given policy group/identifier). /// - /// The policy identifier - /// The policy value, which depends on the identifier + /// The policy identifier. + /// The policy value, which depends on the identifier. /// /// preview public static bool SetPolicy(uint policy, int value) @@ -371,7 +371,7 @@ namespace ElmSharp } /// - /// Reload Elementary's configuration, bounded to current selected profile. + /// Reloads the elementary's configuration, bounded to the current selected profile. /// /// preview [EditorBrowsable(EditorBrowsableState.Never)] @@ -381,7 +381,7 @@ namespace ElmSharp } /// - /// Flushes all config settings and then applies those settings to all applications using elementary on the current display. + /// Flushes all the configuration settings, and then applies those settings to all applications using elementary on the current display. /// /// preview public static void FlushAllConfig() diff --git a/src/ElmSharp/ElmSharp/ElmScrollConfig.cs b/src/ElmSharp/ElmSharp/ElmScrollConfig.cs index f54c103..e8e7c45 100755 --- a/src/ElmSharp/ElmSharp/ElmScrollConfig.cs +++ b/src/ElmSharp/ElmSharp/ElmScrollConfig.cs @@ -20,13 +20,13 @@ using System.ComponentModel; namespace ElmSharp { /// - /// The ElmScrollConfig is a scrollable views's config + /// The ElmScrollConfig is a scrollable views's configuration. /// /// preview public static class ElmScrollConfig { /// - /// Gets or sets the amount of inertia a scroller imposes during region bring animations. + /// Gets or sets the amount of inertia that a scroller imposes during the region to bring animations. /// /// preview [EditorBrowsable(EditorBrowsableState.Never)] diff --git a/src/ElmSharp/ElmSharp/Entry.cs b/src/ElmSharp/ElmSharp/Entry.cs index d5f8c06..121ace0 100755 --- a/src/ElmSharp/ElmSharp/Entry.cs +++ b/src/ElmSharp/ElmSharp/Entry.cs @@ -21,196 +21,196 @@ using System.Runtime.InteropServices; namespace ElmSharp { /// - /// Enumeration for describing InputPanel layout type. + /// Enumeration for describing the InputPanel layout types. /// /// preview public enum InputPanelLayout { /// - /// InputPanel layout type default. + /// The InputPanel layout type default. /// Normal, /// - /// InputPanel layout type number. + /// The InputPanel layout type number. /// Number, /// - /// InputPanel layout type email. + /// The InputPanel layout type email. /// Email, /// - /// InputPanel layout type url. + /// The InputPanel layout type URL. /// Url, /// - /// InputPanel layout type phone. + /// The InputPanel layout type phone. /// PhoneNumber, /// - /// InputPanel layout type ip. + /// The InputPanel layout type IP. /// Ip, /// - /// InputPanel layout type month. + /// The InputPanel layout type month. /// Month, /// - /// InputPanel layout type number. + /// The InputPanel layout type number. /// NumberOnly, /// - /// InputPanel layout type error type. Do not use it directly! + /// The InputPanel layout type error type. Do not use it directly! /// Invalid, /// - /// InputPanel layout type hexadecimal. + /// The InputPanel layout type hexadecimal. /// Hex, /// - /// InputPanel layout type terminal type, esc, alt, ctrl, etc. + /// The InputPanel layout type terminal type: Esc, Alt, Ctrl, etc. /// Terminal, /// - /// InputPanel layout type password. + /// The InputPanel layout type password. /// Password, /// - /// Keyboard layout type date and time. + /// The keyboard layout type date and time. /// DateTime, /// - /// InputPanel layout type emoticons. + /// The InputPanel layout type emoticons. /// Emoticon } /// - /// Enumeration that defines the "Return" key types on the input panel (virtual keyboard). + /// Enumeration for defining the "Return" key types on the input panel (virtual keyboard). /// /// preview public enum InputPanelReturnKeyType { /// - /// Default key type + /// The Default key type. /// Default, /// - /// Done key type + /// The Done key type. /// Done, /// - /// Go key type + /// The Go key type. /// Go, /// - /// Join key type + /// The Join key type. /// Join, /// - /// Login key type + /// The Login key type. /// Login, /// - /// Next key type + /// The Next key type. /// Next, /// - /// Search string or magnifier icon key type + /// The Search string or magnifier icon key type. /// Search, /// - /// Send key type + /// The Send key type. /// Send, /// - /// Sign-in key type + /// The Sign-in key type. /// Signin } /// - /// Enumeration that defines the autocapitalization types. + /// Enumeration for defining the autocapitalization types. /// /// preview public enum AutoCapital { /// - /// No autocapitalization when typing + /// No autocapitalization when typing. /// None, /// - /// Autocapitalize each typed word + /// Autocapitalize each of the typed word. /// Word, /// - /// Autocapitalize the start of each sentence + /// Autocapitalize the start of each sentence. /// Sentence, /// - /// Autocapitalize all letters + /// Autocapitalize all the letters. /// All } /// - /// Enumeration that defines the entry's copy and paste policy. + /// Enumeration for defining the entry's copy and paste policy. /// /// preview public enum CopyAndPasteMode { /// - /// Copy and paste text with markup tag + /// Copy and paste text with a markup tag. /// Markup, /// - /// Copy and paste text without item(image) tag + /// Copy and paste text without an item (image) tag. /// NoImage, /// - /// Copy and paste text without markup tag + /// Copy and paste text without a markup tag. /// PlainText } /// - /// Enumeration that defines the text format types. + /// Enumeration for the text format types. /// /// preview public enum TextFormat { /// - /// Plain type + /// Plain type. /// Plain, /// - /// Markup type + /// Markup type. /// Markup } @@ -222,40 +222,40 @@ namespace ElmSharp public enum InputHints { /// - /// No active hints + /// No active hints. /// None, /// - /// suggest word auto completion + /// Suggest word auto-completion. /// AutoComplete, /// - /// typed text should not be stored. + /// The typed text should not be stored. /// SensitiveData, } /// - /// Enumeration that defines the input panel (virtual keyboard) language modes. + /// Enumeration for defining the input panel (virtual keyboard) language modes. /// /// preview public enum InputPanelLanguage { /// - /// Automatic language mode + /// Automatic language mode. /// Automatic, /// - /// Alphabet language mode + /// Alphabet language mode. /// Alphabet, } /// - /// The entry is a convenience widget that shows a box in which the user can enter text. + /// The Entry is a convenience widget that shows a box in which the user can enter text. /// /// preview public class Entry : Layout @@ -289,7 +289,7 @@ namespace ElmSharp } /// - /// Activated will be triggered when the entry in Activated stated. + /// Activated will be triggered when the entry is activated. /// /// preview public event EventHandler Activated; @@ -301,13 +301,13 @@ namespace ElmSharp public event EventHandler Clicked; /// - /// ChangedByUser will be triggered when the entry changed by user. + /// ChangedByUser will be triggered when the entry is changed by user. /// /// preview public event EventHandler ChangedByUser; /// - /// CursorChanged will be triggered when the Cursor in the entry is changed. + /// CursorChanged will be triggered when the cursor in the entry is changed. /// /// preview public event EventHandler CursorChanged; @@ -373,7 +373,7 @@ namespace ElmSharp } /// - /// Sets or gets text currently shown in the object entry. + /// Sets or gets the text currently shown in the object entry. /// /// preview public override string Text @@ -389,9 +389,9 @@ namespace ElmSharp } /// - /// Sets or gets the style on the top of the user style stack. + /// Sets or gets the style on top of the user style stack. /// - /// If there is styles in the user style stack, the properties in the top style of user style stack will replace the properties in current theme. The input style is specified in format tag='property=value' (i.e. DEFAULT='font=Sans font_size=60'hilight=' + font_weight=Bold'). + /// If there are styles in the user style stack, the properties in the top style of the user style stack will replace the properties in current theme. The input style is specified in the format, tag='property=value' (i.e., DEFAULT='font=Sans font_size=60'hilight=' + font_weight=Bold'). /// preview public string TextStyle { @@ -445,7 +445,7 @@ namespace ElmSharp } /// - /// Sets or Gets the autocapitalization type on the immodule. + /// Sets or gets the autocapitalization type on the immodule. /// /// preview public AutoCapital AutoCapital @@ -461,7 +461,7 @@ namespace ElmSharp } /// - /// Sets or Gets the entry object's 'autosave' status. + /// Sets or gets the entry object's 'autosave' status. /// /// preview public bool IsAutoSave @@ -477,7 +477,7 @@ namespace ElmSharp } /// - /// Sets or Gets entry text paste/drop mode. + /// Sets or gets the entry text paste/drop mode. /// /// preview public CopyAndPasteMode CopyAndPasteMode @@ -531,7 +531,7 @@ namespace ElmSharp } /// - /// Sets or Gets the value of input hint. + /// Sets or gets the value of the input hint. /// /// preview public InputHints InputHint @@ -579,7 +579,7 @@ namespace ElmSharp } /// - /// Sets or gets the line wrap type to use on multi-line entries. + /// Sets or gets the line wrap type to use on multiline entries. /// /// preview public WrapType LineWrapType @@ -627,9 +627,9 @@ namespace ElmSharp } /// - /// Sets or gets the attribute to show the input panel in case of only an user's explicit Mouse Up event. + /// Sets or gets the attribute to show the input panel, in case of only an user's explicit Mouse Up event. /// It doesn't request to show the input panel even though it has focus. - /// If true, the input panel will be shown in case of only Mouse up event. (Focus event will be ignored.) + /// If true, the input panel will be shown only in case of the Mouse up event (Focus event will be ignored). /// /// preview public bool InputPanelShowByOnDemand @@ -647,8 +647,8 @@ namespace ElmSharp /// /// Sets the file (and implicitly loads it) for the text to display and then edit. /// - /// The path to the file to load and save - /// The file format + /// The path to the file to load and save. + /// The file format. /// preview public void SetFile(string file, TextFormat textFormat) { @@ -658,8 +658,8 @@ namespace ElmSharp /// /// Converts a markup (HTML-like) string into UTF-8. /// - /// The string (in markup) to be converted - /// The converted string (in UTF-8) + /// The string (in markup) to be converted. + /// The converted string (in UTF-8). /// preview public static string ConvertMarkupToUtf8(string markup) { @@ -679,7 +679,7 @@ namespace ElmSharp /// /// Moves the cursor one place to the left within the entry. /// - /// TRUE on success, otherwise FALSE on failure + /// TRUE on success, otherwise FALSE on failure. /// preview public bool MoveCursorPrev() { @@ -689,7 +689,7 @@ namespace ElmSharp /// /// Moves the cursor one line up within the entry. /// - /// TRUE on success, otherwise FALSE on failure + /// TRUE on success, otherwise FALSE on failure. /// preview public bool MoveCursorUp() { @@ -699,7 +699,7 @@ namespace ElmSharp /// /// Moves the cursor one line down within the entry. /// - /// TRUE on success, otherwise FALSE on failure + /// TRUE on success, otherwise FALSE on failure. /// preview public bool MoveCursorDown() { @@ -745,7 +745,7 @@ namespace ElmSharp /// /// Sets the input panel layout of the entry. /// - /// The layout type + /// The layout type. /// preview public void SetInputPanelLayout(InputPanelLayout layout) { @@ -755,7 +755,7 @@ namespace ElmSharp /// /// Sets the attribute to show the input panel automatically. /// - /// If true the input panel appears when the entry is clicked or has focus, otherwise false + /// If true, the input panel appears when the entry is clicked or has focus, otherwise false. /// preview public void SetInputPanelEnabled(bool enabled) { @@ -765,7 +765,7 @@ namespace ElmSharp /// /// Sets the "return" key type. This type is used to set the string or icon on the "return" key of the input panel. /// - /// The type of "return" key on the input panel + /// The type of "return" key on the input panel. /// preview public void SetInputPanelReturnKeyType(InputPanelReturnKeyType keyType) { @@ -804,7 +804,7 @@ namespace ElmSharp } /// - /// Forces calculation of the entry size and text layouting. + /// Forces calculation of the entry size and text layout. /// /// preview public void ForceCalculation() @@ -823,7 +823,7 @@ namespace ElmSharp } /// - /// Begins a selection within the entry as though the user were holding down the mouse button to make a selection. + /// Begins a selection within the entry, as though the user was holding down the mouse button to make a selection. /// /// preview public void BeginCursorSelection() @@ -834,7 +834,7 @@ namespace ElmSharp /// /// Appends the text of the entry. /// - /// The text to be displayed + /// The text to be displayed. /// preview public void AppendText(string text) { @@ -842,10 +842,10 @@ namespace ElmSharp } /// - /// Sets or gets the value of HorizontalScrollBarVisiblePolicy + /// Sets or gets the value of the HorizontalScrollBarVisiblePolicy. /// /// - /// ScrollBarVisiblePolicy.Auto means the horizontal scrollbar is made visible if it is needed, and otherwise kept hidden. + /// ScrollBarVisiblePolicy.Auto means that the horizontal scrollbar is made visible if it is needed, or otherwise kept hidden. /// ScrollBarVisiblePolicy.Visible turns it on all the time, and ScrollBarVisiblePolicy.Invisible always keeps it off. /// /// preview @@ -865,10 +865,10 @@ namespace ElmSharp } /// - /// Sets or gets the value of VerticalScrollBarVisiblePolicy + /// Sets or gets the value of VerticalScrollBarVisiblePolicy. /// /// - /// ScrollBarVisiblePolicy.Auto means the vertical scrollbar is made visible if it is needed, and otherwise kept hidden. + /// ScrollBarVisiblePolicy.Auto means that the vertical scrollbar is made visible if it is needed, or otherwise kept hidden. /// ScrollBarVisiblePolicy.Visible turns it on all the time, and ScrollBarVisiblePolicy.Invisible always keeps it off. /// /// preview @@ -888,11 +888,11 @@ namespace ElmSharp } /// - /// Sets or gets the vertical bounce behaviour. + /// Sets or gets the vertical bounce behavior. /// When scrolling, the scroller may "bounce" when reaching an edge of the content object. - /// This is a visual way to indicate the end has been reached. - /// This is enabled by default for both axis. - /// This API will set if it is enabled for the given axis with the boolean parameters for each axis. + /// This is a visual way to indicate that the end has reached. + /// This is enabled by default for both the axis. + /// This API will be set if it is enabled for the given axis with boolean parameters for each axis. /// /// preview public bool VerticalBounce @@ -911,11 +911,11 @@ namespace ElmSharp } /// - /// Sets or gets the horizontal bounce behaviour. + /// Sets or gets the horizontal bounce behavior. /// When scrolling, the scroller may "bounce" when reaching an edge of the content object. - /// This is a visual way to indicate the end has been reached. - /// This is enabled by default for both axis. - /// This API will set if it is enabled for the given axis with the boolean parameters for each axis. + /// This is a visual way to indicate that the end has reached. + /// This is enabled by default for both the axis. + /// This API will be set if it is enabled for the given axis with boolean parameters for each axis. /// /// preview public bool HorizontalBounce @@ -936,7 +936,7 @@ namespace ElmSharp /// /// Inserts the given text into the entry at the current cursor position. /// - /// + /// The text to be inserted. /// preview public void InsertTextToCursor(string text) { @@ -953,7 +953,7 @@ namespace ElmSharp } /// - /// Writes any changes made to the file that is set by File. + /// Writes any changes made to the file that is set by a file. /// /// preview public void SaveFile() @@ -962,11 +962,11 @@ namespace ElmSharp } /// - /// Show the input panel (virtual keyboard) based on the input panel property of entry such as layout, autocapital types, and so on. + /// Show the input panel (virtual keyboard) based on the input panel property of the entry such as layout, autocapital types, and so on. /// /// - /// Note that input panel is shown or hidden automatically according to the focus state of entry widget. - /// This API can be used in the case of manually controlling by using SetInputPanelEnabled(false). + /// 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 the case of manual control by using the SetInputPanelEnabled(false). /// /// preview public void ShowInputPanel() @@ -1035,7 +1035,7 @@ namespace ElmSharp } /// - /// Append a markup filter function for text inserted in the entry. + /// Appends a markup filter function for text inserted in the entry. /// /// This function type is used by entry filters to modify text. /// preview @@ -1061,7 +1061,7 @@ namespace ElmSharp } /// - /// Prepend a markup filter function for text inserted in the entry. + /// Prepends a markup filter function for text inserted in the entry. /// /// This function type is used by entry filters to modify text. /// preview @@ -1087,7 +1087,7 @@ namespace ElmSharp } /// - /// Remove a markup filter + /// Removes a markup filter. /// /// This function type is used by entry filters to modify text. /// preview @@ -1131,9 +1131,9 @@ namespace ElmSharp } /// - /// This disabled the entry's selection. + /// This disables the entry's selection. /// - /// If true, the selection are disabled. + /// If true, the selection is disabled. /// preview public void DisableSelection(bool disable) { @@ -1141,9 +1141,9 @@ namespace ElmSharp } /// - /// Get any selected text within the entry. + /// Gets any selected text within the entry. /// - /// Selection's value + /// Selection's value. /// preview public string GetSelection() { @@ -1153,7 +1153,7 @@ namespace ElmSharp /// /// This selects a region of text within the entry. /// - /// The starting position. + /// The start position. /// The end position. /// preview public void SetSelectionRegion(int start, int end) @@ -1162,9 +1162,9 @@ namespace ElmSharp } /// - /// Sets the visibility of the left-side widget of the entry + /// Sets the visibility of the left-side widget of the entry. /// - /// true if the object should be displayed, false if not. + /// true if the object should be displayed, otherwise false. /// preview public void SetIconVisible(bool isDisplay) { @@ -1172,7 +1172,7 @@ namespace ElmSharp } /// - /// Set whether the return key on the input panel is disabled automatically when entry has no text. + /// Sets whether the return key on the input panel is disabled automatically, when the entry has no text. /// /// If enabled is true, the return key is automatically disabled when the entry has no text. /// preview @@ -1184,8 +1184,8 @@ namespace ElmSharp /// /// Creates a widget handle. /// - /// Parent EvasObject - /// Handle IntPtr + /// Parent EvasObject. + /// Handle IntPtr. /// preview protected override IntPtr CreateHandle(EvasObject parent) { diff --git a/src/ElmSharp/ElmSharp/EvasCanvas.cs b/src/ElmSharp/ElmSharp/EvasCanvas.cs index c536ec0..8136656 100755 --- a/src/ElmSharp/ElmSharp/EvasCanvas.cs +++ b/src/ElmSharp/ElmSharp/EvasCanvas.cs @@ -20,14 +20,14 @@ using System.Collections.Generic; namespace ElmSharp { /// - /// Low level Evas canvas functions. Sub groups will present more high level ones, though. - /// Most of these functions deal with low level Evas actions, like: - /// create/destroy raw canvases, not bound to any displaying engine - /// tell a canvas i got focused(in a windowing context, for example) - /// tell a canvas a region should not be calculated anymore in rendering - /// tell a canvas to render its contents, immediately - /// Most users will be using Evas by means of the Ecore_Evas wrapper, which deals with all the above mentioned issues automatically for them.Thus, you'll be looking at this section only if you're building low level stuff. - /// The groups within present you functions that deal with the canvas directly, too, and not yet with its objects.They are the functions you need to use at a minimum to get a working canvas. + /// Low-level Evas canvas functions. Subgroups will be present more than the high-level ones, though. + /// Most of these functions deal with low-level Evas actions like: + /// create/destroy raw canvases, not bound to any displaying engine. + /// tell a canvas, I got focused (in a windowing context, for example). + /// tell a canvas, a region should not be calculated anymore in rendering. + /// tell a canvas, to render its contents immediately. + /// Most users will be using Evas by means of the Ecore_Evas wrapper, which deals with all the above mentioned issues automatically for them. Thus, you will be looking at this section only if you're building low-level stuff. + /// The groups within, present you functions that deal with the canvas directly too, and not yet with its objects. They are the functions you need to use at a minimum to get a working canvas. /// /// preview public class EvasCanvas @@ -57,7 +57,7 @@ namespace ElmSharp /// /// Gets or sets the image cache. - /// This function returns the image cache size of canvas in bytes. + /// This function returns the image cache size of the canvas in bytes. /// /// preview public int ImageCacheSize @@ -73,7 +73,7 @@ namespace ElmSharp } /// - /// Flush the image cache of the canvas. + /// Flushes the image cache of the canvas. /// /// preview public void FlushImageCache() @@ -82,7 +82,7 @@ namespace ElmSharp } /// - /// Add a damage rectangle. + /// Adds a damage rectangle. /// /// The rectangle's top left corner's horizontal coordinate. /// The rectangle's top left corner's vertical coordinate. @@ -95,7 +95,7 @@ namespace ElmSharp } /// - /// Add an "obscured region" to an Evas canvas. + /// Adds an "obscured region" to an Evas canvas. /// /// The rectangle's top left corner's horizontal coordinate. /// The rectangle's top left corner's vertical coordinate. @@ -108,7 +108,7 @@ namespace ElmSharp } /// - /// Remove all "obscured regions" from an Evas canvas. + /// Removes all the "obscured regions" from an Evas canvas. /// /// preview public void ClearObscuredRectangle() @@ -117,10 +117,10 @@ namespace ElmSharp } /// - /// Adds or registers a event to a given canvas event. + /// Adds or registers an event to a given canvas event. /// - /// The type of event that triggers - /// The action to be called when the event is triggered + /// The type of event that triggers. + /// The action to be called when the event is triggered. /// preview public void AddEventAction(EvasObjectCallbackType type, Action action) { @@ -138,9 +138,9 @@ namespace ElmSharp } /// - /// Deletes a event to a given canvas event. + /// Deletes an event to a given canvas event. /// - /// The type of event that triggers + /// The type of event that triggers. /// The action to be called when the event is triggered /// preview public void DeleteEventAction(EvasObjectCallbackType type, Action action) @@ -163,7 +163,7 @@ namespace ElmSharp /// Creates an Evas canvas handle. /// /// EvasObject - /// Handle IntPtr + /// Handle IntPtr. IntPtr CreateHandle(IntPtr evasObject) { return Interop.Evas.evas_object_evas_get(evasObject); @@ -185,8 +185,8 @@ namespace ElmSharp /// /// The object to compare with the current instance. /// - /// true if obj and this instance are the same type and represent the same value. - /// otherwise, false. + /// true if the object and this instance are of the same type and represent the same value, + /// otherwise false. /// public override bool Equals(object obj) { diff --git a/src/ElmSharp/ElmSharp/EvasImage.cs b/src/ElmSharp/ElmSharp/EvasImage.cs index 6e823ed..9768b2e 100755 --- a/src/ElmSharp/ElmSharp/EvasImage.cs +++ b/src/ElmSharp/ElmSharp/EvasImage.cs @@ -23,7 +23,7 @@ using System.Text; namespace ElmSharp { /// - /// This group provides functions for image objects. + /// This group provides the functions for image objects. /// /// preview public class EvasImage : EvasObject @@ -32,9 +32,9 @@ namespace ElmSharp IntPtr _handle = IntPtr.Zero; /// - /// Creates and initializes a new instance of EvasImage class. + /// Creates and initializes a new instance of the EvasImage class. /// - /// The parent is a given container which will be attached by EvasImage as a child. It's type. + /// The parent is a given container, which will be attached by EvasImage as a child. It's type. /// preview public EvasImage(EvasObject parent) : base(parent) { @@ -47,7 +47,7 @@ namespace ElmSharp } /// - /// Sets or gets the source file from where an image object must fetch the real image data + /// Sets or gets the source file from where an image object must fetch the real image data. /// /// preview public string File @@ -81,7 +81,7 @@ namespace ElmSharp } /// - /// Sets or gets whether an object is clipped by source object's clipper. + /// Sets or gets whether an object is clipped by the source object's clipper. /// /// preview public bool IsSourceClipped @@ -134,7 +134,7 @@ namespace ElmSharp } /// - /// Sets or gets the scaling factor (multiplier) for the borders of an image object. + /// Sets or gets the scaling factor (multiplier) for the borders of the image object. /// /// preview public double BorderScale @@ -180,7 +180,7 @@ namespace ElmSharp } /// - /// Sets or gets whether alpha channel data is being used on the given image object. + /// Sets or gets whether the alpha channel data is being used on the given image object. /// /// preview public bool IsOpaque @@ -196,7 +196,7 @@ namespace ElmSharp } /// - /// Sets or gets whether to use high-quality image scaling algorithm on the given image object. + /// Sets or gets whether to use a high-quality image scaling algorithm on the given image object. /// /// preview public bool IsSmoothScaled @@ -214,7 +214,7 @@ namespace ElmSharp /// /// Sets how to fill an image object's drawing rectangle given the (real) image bound to it. /// - /// + /// The rectangle of the given image object that the image will be drawn to. /// preview public void SetFill(Rect geometry) { @@ -224,8 +224,8 @@ namespace ElmSharp /// /// Sets the source file from where an image object must fetch the real image data (it may be an Eet file, besides pure image ones). /// - /// The image file path - /// The image key in file (if its an Eet one), otherwise set null + /// The image file path. + /// The image key in file (if its an Eet one), otherwise set null. /// preview public void SetFile(string file, string key) { @@ -233,7 +233,7 @@ namespace ElmSharp } /// - /// Sets the data for an image from memory to be loaded. + /// Sets the data for an image from the memory to be loaded. /// /// memory stream /// preview @@ -256,10 +256,10 @@ namespace ElmSharp } /// - /// Sets the source object on an image object to used as a proxy. + /// Sets the source object on an image object to be used as a proxy. /// - /// The proxy (image) object - /// true if the source object is set successfully, ortherwise false on error + /// The proxy (image) object. + /// true if the source object is set successfully, otherwise false on error. /// preview public bool SetSource(EvasObject source) { @@ -272,7 +272,7 @@ namespace ElmSharp } /// - /// Set the native surface of a given image of the canvas + /// Set the native surface of a given image of the canvas. /// /// The surface. /// preview @@ -285,10 +285,10 @@ namespace ElmSharp /// /// Sets the dimensions for an image object's border, a region which is not scaled together with its center ever. /// - /// The border's left width - /// The border's right width - /// The border's top width - /// The border's bottom width + /// The border's left width. + /// The border's right width. + /// The border's top width. + /// The border's bottom width. /// preview public void SetBorder(int left, int right, int top, int bottom) { @@ -298,8 +298,8 @@ namespace ElmSharp /// /// Sets the content at a part of a given container widget. /// - /// The parent is a given container which will be attached by Image as a child. It's type. - /// The new object, otherwise null if it cannot be created + /// The parent is a given container, which will be attached by the image as a child. It's type. + /// The new object, otherwise null if it cannot be created. /// preview protected override IntPtr CreateHandle(EvasObject parent) { diff --git a/src/ElmSharp/ElmSharp/EvasKeyEventArgs.cs b/src/ElmSharp/ElmSharp/EvasKeyEventArgs.cs index af12a72..7b8cd4c 100755 --- a/src/ElmSharp/ElmSharp/EvasKeyEventArgs.cs +++ b/src/ElmSharp/ElmSharp/EvasKeyEventArgs.cs @@ -20,7 +20,7 @@ using System.Runtime.InteropServices; namespace ElmSharp { /// - /// The EvasKeyEventArgs is an EvasKey EventArgs + /// The EvasKeyEventArgs is a EvasKey EventArgs. /// /// preview public class EvasKeyEventArgs : EventArgs @@ -28,25 +28,25 @@ namespace ElmSharp IntPtr _nativeEventInfo; /// - /// BackButton name in Platform + /// BackButton name in platform. /// /// preview public const string PlatformBackButtonName = "XF86Back"; /// - /// MenuButton name in Platform + /// MenuButton name in platform. /// /// preview public const string PlatformMenuButtonName = "XF86Menu"; /// - /// HomeButton name in Platform + /// HomeButton name in platform. /// /// preview public const string PlatformHomeButtonName = "XF86Home"; /// - /// Gets the name of Key + /// Gets the name of the key. /// /// preview public string KeyName { get; private set; } @@ -79,10 +79,10 @@ namespace ElmSharp /// /// Creates and initializes a new instance of the EvasKeyEventArgs class. /// - /// data info - /// object - /// information - /// EvasKey eventArgs + /// The data information. + /// The object. + /// The information. + /// EvasKey eventArgs. /// preview static public EvasKeyEventArgs Create(IntPtr data, IntPtr obj, IntPtr info) { @@ -96,44 +96,44 @@ namespace ElmSharp struct EvasEventKeyDown { /// - /// Name string of the key pressed + /// Name string of the key pressed. /// public string keyname; /// - /// Data to be passed to the event + /// Data to be passed to the event. /// public IntPtr data; /// - /// Modifier keys pressed during the event + /// Modifier keys pressed during the event. /// public IntPtr modifiers; /// - /// Locks info + /// Locks information. /// public IntPtr locks; /// - /// Logical key: (example, shift+1 == exclamation) + /// Logical key: (example, shift+1 == exclamation). /// public string key; /// - /// UTF8 string if this keystroke has produced a visible string to be ADDED + /// UTF-8 string, if this keystroke has produced a visible string to be added. /// public string str; /// - /// UTF8 string if this keystroke has modified a string in the middle of being composed - this string replaces the previous one + /// UTF-8 string, if this keystroke has modified a string in the middle of being composed - this string replaces the previous one. /// public string compose; public uint timestamp; /// - /// Event_flags + /// Event_flags. /// public EvasEventFlag event_flags; @@ -143,26 +143,26 @@ namespace ElmSharp public IntPtr dev; /// - /// Keycode + /// Keycode. /// public uint keycode; }; } /// - /// Flags for Events + /// Flags for the events. /// /// preview [Flags] public enum EvasEventFlag { /// - /// No fancy flags set + /// No fancy flags set. /// None = 0, /// - ///This event is being delivered but should be put "on hold" until the on hold flag is unset. the event should be used for informational purposes and maybe some indications visually, but not actually perform anything + /// This event is being delivered but should be put "on hold" until the on hold flag is unset. The event should be used for informational purposes and maybe some indications visually, but not actually perform anything. /// OnHold = 1, } diff --git a/src/ElmSharp/ElmSharp/EvasMap.cs b/src/ElmSharp/ElmSharp/EvasMap.cs index 4d55a2d..f5bcd5a 100755 --- a/src/ElmSharp/ElmSharp/EvasMap.cs +++ b/src/ElmSharp/ElmSharp/EvasMap.cs @@ -64,7 +64,7 @@ namespace ElmSharp } /// - /// Gets or sets the flag of the object move synchronization for map rendering. + /// Gets or sets the flag of the object to move synchronization for map rendering. /// /// preview public bool IsMoveSync @@ -80,9 +80,9 @@ namespace ElmSharp } /// - /// Populates source and destination map points to exactly match the object. + /// Populates the source and destination map points to exactly match the object. /// - /// The object to use unmapped geometry to populate map coordinates + /// The object to use unmapped geometry to populate the map coordinates. /// preview public void PopulatePoints(EvasObject obj) { @@ -90,11 +90,11 @@ namespace ElmSharp } /// - /// Populates source and destination map points to exactly match the object. + /// Populates the source and destination map points to exactly match the object. /// - /// The object to use unmapped geometry to populate map coordinates + /// The object to use unmapped geometry to populate the map coordinates. /// - /// The point Z coordinate hint (pre-perspective transform)This value is used for all four points. + /// The point Z-coordinate hint (pre-perspective transform). This value is used for all the four points. /// /// preview public void PopulatePoints(EvasObject obj, int z) @@ -105,8 +105,8 @@ namespace ElmSharp /// /// Populates the source and destination map points to match the given geometry. /// - /// The geometry value contains X coordinate,Y coordinate,the width and height to use to calculate second and third points - /// The Z coordinate hint (pre-perspective transform) This value is used for all four points. + /// The geometry value contains X-coordinate, Y-coordinate, the width and height to use, to calculate the second and third points. + /// The Z-coordinate hint (pre-perspective transform) This value is used for all the four points. /// preview public void PopulatePoints(Rect geometry, int z) { @@ -114,11 +114,11 @@ namespace ElmSharp } /// - /// Rotate the map + /// Rotates the map. /// - /// The abount of degrees from 0.0 to 360.0 to rotate - /// rotation's center horizontal position. - /// rotation's center vertical position. + /// The abount of degrees from 0.0 to 360.0 to rotate. + /// The rotation's center horizontal position. + /// The rotation's center vertical position. /// preview public void Rotate(double degrees, int cx, int cy) { @@ -128,12 +128,12 @@ namespace ElmSharp /// /// Rotates the map around 3 axes in 3D. /// - /// The amount of degrees from 0.0 to 360.0 to rotate around X axis - /// The amount of degrees from 0.0 to 360.0 to rotate around Y axis - /// The amount of degrees from 0.0 to 360.0 to rotate around Z axis - /// The rotation's center horizontal position - /// The rotation's center vertical position - /// The rotation's center depth position + /// The amount of degrees from 0.0 to 360.0 to rotate around the X-axis. + /// The amount of degrees from 0.0 to 360.0 to rotate around the Y-axis. + /// The amount of degrees from 0.0 to 360.0 to rotate around the Z-axis. + /// The rotation's center horizontal position. + /// The rotation's center vertical position. + /// The rotation's center depth position. /// preview public void Rotate3D(double dx, double dy, double dz, int cx, int cy, int cz) { @@ -143,8 +143,8 @@ namespace ElmSharp /// /// Changes the map point's coordinate. /// - /// The index of point to change ,this must be smaller than map size. - /// 3D Point coordinate + /// The index of point to change, this must be smaller than the map size. + /// The 3D point coordinate. /// preview public void SetPointCoordinate(int idx, Point3D point) { @@ -154,8 +154,8 @@ namespace ElmSharp /// /// Gets the map point's coordinate. /// - /// The index of point to change ,this must be smaller than map size. - /// The coordinates of the given point in the map. + /// The index of point to change, this must be smaller than the map size. + /// The coordinates of a given point in the map. /// preview public Point3D GetPointCoordinate(int idx) { @@ -167,10 +167,10 @@ namespace ElmSharp /// /// Changes the map to apply the given zooming. /// - /// The horizontal zoom to use - /// The vertical zoom to use - /// The zooming center horizontal position - /// The zooming center vertical position + /// The horizontal zoom to use. + /// The vertical zoom to use. + /// The zooming center horizontal position. + /// The zooming center vertical position. /// preview public void Zoom(double x, double y, int cx, int cy) { diff --git a/src/ElmSharp/ElmSharp/EvasObject.cs b/src/ElmSharp/ElmSharp/EvasObject.cs index 819efad..7769a9a 100644 --- a/src/ElmSharp/ElmSharp/EvasObject.cs +++ b/src/ElmSharp/ElmSharp/EvasObject.cs @@ -21,85 +21,85 @@ using System.Diagnostics; namespace ElmSharp { /// - /// Enumeration for tooltip orientation. + /// Enumeration for the Tooltip orientation. /// /// preview public enum TooltipOrientation { /// - /// Default value, Tooltip moves with mouse pointer. + /// Default value. Tooltip moves with a mouse pointer. /// None, /// - /// Tooltip should appear at the top left of parent. + /// Tooltip should appear to the top left of the parent. /// TopLeft, /// - /// Tooltip should appear at the left of parent. + /// Tooltip should appear to the left of the parent. /// Top, /// - /// Tooltip should appear at the top right of parent. + /// Tooltip should appear to the top right of the parent. /// TopRight, /// - /// Tooltip should appear at the left of parent. + /// Tooltip should appear to the left of the parent. /// Left, /// - /// Tooltip should appear at the center of parent. + /// Tooltip should appear to the center of the parent. /// Center, /// - /// Tooltip should appear at the right of parent. + /// Tooltip should appear to the right of the parent. /// Right, /// - /// Tooltip should appear at the bottom left of parent. + /// Tooltip should appear to the bottom left of the parent. /// BottomLeft, /// - /// Tooltip should appear at the bottom of parent. + /// Tooltip should appear to the bottom of the parent. /// Bottom, /// - /// Tooltip should appear at the bottom right of parent. + /// Tooltip should appear to the bottom right of the parent. /// BottomRight, } /// - /// Enumeration for aspect control. + /// Enumeration for the aspect control. /// /// preview public enum AspectControl { /// - /// Preference on scaling unset. + /// Preference on the scaling unset. /// None = 0, /// - /// Same effect as unset preference on scaling. + /// Same effect as the unset preference on the scaling. /// Neither = 1, /// - /// Use all horizontal container space to place an object, using the given aspect + /// Use all horizontal container space to place an object using the given aspect. /// Horizontal = 2, /// - /// Use all vertical container space to place an object, using the given aspect. + /// Use all vertical container space to place an object using the given aspect. /// Vertical = 3, @@ -110,7 +110,7 @@ namespace ElmSharp } /// - /// The EcasObject is a base class for other widget class + /// The EvasObject is a base class for other widget classes. /// /// preview public abstract class EvasObject @@ -168,9 +168,9 @@ namespace ElmSharp readonly HashSet _eventStore = new HashSet(); /// - /// Creates and initializes a new instance of the EvasObject class with parent EvasObject class parameter. + /// Creates and initializes a new instance of the EvasObject class with the parent EvasObject class parameter. /// - /// Parent EvasObject class + /// Parent EvasObject class. /// preview protected EvasObject(EvasObject parent) : this() { @@ -204,13 +204,13 @@ namespace ElmSharp //} /// - /// Deleted will be triggered when widght is deleted + /// Deleted will be triggered when the widght is deleted. /// /// preview public event EventHandler Deleted; /// - /// KeyUp will be triggered when key is loose + /// KeyUp will be triggered when the key is loose. /// /// preview public event EventHandler KeyUp @@ -220,7 +220,7 @@ namespace ElmSharp } /// - /// KeyDown will be triggered when key is preesd down + /// KeyDown will be triggered when the key is pressed down. /// /// preview public event EventHandler KeyDown @@ -230,7 +230,7 @@ namespace ElmSharp } /// - /// BackButtonPressed will be triggered when Back button is pressed + /// BackButtonPressed will be triggered when the Back button is pressed. /// /// preview public event EventHandler BackButtonPressed @@ -254,7 +254,7 @@ namespace ElmSharp } /// - /// MoreButtonPressed will be triggered when More button is pressed + /// MoreButtonPressed will be triggered when the More button is pressed. /// /// preview public event EventHandler MoreButtonPressed @@ -278,7 +278,7 @@ namespace ElmSharp } /// - /// Moved will be triggered when widght is moved + /// Moved will be triggered when the widght is moved. /// /// preview public event EventHandler Moved @@ -288,7 +288,7 @@ namespace ElmSharp } /// - /// Current widget's size Resized Event Handler + /// Resized Event Handler of the current widget's size. /// /// preview public event EventHandler Resized @@ -298,7 +298,7 @@ namespace ElmSharp } /// - /// Current widget RenderPost Event Handler + /// RenderPost Event Handler of the current widget. /// /// preview public event EventHandler RenderPost @@ -324,20 +324,20 @@ namespace ElmSharp } /// - /// Called back when a widget's tooltip is activated and needs content. + /// Called when a widget's tooltip is activated and needs content. /// /// /// preview public delegate EvasObject GetTooltipContentDelegate(); /// - /// Get widget's status of Realized or not. + /// Gets a widget's status of realized or not. /// /// preview public bool IsRealized { get { return Handle != IntPtr.Zero; } } /// - /// Gets EvasCanvas + /// Gets EvasCanvas. /// /// preview public EvasCanvas EvasCanvas @@ -427,7 +427,7 @@ namespace ElmSharp } /// - /// Sets or gets the Width hints for an object's minimum size. + /// Sets or gets the width hints for an object's minimum size. /// /// preview public int MinimumWidth @@ -446,7 +446,7 @@ namespace ElmSharp } /// - /// Sets or gets the Height hints for an object's minimum size. + /// Sets or gets the height hints for an object's minimum size. /// /// preview public int MinimumHeight @@ -530,7 +530,7 @@ namespace ElmSharp } /// - /// Sets or gets current object transformation map. + /// Sets or gets the current object's transformation map. /// /// preview public EvasMap EvasMap @@ -613,7 +613,7 @@ namespace ElmSharp } /// - /// Sets or Gets style for this object tooltip. + /// Sets or gets the style for this object tooltip. /// /// preview public string TooltipStyle @@ -629,7 +629,7 @@ namespace ElmSharp } /// - /// Sets or gets the orientation of Tooltip. + /// Sets or gets the orientation of tooltip. /// /// preview public TooltipOrientation TooltipOrientation @@ -685,7 +685,7 @@ namespace ElmSharp } /// - /// Gets the movement freeze by 1 + /// Gets the movement freeze by 1. /// This gets the movement freeze count by one. /// /// preview @@ -738,7 +738,7 @@ namespace ElmSharp /// /// Clips one object to another. /// - /// The object to clip object by + /// The object to clip object by. /// preview public void SetClip(EvasObject clip) { @@ -748,8 +748,8 @@ namespace ElmSharp /// /// Sets the hints for an object's alignment. /// - /// The horizontal alignment hint as double value ranging from 0.0 to 1.0,The default alignment hint value is 0.5 - /// The vertical alignment hint as double value ranging from 0.0 to 1.0,The default alignment hint value is 0.5 + /// The horizontal alignment hint as double value ranging from 0.0 to 1.0. The default alignment hint value is 0.5. + /// The vertical alignment hint as double value ranging from 0.0 to 1.0. The default alignment hint value is 0.5. /// preview public void SetAlignment(double x, double y) { @@ -759,8 +759,8 @@ namespace ElmSharp /// /// Sets the hints for an object's weight. /// - /// The non-negative double value to use as horizontal weight hint - /// The non-negative double value to use as vertical weight hint + /// The non-negative double value to be used as horizontal weight hint. + /// The non-negative double value to be used as vertical weight hint. /// preview public void SetWeight(double x, double y) { @@ -770,7 +770,7 @@ namespace ElmSharp /// /// Sets the text for an object's tooltip. /// - /// The text value to display inside the tooltip + /// The text value to display inside the tooltip. /// preview public void SetTooltipText(string text) { @@ -806,7 +806,7 @@ namespace ElmSharp } /// - /// Force hide tooltip of object. + /// Force hide the tooltip of the object. /// /// preview public void HideTooltip() @@ -815,7 +815,7 @@ namespace ElmSharp } /// - /// Force show tooltip of object. + /// Force show the tooltip of the object. /// /// preview public void ShowTooltip() @@ -844,8 +844,8 @@ namespace ElmSharp /// /// Changes the size of the current object. /// - /// The new width - /// The new height + /// The new width. + /// The new height. /// preview public void Resize(int w, int h) { @@ -855,8 +855,8 @@ namespace ElmSharp /// /// Moves the current object to the given location. /// - /// The X position to move the object to. - /// The Y position to move the object to. + /// The X position to move the object. + /// The Y position to move the object. /// preview public void Move(int x, int y) { @@ -864,7 +864,7 @@ namespace ElmSharp } /// - /// Lowers obj to the bottom of its layer. + /// Lowers the object to the bottom of its layer. /// /// preview public void Lower() @@ -873,9 +873,9 @@ namespace ElmSharp } /// - /// Define IntPtr operator + /// Define the IntPtr operator. /// - /// Parent object + /// Parent object. /// preview public static implicit operator IntPtr(EvasObject obj) { @@ -885,11 +885,11 @@ namespace ElmSharp } /// - /// Requests keyname key events be directed to current obj. + /// Requests the keyname key events to be directed to the current object. /// - /// The key to request events for - /// Set TRUE to request that the obj is the only object receiving the keyname events,otherwise set FALSE - /// If the call succeeded is true,otherwise is false + /// The key to request events for. + /// Set TRUE to request that the obj is the only object receiving the keyname events, otherwise set to FALSE. + /// If the call succeeds then true, otherwise false. /// preview public bool KeyGrab(string keyname, bool exclusive) { @@ -897,9 +897,9 @@ namespace ElmSharp } /// - /// Removes the grab on keyname key events. + /// Removes the grab on the keyname key events. /// - /// The key the grab is set for + /// The key the grab is set for. /// preview public void KeyUngrab(string keyname) { @@ -907,7 +907,7 @@ namespace ElmSharp } /// - /// Mark smart object as changed. + /// Marks the smart object as changed. /// /// preview public void MarkChanged() @@ -916,7 +916,7 @@ namespace ElmSharp } /// - /// Call the calculate smart function immediately. + /// Calls the calculate smart function immediately. /// This will force immediate calculations needed for renderization of this object. /// /// preview @@ -928,9 +928,9 @@ namespace ElmSharp /// /// Sets the hints for an object's aspect ratio. /// - /// The policy or type of aspect ratio to apply to object - /// The integer to use as aspect width ratio term - /// The integer to use as aspect height ratio term + /// The policy or type of aspect ratio to apply to an object. + /// The integer to be used as aspect width ratio term. + /// The integer to be used as aspect height ratio term. /// preview public void SetSizeHintAspect(AspectControl aspect, int w, int h) { @@ -940,9 +940,9 @@ namespace ElmSharp /// /// Gets the hints for an object's aspect ratio. /// - /// The policy or type of aspect ratio to apply to object - /// The integer to use as aspect width ratio term - /// The integer to use as aspect height ratio term + /// The policy or type of aspect ratio to apply to an object. + /// The integer to be used as aspect width ratio term. + /// The integer to be used as aspect height ratio term. /// preview public void GetSizeHintAspect(out AspectControl aspect, out int w, out int h) { @@ -952,7 +952,7 @@ namespace ElmSharp } /// - /// Stack immediately below anchor. + /// Stacks immediately below anchor. /// /// The object below which to stack. /// preview @@ -962,7 +962,7 @@ namespace ElmSharp } /// - /// Stack immediately above anchor. + /// Stacks immediately above anchor. /// /// The object above which to stack. /// preview @@ -972,7 +972,7 @@ namespace ElmSharp } /// - /// Raise to the top of its layer. + /// Raises to the top of its layer. /// /// preview public void RaiseTop() @@ -981,13 +981,13 @@ namespace ElmSharp } /// - /// Get the geometry of a line number. + /// Gets the geometry of a line number. /// - /// the line number. - /// x coord of the line. - /// y coord of the line. - /// w coord of the line. - /// h coord of the line. + /// The line number. + /// x coordinate of the line. + /// y coordinate of the line. + /// w coordinate of the line. + /// h coordinate of the line. /// /// preview public bool GetTextBlockGeometryByLineNumber(int lineNumber, out int x, out int y, out int w, out int h) @@ -1011,7 +1011,7 @@ namespace ElmSharp } /// - /// The callback of Invalidate Event + /// The callback of the Invalidate Event. /// /// preview protected virtual void OnInvalidate() @@ -1019,7 +1019,7 @@ namespace ElmSharp } /// - /// The callback of Instantiated Event + /// The callback of the Instantiated Event. /// /// preview protected virtual void OnInstantiated() @@ -1027,7 +1027,7 @@ namespace ElmSharp } /// - /// The callback of Realized Event + /// The callback of the Realized Event. /// /// preview protected virtual void OnRealized() @@ -1035,7 +1035,7 @@ namespace ElmSharp } /// - /// The callback of Unrealize Event + /// The callback of the Unrealize Event. /// /// preview protected virtual void OnUnrealize() @@ -1045,15 +1045,15 @@ namespace ElmSharp /// /// Creates a widget handle. /// - /// Parent EvasObject - /// Handle IntPtr + /// Parent EvasObject. + /// Handle IntPtr. /// preview protected abstract IntPtr CreateHandle(EvasObject parent); /// /// For this object bind Parent object.Init handle and all kinds of EvasObjectEvent. /// - /// Parent object + /// Parent object. /// preview public void Realize(EvasObject parent) { @@ -1077,7 +1077,7 @@ namespace ElmSharp } /// - /// Removes current object relationship with others. + /// Removes the current object relationship with others. /// /// preview public void Unrealize() diff --git a/src/ElmSharp/ElmSharp/EvasObjectEvent.cs b/src/ElmSharp/ElmSharp/EvasObjectEvent.cs index 2c1cb74..f551fa2 100755 --- a/src/ElmSharp/ElmSharp/EvasObjectEvent.cs +++ b/src/ElmSharp/ElmSharp/EvasObjectEvent.cs @@ -22,21 +22,21 @@ using System.Linq; namespace ElmSharp { /// - /// IInvalidatable is a interface which can be overrided by its children class. - /// Inherits IDisposable + /// IInvalidatable is an interface, which can be overrided by its children class. + /// Inherits IDisposable. /// /// preview public interface IInvalidatable : IDisposable { /// - /// Make current instance invalidate + /// Makes the current instance invalidate. /// /// preview void MakeInvalidate(); } /// - /// Enumeration for EvasObjectCallbackType + /// Enumeration for EvasObjectCallbackType. /// /// preview public enum EvasObjectCallbackType @@ -47,195 +47,195 @@ namespace ElmSharp MouseIn, /// - /// Mouse Out Event CallbackType + /// Mouse Out Event CallbackType. /// MouseOut, /// - /// Mouse Button Down Event CallbackType + /// Mouse Button Down Event CallbackType. /// MouseDown, /// - /// Mouse Button Up Event CallbackType + /// Mouse Button Up Event CallbackType. /// MouseUp, /// - /// Mouse Move Event CallbackType + /// Mouse Move Event CallbackType. /// MouseMove, /// - /// Mouse Wheel Event CallbackType + /// Mouse Wheel Event CallbackType. /// MouseWheel, /// - /// Multi-touch Down Event CallbackType + /// Multi-touch Down Event CallbackType. /// MultiDown, /// - /// Multi-touch Up Event CallbackType + /// Multi-touch Up Event CallbackType. /// MultiUp, /// - /// Multi-touch Move Event CallbackType + /// Multi-touch Move Event CallbackType. /// MultiMove, /// - /// Object Being Freed (Called after Del) + /// Object Being Freed (Called after Del). /// Free, /// - /// Key Press Event CallbackType + /// Key Press Event CallbackType. /// KeyDown, /// - /// Key Release Event CallbackType + /// Key Release Event CallbackType. /// KeyUp, /// - /// Focus In Event CallbackType + /// Focus In Event CallbackType. /// FocusIn, /// - /// Focus Out Event CallbackType + /// Focus Out Event CallbackType. /// FocusOut, /// - /// Show Event CallbackType + /// Show Event CallbackType. /// Show, /// - /// Hide Event CallbackType + /// Hide Event CallbackType. /// Hide, /// - /// Move Event CallbackType + /// Move Event CallbackType. /// Move, /// - /// Resize Event CallbackType + /// Resize Event CallbackType. /// Resize, /// - /// Restack Event CallbackType + /// Restack Event CallbackType. /// Restack, /// - /// Object Being Deleted (called before Free) + /// Object being deleted (called before Free). /// Del, /// - /// Hold Event CallbackType, Informational purpose event to indicate something + /// Hold Event CallbackType, Informational purpose event to indicate something. /// Hold, /// - /// Size hints changed Event CallbackType + /// Size hints changed the CallbackType event. /// ChangedSizeHints, /// - /// Image has been preloaded + /// Image has been pre-loaded. /// ImagePreloaded, /// - /// Canvas got focus as a whole + /// Canvas got focus as a whole. /// CanvasFocusIn, /// - /// Canvas lost focus as a whole + /// Canvas lost focus as a whole. /// CanvasFocusOut, /// - /// Called just before rendering is updated on the canvas target + /// Called just before rendering is updated on the canvas target. /// RenderFlushPre, /// - /// Called just after rendering is updated on the canvas target + /// Called just after rendering is updated on the canvas target. /// RenderFlushPost, /// - /// Canvas object got focus + /// Canvas object got focus. /// CanvasObjectFocusIn, /// - /// Canvas object lost focus + /// Canvas object lost focus. /// CanvasObjectFocusOut, /// - /// Image data has been unloaded (by some mechanism in Evas that throw out original image data) + /// Image data has been unloaded (by some mechanism in Evas that throw out the original image data). /// ImageUnloaded, /// - /// Called just before rendering starts on the canvas target + /// Called just before rendering starts on the canvas target. /// RenderPre, /// - /// Called just after rendering stops on the canvas target + /// Called just after rendering stops on the canvas target. /// RenderPost, /// - /// Image size is changed + /// Image size is changed. /// ImageResize, /// - /// Devices added, removed or changed on canvas + /// Devices added, removed, or changed on canvas. /// DeviceChanged, /// - /// Axis is changed + /// Axis is changed. /// AxisUpdate, /// - /// Canvas Viewport size is changed + /// Canvas Viewport size is changed. /// CanvasViewportResize } /// - /// Event class for EvasObject + /// Event class for EvasObject. /// - /// Kinds of EventArgs + /// Kinds of EventArgs. /// preview public class EvasObjectEvent : IInvalidatable where TEventArgs : EventArgs { /// - /// SmartEventInfoParser delegate of EvasObjectEvent class + /// SmartEventInfoParser delegate of the EvasObjectEvent class. /// /// data /// obj /// info - /// delegate handle + /// Delegate handle. /// preview public delegate TEventArgs SmartEventInfoParser(IntPtr data, IntPtr obj, IntPtr info); @@ -249,7 +249,7 @@ namespace ElmSharp /// /// Creates and initializes a new instance of the EvasObjectEvent. /// - /// EvasObject class belong to + /// EvasObject class belongs to. /// EvasObjectCallbackType /// SmartEventInfoParser /// preview @@ -260,8 +260,8 @@ namespace ElmSharp /// /// Creates and initializes a new instance of the EvasObjectEvent. /// - /// EvasObject class belong to - /// EvasObject handle + /// EvasObject class belongs to. + /// EvasObject handle. /// EvasObjectCallbackType /// SmartEventInfoParser /// preview @@ -278,7 +278,7 @@ namespace ElmSharp /// /// Creates and initializes a new instance of the EvasObjectEvent. /// - /// EvasObject class belong with + /// EvasObject class belongs to. /// SmartEventInfoParser /// preview public EvasObjectEvent(EvasObject sender, EvasObjectCallbackType type) : this(sender, type, null) @@ -286,7 +286,7 @@ namespace ElmSharp } /// - /// Destroy the EvasObjectEvent object. + /// Destroys the EvasObjectEvent object. /// ~EvasObjectEvent() { @@ -300,7 +300,7 @@ namespace ElmSharp } /// - /// On Event Handler of EvasObjectEvent + /// On Event Handler of the EvasObjectEvent. /// /// preview public event EventHandler On @@ -338,10 +338,10 @@ namespace ElmSharp } /// - /// Releases all resources currently used by this instance. + /// Releases all the resources currently used by this instance. /// /// - /// true if managed resources should be disposed + /// true if the managed resources should be disposed /// otherwise, false. /// /// preview @@ -366,7 +366,7 @@ namespace ElmSharp } /// - /// Destroy current object + /// Destroys the current object. /// /// preview public void Dispose() @@ -376,7 +376,7 @@ namespace ElmSharp } /// - /// Make current instance invalidate + /// Makes the current instance invalidate. /// /// preview public void MakeInvalidate() @@ -387,7 +387,7 @@ namespace ElmSharp } /// - /// Event class for EvasObject + /// Event class for EvasObject. /// /// preview public class EvasObjectEvent : IInvalidatable @@ -401,7 +401,7 @@ namespace ElmSharp /// /// Creates and initializes a new instance of the EvasObjectEvent. /// - /// EvasObject class belong to + /// EvasObject class belongs to. /// EvasObjectCallbackType /// preview public EvasObjectEvent(EvasObject sender, EvasObjectCallbackType type) : this(sender, sender.Handle, type) @@ -411,8 +411,8 @@ namespace ElmSharp /// /// Creates and initializes a new instance of the EvasObjectEvent. /// - /// EvasObject class belong to - /// EvasObject handle + /// EvasObject class belongs to. + /// EvasObject handle. /// EvasObjectCallbackType /// preview [EditorBrowsableAttribute(EditorBrowsableState.Never)] @@ -422,7 +422,7 @@ namespace ElmSharp } /// - /// Destroy the EvasObjectEvent object. + /// Destroys the EvasObjectEvent object. /// ~EvasObjectEvent() { @@ -430,7 +430,7 @@ namespace ElmSharp } /// - /// On Event Handler of EvasObjectEvent + /// On Event Handler of EvasObjectEvent. /// /// preview public event EventHandler On @@ -460,7 +460,7 @@ namespace ElmSharp } /// - /// Releases all resources currently used by this instance. + /// Releases all the resources currently used by this instance. /// /// /// true if managed resources should be disposed @@ -480,7 +480,7 @@ namespace ElmSharp } /// - /// Destroy current object + /// Destroys the current object. /// /// preview public void Dispose() @@ -490,7 +490,7 @@ namespace ElmSharp } /// - /// Make current instance invalidate + /// Makes the current instance invalidate. /// /// preview public void MakeInvalidate() diff --git a/src/ElmSharp/ElmSharp/FlipSelector.cs b/src/ElmSharp/ElmSharp/FlipSelector.cs index 4e98e73..2173e4b 100755 --- a/src/ElmSharp/ElmSharp/FlipSelector.cs +++ b/src/ElmSharp/ElmSharp/FlipSelector.cs @@ -20,7 +20,7 @@ using System.Collections.Generic; namespace ElmSharp { /// - /// A flip selector is a widget to show a set of text items,one at a time.with the same sheet switching style as the clock widget, when one changes the current displaying sheet. + /// The FlipSelector is a widget to show a set of text items, one at a time, with the same sheet switching style as the clock widget when one changes the current displaying sheet. /// /// preview public class FlipSelector : Layout @@ -32,7 +32,7 @@ namespace ElmSharp /// /// Creates and initializes a new instance of the FlipSelector. /// - /// Parent EvasObject + /// Parent EvasObject. /// preview public FlipSelector(EvasObject parent) : base(parent) { @@ -46,23 +46,23 @@ namespace ElmSharp } /// - /// Selected will be triggered when be Selected + /// Selected will be triggered when selected. /// /// preview public event EventHandler Selected; /// - /// Overflowed will be triggered when Overflowed + /// Overflowed will be triggered when overflowed. /// /// preview public event EventHandler Overflowed; /// - /// Underflowed will be triggered when be Underflowed + /// Underflowed will be triggered when underflowed. /// /// preview public event EventHandler Underflowed; /// - /// Sets or gets the interval on time updates for an user mouse button hold on a flip selector widget. + /// Sets or gets the interval on time updates for a user mouse button to hold on the flip selector widget. /// /// preview public double Interval @@ -79,7 +79,7 @@ namespace ElmSharp /// - /// Gets the currently selected item in a flip selector widget. + /// Gets the currently selected item in the flip selector widget. /// /// preview public FlipSelectorItem SelectedItem @@ -118,14 +118,14 @@ namespace ElmSharp } /// - /// Appends a (text) item to a flip selector widget. + /// Appends the (text) item to the flip selector widget. /// /// text value /// - /// A handle to the item added or NULL, on errors + /// A handle to the item added, or null on errors. /// /// - /// The widget's list of labels to show will be appended with the given value. If the user wishes so, a callback function pointer can be passed, which will get called when this same item is selected. + /// The widget's list of labels to show will be appended with the given value. If the user wishes so, a callback function pointer can be passed, which will get called when the same item is selected. /// /// preview public FlipSelectorItem Append(string text) @@ -136,12 +136,12 @@ namespace ElmSharp } /// - /// Prepend a (text) item to a flip selector widget. + /// Prepends the (text) item to a flip selector widget. /// /// Prepend text - /// A handle to the item added or NULL, on errors + /// A handle to the item added, or null on errors. /// - /// The widget's list of labels to show will be prepended with the given value. If the user wishes so, a callback function pointer can be passed, which will get called when this same item is selected. + /// The widget's list of labels to show will be prepended with the given value. If the user wishes so, a callback function pointer can be passed, which will get called when the same item is selected. /// /// preview public FlipSelectorItem Prepend(string text) @@ -154,7 +154,7 @@ namespace ElmSharp /// /// To remove the given item. /// - /// FlipSelector's item + /// FlipSelector's item. /// preview public void Remove(FlipSelectorItem item) { @@ -163,7 +163,7 @@ namespace ElmSharp } /// - /// Programmatically select the next item of a flip selector widget. + /// Programmatically select the next item of the flip selector widget. /// /// /// The selection will be animated. Also, if it reaches the beginning of its list of member items, it will continue with the last one backwards. @@ -175,7 +175,7 @@ namespace ElmSharp } /// - /// Programmatically select the previous item of a flip selector widget. + /// Programmatically select the previous item of the flip selector widget. /// /// preview public void Prev() @@ -186,8 +186,8 @@ namespace ElmSharp /// /// Creates a widget handle. /// - /// Parent EvasObject - /// Handle IntPtr + /// Parent EvasObject. + /// Handle IntPtr. /// preview protected override IntPtr CreateHandle(EvasObject parent) { diff --git a/src/ElmSharp/ElmSharp/FlipSelectorItem.cs b/src/ElmSharp/ElmSharp/FlipSelectorItem.cs index a9bf57f..82ef124 100755 --- a/src/ElmSharp/ElmSharp/FlipSelectorItem.cs +++ b/src/ElmSharp/ElmSharp/FlipSelectorItem.cs @@ -19,19 +19,19 @@ using System; namespace ElmSharp { /// - /// Iterm class of FlipSelector + /// The item class of FlipSelector. /// /// preview public class FlipSelectorItem : ItemObject { /// - /// Sets or gets the Text of FlipSelectorItem + /// Sets or gets the text of the FlipSelectorItem. /// /// preview public string Text { get; private set; } /// - /// Selected will be triggered when Selected + /// Selected will be triggered when selected. /// /// preview public event EventHandler Selected; diff --git a/src/ElmSharp/ElmSharp/FloatingButton.cs b/src/ElmSharp/ElmSharp/FloatingButton.cs index 64ae3b3..99ef83a 100755 --- a/src/ElmSharp/ElmSharp/FloatingButton.cs +++ b/src/ElmSharp/ElmSharp/FloatingButton.cs @@ -19,7 +19,7 @@ using System; namespace ElmSharp { /// - /// The FloatingButton is a widget that to add floating area for buttons. + /// The FloatingButton is a widget to add the floating area for buttons. /// /// preview public class FloatingButton : Layout @@ -27,14 +27,14 @@ namespace ElmSharp /// /// Creates and initializes a new instance of the FloatingButton class. /// - /// Created on this parent container.. + /// Created on this parent container. /// preview public FloatingButton(EvasObject parent) : base(parent) { } /// - /// Sets or gets floatingbutton mode. + /// Sets or gets the floatingbutton mode. /// /// preview public FloatingButtonMode Mode @@ -50,7 +50,7 @@ namespace ElmSharp } /// - /// Gets floatingbutton Position. + /// Gets the floatingbutton position. /// /// preview public FloatingButtonPosition Position @@ -62,7 +62,7 @@ namespace ElmSharp } /// - /// Sets or gets movability for a given floatingbutton widget. + /// Sets or gets the movability for a given FloatingButton widget. /// /// preview public bool MovementBlock @@ -78,7 +78,7 @@ namespace ElmSharp } /// - /// Get Opacity's value of the given FloatingButton. + /// Gets the opacity's value of the given FloatingButton. /// /// preview public override int Opacity @@ -95,10 +95,10 @@ namespace ElmSharp } /// - /// Set the floatingbutton position with animation or not. + /// Set the floatingbutton position with or without animation. /// - /// Button position - /// Animat flag + /// Button position. + /// Animation flag. /// preview public void SetPosition(FloatingButtonPosition position, bool animated) { @@ -115,8 +115,8 @@ namespace ElmSharp /// /// Creates a widget handle. /// - /// Parent EvasObject - /// Handle IntPtr + /// Parent EvasObject. + /// Handle IntPtr. /// preview protected override IntPtr CreateHandle(EvasObject parent) { @@ -125,50 +125,50 @@ namespace ElmSharp } /// - /// Enumeration for FloatingButtonMode + /// Enumeration for the FloatingButtonMode. /// /// preview public enum FloatingButtonMode { /// - /// Allows all positions + /// Allows all positions. /// All, /// - /// Allows LEFT and RIGHT positions only + /// Allows left and right positions only. /// LeftRightOnly, } /// - /// Enumeration for FloatingButtonPosition + /// Enumeration for the FloatingButtonPosition. /// /// preview public enum FloatingButtonPosition { /// - /// Hides in the left, but small handler will show only + /// Hides in the left, but only the small handler will show. /// LeftOut, /// - /// Shows all of buttons, but lies on the left + /// Shows all of the buttons, but lies on the left. /// Left, /// - /// Shows all of buttons, but lies on the center + /// Shows all of the buttons, but lies on the center. /// Center, /// - /// Shows all of buttons, but lies on the right + /// Shows all of the buttons, but lies on the right. /// Right, /// - /// Hides in the right, but small handler will show only + /// Hides in the right, but only the small handler will show. /// RightOut, } diff --git a/src/ElmSharp/ElmSharp/GenGrid.cs b/src/ElmSharp/ElmSharp/GenGrid.cs index e9ec144..f540d9a 100755 --- a/src/ElmSharp/ElmSharp/GenGrid.cs +++ b/src/ElmSharp/ElmSharp/GenGrid.cs @@ -21,14 +21,14 @@ namespace ElmSharp { /// /// It inherits System.EventArgs. - /// It contains Item which is type. - /// All events of GenGrid contain GenGridItemEventArgs as a parameter. + /// It contains the item which is the type. + /// All events of the GenGrid contain GenGridItemEventArgs as a parameter. /// /// preview public class GenGridItemEventArgs : EventArgs { /// - /// Gets or sets GenGrid item.The return type is . + /// Gets or sets the gengrid item. The return type is . /// /// preview public GenGridItem Item { get; set; } @@ -42,9 +42,9 @@ namespace ElmSharp /// /// It inherits . - /// The GenGrid is a widget that aims to position objects in a grid layout while actually creating and rendering only the visible ones. - /// It has two direction in which a given GenGrid widget expands while placing its items, horizontal and vertical. - /// The GenGrid items are represented through definition field details. + /// The GenGrid is a widget that aims to position objects in a grid layout, while actually creating and rendering only the visible ones. + /// It has two directions in which a given GenGrid widget expands while placing its items, horizontal and vertical. + /// The gengrid items are represented through the definition field details. /// /// preview public class GenGrid : Layout @@ -65,7 +65,7 @@ namespace ElmSharp /// /// Creates and initializes a new instance of the GenGrid class. /// - /// The parent is a given container which will be attached by GenGrid as a child. It's type. + /// The parent is a given container which will be attached by GenGrid as a child. It's the type. /// preview public GenGrid(EvasObject parent) : base(parent) { @@ -73,13 +73,13 @@ namespace ElmSharp } /// - /// ItemSelected is raised when a new gengrid item is selected. + /// ItemSelected is raised when a new GenGrid item is selected. /// /// preview public event EventHandler ItemSelected; /// - /// ItemUnselected is raised when the gengrid item is Unselected. + /// ItemUnselected is raised when the gengrid item is unselected. /// /// preview public event EventHandler ItemUnselected; @@ -97,19 +97,19 @@ namespace ElmSharp public event EventHandler ItemReleased; /// - /// ItemActivated is raised when a new gengrid item is double clicked or pressed (enter|return|spacebar). + /// ItemActivated is raised when a new gengrid item is double-clicked or pressed (enter|return|spacebar). /// /// preview public event EventHandler ItemActivated; /// - /// ItemDoubleClicked is raised when a new gengrid item is double clicked. + /// ItemDoubleClicked is raised when a new gengrid item is double-clicked. /// /// preview public event EventHandler ItemDoubleClicked; /// - /// ItemRealized is raised when a gengrid item is implementing through . + /// ItemRealized is raised when a gengrid item is implemented through . /// /// preview public event EventHandler ItemRealized; @@ -127,15 +127,15 @@ namespace ElmSharp public event EventHandler ItemLongPressed; /// - /// Changed is raised when an item is added, removed, resized or moved and when the gengrid is resized or gets "horizontal" property changes. + /// Changed is raised when an item is added, removed, resized, or moved, and when the gengrid is resized or gets "horizontal" property changes. /// /// preview public event EventHandler Changed; /// - /// Gets or sets the item's grid alignment along x-axis within a given gengrid widget. + /// Gets or sets the item's grid alignment along X-axis within a given GenGrid widget. /// Accepted values are in the 0.0 to 1.0 range, with the special value -1.0 used to specify "justify" or "fill" by some users. - /// By default, value is 0.0, meaning that the gengrid has its items grid placed exactly in the left along x-axis. + /// By default, value is 0.0, meaning that the gengrid has its items grid placed exactly in the left along X-axis. /// /// preview public double ItemAlignmentX @@ -154,9 +154,9 @@ namespace ElmSharp } /// - /// Gets or sets the item's grid alignment on y-axis within a given gengrid widget. + /// Gets or sets the item's grid alignment on Y-axis within a given GenGrid widget. /// Accepted values are in the 0.0 to 1.0 range, with the special value -1.0 used to specify "justify" or "fill" by some users. - /// By default, value is 0.0, meaning that the gengrid has its items grid placed exactly in the top along y-axis. + /// By default, value is 0.0, meaning that the gengrid has its items grid placed exactly in the top along Y-axis. /// /// preview public double ItemAlignmentY @@ -175,8 +175,8 @@ namespace ElmSharp } /// - /// Gets or sets the manner in which the items grid is filled within a given gengrid widget. - /// It is filled if true, otherwise false. + /// Gets or sets the manner in which the items grid is filled within a given GenGrid widget. + /// It is filled if true, otherwise not filled if false. /// /// preview public bool FillItems @@ -192,7 +192,7 @@ namespace ElmSharp } /// - /// Gets or sets whether multi-selection is enabled or disabled for a given gengrid widget. + /// Gets or sets whether multi-selection is enabled or disabled for a given GenGrid widget. /// /// /// Multi-selection is the ability to have more than one item selected, on a given gengrid, simultaneously. @@ -214,11 +214,11 @@ namespace ElmSharp } /// - /// Gets or sets the width for the items of a given gengrid widget. + /// Gets or sets the width for the items of a given GenGrid widget. /// /// /// A gengrid, after creation, still has no information on the size to give to each of its cells. - /// The default width and height just have one finger wide. + /// The default width and height just are one finger wide. /// Use this property to force a custom width for your items, making them as big as you wish. /// /// preview @@ -238,11 +238,11 @@ namespace ElmSharp } /// - /// Gets or sets the height for the items of a given gengrid widget. + /// Gets or sets the height for the items of a given GenGrid widget. /// /// /// A gengrid, after creation, still has no information on the size to give to each of its cells. - /// The default width and height just have one finger wide. + /// The default width and height just are one finger wide. /// Use this property to force a custom height for your items, making them as big as you wish. /// /// preview @@ -278,7 +278,7 @@ namespace ElmSharp } /// - /// Gets or sets the direction for which a given gengrid widget expands while placing its items. + /// Gets or sets the direction for which a given GenGrid widget expands while placing its items. /// /// /// If true, items are placed in columns from top to bottom and when the space for a column is filled, another one is started on the right, thus expanding the grid horizontally. @@ -314,7 +314,7 @@ namespace ElmSharp } /// - /// Sets or gets the value of HorizontalScrollBarVisiblePolicy + /// Sets or gets the value of HorizontalScrollBarVisiblePolicy. /// /// /// ScrollBarVisiblePolicy.Auto means the horizontal scrollbar is made visible if it is needed, and otherwise kept hidden. @@ -337,7 +337,7 @@ namespace ElmSharp } /// - /// Sets or gets the value of VerticalScrollBarVisiblePolicy + /// Sets or gets the value of VerticalScrollBarVisiblePolicy. /// /// /// ScrollBarVisiblePolicy.Auto means the vertical scrollbar is made visible if it is needed, and otherwise kept hidden. @@ -360,7 +360,7 @@ namespace ElmSharp } /// - /// Gets the first item in a given gengrid widget. + /// Gets the first item in a given GenGrid widget. /// /// preview public GenGridItem FirstItem @@ -373,7 +373,7 @@ namespace ElmSharp } /// - /// Gets the last item in a given gengrid widget. + /// Gets the last item in a given GenGrid widget. /// /// preview public GenGridItem LastItem @@ -386,7 +386,7 @@ namespace ElmSharp } /// - /// Gets the items count in a given gengrid widget. + /// Gets the items count in a given GenGrid widget. /// /// preview public uint ItemCount @@ -398,7 +398,7 @@ namespace ElmSharp } /// - /// Gets the selected item in a given gengrid widget. + /// Gets the selected item in a given GenGrid widget. /// /// preview public GenGridItem SelectedItem @@ -411,7 +411,7 @@ namespace ElmSharp } /// - /// Gets or sets whether a given gengrid widget is or not able have items reordered. + /// Gets or sets whether a given GenGrid widget is able to or not able to have items reordered. /// /// preview public bool ReorderMode @@ -427,11 +427,11 @@ namespace ElmSharp } /// - /// Appends a new item to a given gengrid widget. This adds an item to the end of the gengrid. + /// Appends a new item to a given GenGrid widget. This adds an item to the end of the gengrid. /// /// The itemClass defines how to display the data. /// The item data. - /// Return a gengrid item that contains data and itemClass. + /// Return a gengrid item that contains the data and itemClass. /// /// /// preview @@ -445,11 +445,11 @@ namespace ElmSharp } /// - /// Prepends a new item to a given gengrid widget. This adds an item to the beginning of the gengrid. + /// Prepends a new item to a given GenGrid widget. This adds an item to the beginning of the gengrid. /// /// The itemClass defines how to display the data. /// The item data. - /// Return a gengrid item that contains data and itemClass. + /// Return a gengrid item that contains the data and itemClass. /// /// /// preview @@ -463,12 +463,12 @@ namespace ElmSharp } /// - /// Inserts an item before another in a gengrid widget. This inserts an item before another in the gengrid. + /// Inserts an item before another in a GenGrid widget. This inserts an item before another in the gengrid. /// /// The itemClass defines how to display the data. /// The item data. /// The item before which to place this new one. - /// Return a gengrid item that contains data and itemClass./> + /// Return a gengrid item that contains the data and itemClass. /// /// /// preview @@ -482,12 +482,12 @@ namespace ElmSharp } /// - /// Inserts an item before another in a gengrid widget. This inserts an item after another in the gengrid. + /// Inserts an item after another in a GenGrid widget. This inserts an item after another in the gengrid. /// /// The itemClass defines how to display the data. /// The item data. /// The item after which to place this new one. - /// Return a gengrid item that contains data and itemClass. + /// Return a gengrid item that contains the data and itemClass. /// /// /// preview @@ -501,12 +501,12 @@ namespace ElmSharp } /// - /// Insert an item in a gengrid widget using a user-defined sort function. + /// Inserts an item in a GenGrid widget using a user-defined sort function. /// /// 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. - /// Return a gengrid item that contains data and itemClass. + /// User defined comparison function that defines the sort order based on the gengrid item and its data. + /// Return a gengrid item that contains the data and itemClass. /// preview public GenGridItem InsertSorted(GenItemClass itemClass, object data, Comparison comparison) { @@ -532,8 +532,8 @@ namespace ElmSharp /// The position of the item in the viewport. /// The type of how to show the item. /// - /// If animated is true, the gengrid shows item by scrolling if it's not fully visible. - /// If animated is false, the gengrid shows item by jumping if it's not fully visible. + /// If animated is true, the gengrid shows the item by scrolling if it's not fully visible. + /// If animated is false, the gengrid shows the item by jumping if it's not fully visible. /// /// /// preview @@ -564,8 +564,8 @@ namespace ElmSharp } /// - /// Removes all items from a given gengrid widget. - /// This removes(and deletes) all items in obj, making it empty. + /// Removes all the items from a given GenGrid widget. + /// This removes (and deletes) all the items in the object, making it empty. /// /// /// to delete just one item. @@ -577,15 +577,15 @@ namespace ElmSharp } /// - /// Get the item that is at the x, y canvas coords. + /// Gets the item that is at the X, Y canvas coordinates. /// - /// The input x coordinate - /// The input y coordinate + /// The input X coordinate. + /// The input Y coordinate. /// 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). + /// -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 - /// -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). + /// 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). /// /// /// preview @@ -598,8 +598,8 @@ namespace ElmSharp /// /// Creates a widget handle. /// - /// Parent EvasObject - /// Handle IntPtr + /// Parent EvasObject. + /// Handle IntPtr. /// preview protected override IntPtr CreateHandle(EvasObject parent) { diff --git a/src/ElmSharp/ElmSharp/GenGridItem.cs b/src/ElmSharp/ElmSharp/GenGridItem.cs index 79b7464..ef2ac83 100755 --- a/src/ElmSharp/ElmSharp/GenGridItem.cs +++ b/src/ElmSharp/ElmSharp/GenGridItem.cs @@ -21,8 +21,8 @@ namespace ElmSharp { /// /// It inherits . - /// A instance to the gengrid item added. - /// It contains Update() method to update a gengrid item which is given. + /// An instance to the gengrid item is added. + /// It contains the Update() method to update a gengrid item which is given. /// /// preview public class GenGridItem : GenItem @@ -53,7 +53,7 @@ namespace ElmSharp } /// - /// Sets or gets the cursor to be shown when mouse is over the gengrid item. + /// Sets or gets the cursor to be shown when the mouse is over the gengrid item. /// /// preview [EditorBrowsable(EditorBrowsableState.Never)] @@ -111,7 +111,7 @@ namespace ElmSharp } /// - /// Sets or gets or sets the style of given gengrid item's tooltip. + /// Sets or gets, or sets the style of the given gengrid item's tooltip. /// /// preview public override string TooltipStyle @@ -127,7 +127,7 @@ namespace ElmSharp } /// - /// Get the gengrid item's select mode. + /// Gets the gengrid item's select mode. /// /// preview public override GenItemSelectionMode SelectionMode @@ -143,7 +143,7 @@ namespace ElmSharp } /// - /// Gets or sets gengrid item's row position, relative to the whole gengrid's grid area. + /// Gets or sets the gengrid item's row position, relative to the whole gengrid's grid area. /// /// preview public int Row @@ -157,7 +157,7 @@ namespace ElmSharp } /// - /// Gets or sets gengrid item's column position, relative to the whole gengrid's grid area. + /// Gets or sets the gengrid item's column position, relative to the whole gengrid's grid area. /// /// preview public int Column @@ -171,7 +171,7 @@ namespace ElmSharp } /// - /// Set the text to be shown in the gengrid item. + /// Sets the text to be shown in the gengrid item. /// /// The text to set. /// preview @@ -181,7 +181,7 @@ namespace ElmSharp } /// - /// Unset tooltip from item. + /// Unsets the tooltip from item. /// /// preview public override void UnsetTooltip() @@ -191,7 +191,7 @@ namespace ElmSharp /// /// Updates the content of a given gengrid item. - /// This updates an item by calling all the genitem class functions again to get the content, text, and states. + /// This updates an item by calling all the GenItem class functions again to get the content, text, and states. /// Use this when the original item data has changed and you want the changes to reflect. /// /// @@ -204,7 +204,7 @@ namespace ElmSharp } /// - /// Set the content to be shown in the tooltip item. + /// Sets the content to be shown in the tooltip item. /// /// preview protected override void UpdateTooltipDelegate() diff --git a/src/ElmSharp/ElmSharp/GenItem.cs b/src/ElmSharp/ElmSharp/GenItem.cs index 18fa72a..944849e 100755 --- a/src/ElmSharp/ElmSharp/GenItem.cs +++ b/src/ElmSharp/ElmSharp/GenItem.cs @@ -19,7 +19,7 @@ using System; namespace ElmSharp { /// - /// Enumeration for select mode of GenItem. + /// Enumeration for the selection modes of GenItem. /// /// preview public enum GenItemSelectionMode @@ -48,7 +48,7 @@ namespace ElmSharp /// /// It inherits . /// A base class for and . - /// It contains genitem class and data to display data. + /// It contains the GenItem class and data to display the data. /// /// preview public abstract class GenItem : ItemObject @@ -76,7 +76,7 @@ namespace ElmSharp public GenItemClass ItemClass { get; protected set; } /// - /// Sets or gets tooltip content delegate. + /// Sets or gets the tooltip content delegate. /// /// preview public GetTooltipContentDelegate TooltipContentDelegate @@ -93,13 +93,13 @@ namespace ElmSharp } /// - /// It's a abstract property. + /// It's an abstract property. /// /// preview public abstract GenItemSelectionMode SelectionMode { get; set; } /// - /// Sets or gets the cursor to be shown when mouse is over the gengrid item + /// Sets or gets the cursor to be shown when the mouse is over the gengrid item. /// /// preview public abstract string Cursor { get; set; } @@ -117,44 +117,44 @@ namespace ElmSharp public abstract bool IsUseEngineCursor { get; set; } /// - /// Gets item data that is added through calling , or methods. + /// Gets the item data that is added through calling , , or methods. /// /// preview public object Data { get; protected set; } /// - /// It's a abstract property. It's implemented by and . + /// It's an abstract property. It's implemented by and . /// /// preview public abstract bool IsSelected { get; set; } /// - /// It's a abstract property. It's implemented by and . + /// It's an abstract property. It's implemented by and . /// /// preview public abstract string TooltipStyle { get; set; } /// - /// Set tooltip text. + /// Sets the tooltip text. /// /// The text to set. /// preview public abstract void SetTooltipText(string tooltip); /// - /// Unset tooltip. + /// Unsets the tooltip. /// /// preview public abstract void UnsetTooltip(); /// - /// It's a abstract method. It's implemented by and . + /// It's an abstract method. It's implemented by and . /// /// preview public abstract void Update(); /// - /// The override method for delete item class and item data. It's called when the item is deleting. + /// The override method for deleting the item class and item data. It's called when the item is deleted. /// /// preview protected override void OnInvalidate() @@ -165,7 +165,7 @@ namespace ElmSharp } /// - /// Abstract method for updating tooltip content. + /// Abstract method for updating the tooltip content. /// /// preview protected abstract void UpdateTooltipDelegate(); diff --git a/src/ElmSharp/ElmSharp/GenItemClass.cs b/src/ElmSharp/ElmSharp/GenItemClass.cs index 2bd8c70..de05212 100755 --- a/src/ElmSharp/ElmSharp/GenItemClass.cs +++ b/src/ElmSharp/ElmSharp/GenItemClass.cs @@ -22,7 +22,7 @@ namespace ElmSharp { /// /// It represents the GenGrid or GenList item class definition field details. - /// It has some display styles, such as "default", "full" and "group_index". + /// It has some display styles, such as "default", "full", and "group_index". /// /// preview public class GenItemClass : IDisposable @@ -59,7 +59,7 @@ namespace ElmSharp /// /// The item data. /// The part where the data should be shown. - /// The content has been added in gengrid. + /// The content that has been added in gengrid. /// Return content that should be shown. /// preview public delegate EvasObject GetReusableContentDelegate(object data, string part, EvasObject old); @@ -90,7 +90,7 @@ namespace ElmSharp } /// - /// Destroy the GenItemClass object. + /// Destroys the GenItemClass object. /// ~GenItemClass() { @@ -104,28 +104,28 @@ namespace ElmSharp public string ItemStyle { get { return _style; } } /// - /// Gets or sets the callback that defines how to display item text. + /// Gets or sets the callback that defines how to display the item text. /// If get, return . /// /// preview public GetTextDelegate GetTextHandler { get; set; } /// - /// Gets or sets the callback that defines how to display item content. + /// Gets or sets the callback that defines how to display the item content. /// If get, return . /// /// preview public GetContentDelegate GetContentHandler { get; set; } /// - /// Gets or sets the callback that defines how to delete item text and content. + /// Gets or sets the callback that defines how to delete the item text and content. /// If get, return . /// /// preview public DeleteDelegate DeleteHandler { get; set; } /// - /// Gets or sets the callback that defines how to reuse item content. + /// Gets or sets the callback that defines how to reuse the item content. /// If get, return . /// /// preview @@ -145,11 +145,11 @@ namespace ElmSharp } /// - /// Releases all resources currently used by this instance. + /// Releases all the resources currently used by this instance. /// /// - /// true if managed resources should be disposed - /// otherwise, false. + /// true if the managed resources should be disposed, + /// otherwise false. /// /// preview protected virtual void Dispose(bool disposing) @@ -162,7 +162,7 @@ namespace ElmSharp } /// - /// Destroy current object + /// Destroys the current object. /// /// preview public void Dispose() @@ -178,7 +178,7 @@ namespace ElmSharp } /// - /// Create a new genlist item class in a given genlist widget. + /// Creates a new GenList item class in a given GenList widget. /// /// The new item class object. /// preview @@ -188,7 +188,7 @@ namespace ElmSharp } /// - /// Remove an item class in a given genlist widget. + /// Removes an item class in a given GenList widget. /// /// The object to be removed. /// preview @@ -244,7 +244,7 @@ namespace ElmSharp } /// - /// It represents the GenGrid item class definition field details. + /// It represents the gengrid item class definition field details. /// /// preview public class GenGridItemClass : GenItemClass @@ -259,7 +259,7 @@ namespace ElmSharp } /// - /// Add a new gengrid item class in a given gengrid widget. + /// Adds a new gengrid item class in a given GenGrid widget. /// /// The new instance. /// preview @@ -269,7 +269,7 @@ namespace ElmSharp } /// - /// Remove an item class in a given gengrid widget. + /// Removes the item class in a given GenGrid widget. /// /// The object to be removed. /// preview diff --git a/src/ElmSharp/ElmSharp/GenList.cs b/src/ElmSharp/ElmSharp/GenList.cs index d3371d5..446a6b2 100755 --- a/src/ElmSharp/ElmSharp/GenList.cs +++ b/src/ElmSharp/ElmSharp/GenList.cs @@ -20,37 +20,37 @@ using System.Collections.Generic; namespace ElmSharp { /// - /// Enumeration for setting genlist item type. + /// Enumeration for setting the genlist item types. /// /// preview public enum GenListItemType { /// - /// if Normal is set then this item is normal item. + /// If Normal is set, then this item is a normal item. /// Normal = 0, /// - /// If tree is set then this item is displayed as an item that is able to expand and have child items. + /// If Tree is set, then this item is displayed as an item that is able to expand and have child items. /// Tree = (1 << 0), /// - /// if Group is set then this item is group index item that is displayed at the top until the next group comes. + /// If Group is set, then this item is a group index item that is displayed at the top until the next group comes. /// Group = (1 << 1), } /// - /// Enumeration for setting genlist's resizing behavior, transverse axis scrolling and items cropping. + /// Enumeration for setting the genlist's resizing behavior, transverse axis scrolling, and items cropping. /// /// preview public enum GenListMode { /// /// The genlist won't set any of its size hints to inform how a possible container should resize it. - /// Then, if it's not created as a "resize object", it might end with zeroed dimensions. - /// The genlist will respect the container's geometry and, if any of its items won't fit into its transverse axis, one won't be able to scroll it in that direction. + /// Then, if it's not created as a "resize object", it might end up with zeroed dimensions. + /// The genlist will respect the container's geometry,and if any of its items won't fit into its transverse axis, one won't be able to scroll it in that direction. /// Compress = 0, @@ -67,7 +67,7 @@ namespace ElmSharp Limit, /// - /// Besides setting a minimum size on the transverse axis, just like on Limit, the genlist will set a minimum size on th longitudinal axis, trying to reserve space to all its children to be visible at a time. + /// Besides setting a minimum size on the transverse axis, just like on Limit, the genlist will set a minimum size on the longitudinal axis, trying to reserve space to all its children to be visible at a time. /// This is naturally bound by the genlist object's maximum size hints, set externally. /// Expand @@ -75,14 +75,14 @@ namespace ElmSharp /// /// It inherits System.EventArgs. - /// It contains Item which is type. - /// All events of GenList contain GenListItemEventArgs as a parameter. + /// It contains an item which is type. + /// All events of the GenList contain GenListItemEventArgs as a parameter. /// /// preview public class GenListItemEventArgs : EventArgs { /// - /// Gets or sets GenList item. The return type is . + /// Gets or sets the genlist item. The return type is . /// /// preview public GenListItem Item { get; set; } @@ -95,7 +95,7 @@ namespace ElmSharp } /// - /// Enumeration that defines where to position the item in the genlist. + /// Enumeration for defining where to position the item in the genlist. /// /// preview public enum ScrollToPosition @@ -128,10 +128,10 @@ namespace ElmSharp /// /// It inherits . - /// The GenList is a widget that aims to have more expansive list than the simple in ElmSharp that could have more flexible items and allow many more entries while still being fast and low on memory usage. + /// The GenList is a widget that aims to have a more expansive list than the simple in ElmSharp that could have more flexible items and allow many more entries while still being fast and low on memory usage. /// At the same time it was also made to be able to do tree structures. - /// But the price to pay is more complexity when it comes to usage. - /// If all you want is a simple list with icons and a single text, use the widget. + /// But the price to pay is more complex when it comes to usage. + /// If all you want is a simple list with icons and a single text, use widget. /// /// preview public class GenList : Layout @@ -158,14 +158,14 @@ namespace ElmSharp /// /// Creates and initializes a new instance of the GenList class. /// - /// The parent is a given container which will be attached by GenList as a child. It's type. + /// The parent is a given container, which will be attached by GenList as a child. It's type. /// preview public GenList(EvasObject parent) : base(parent) { } /// - /// Creates and initializes a new instance of GenList class. + /// Creates and initializes a new instance of the GenList class. /// /// preview protected GenList() : base() @@ -176,7 +176,7 @@ namespace ElmSharp /// Gets or sets whether the homogeneous mode is enabled. /// /// - /// If true, the genlist items have same height and width. + /// If true, the genlist items will have the same height and width. /// /// preview public bool Homogeneous @@ -193,15 +193,15 @@ namespace ElmSharp /// /// Gets or sets the horizontal stretching mode. This mode used for sizing items horizontally. - /// The default value is which means that if items are too wide to fit, the scroller scrolls horizontally. - /// If set which means that the item width is fixed (restricted to a minimum of) to the list width when calculating its size in order to allow the height to be calculated based on it. - /// If set which means that items are expanded to the viewport width and limited to that size. - /// if set which means that genlist try to reserve space to all its items to be visible at a time. + /// The default value is , which means that if the items are too wide to fit, the scroller scrolls horizontally. + /// If set to , means that the item width is fixed (restricted to a minimum) to the list width when calculating its size in order to allow the height to be calculated based on it. + /// If set to , means that items are expanded to the viewport width and limited to that size. + /// If set to , means that genlist try to reserve space to all its items to be visible at a time. /// /// - /// Compress makes genlist resize slower as it recalculates every item height again whenever the list width changes. - /// The homogeneous mode is so that all items in the genlist are of the same width/height. With Compress, genlist items are initialized fast. - /// However, there are no sub-objects in the genlist which can be on the flying resizable (such as TEXTBLOCK). + /// Compress makes the genlist resize slower, as it recalculates every item height again whenever the list width changes. + /// The homogeneous mode is so that all items in the genlist are of the same width/height. With Compress, the genlist items are initialized fast. + /// However, there are no subobjects in the genlist, which can be on the flying resizable (such as TEXTBLOCK). /// If so, then some dynamic resizable objects in the genlist would not be diplayed properly. /// /// preview @@ -262,7 +262,7 @@ namespace ElmSharp } /// - /// Gets or set the maximum number of items within an item block. + /// Gets or sets the maximum number of items within an item block. /// /// preview public int BlockCount @@ -310,11 +310,11 @@ namespace ElmSharp } /// - /// Gets or Sets focus upon items selection mode. + /// Gets or sets the focus upon the items selection mode. /// /// - /// When enabled, every selection of an item inside the will automatically set focus to its first focusable widget from the left. - /// This is true of course if the selection was made by clicking an unfocusable area in an item or selecting it with a key movement. + /// When enabled, every selection of an item inside will automatically set focus to its first focusable widget from the left. + /// This is true of course, if the selection was made by clicking an unfocusable area in an item or selecting it with a key movement. /// Clicking on a focusable widget inside an item will couse this particular item to get focus as usual. /// /// preview @@ -331,7 +331,7 @@ namespace ElmSharp } /// - /// Gets or sets whether enable multi-selection in the genlist. + /// Gets or sets whether to enable multi-selection in the genlist. /// /// preview public bool IsMultiSelection @@ -347,7 +347,7 @@ namespace ElmSharp } /// - /// Gets the selected item in a given genlist widget. + /// Gets the selected item in a given GenList widget. /// /// preview public GenListItem SelectedItem @@ -376,7 +376,7 @@ namespace ElmSharp } /// - /// Gets count of items in a this genlist widget + /// Gets the count of items in a this genlist widget. /// /// preview public int Count @@ -394,7 +394,7 @@ namespace ElmSharp public event EventHandler ItemSelected; /// - /// ItemUnselected is raised when the genlist item is Unselected. + /// ItemUnselected is raised when the genlist item is unselected. /// /// preview public event EventHandler ItemUnselected; @@ -412,13 +412,13 @@ namespace ElmSharp public event EventHandler ItemReleased; /// - /// ItemActivated is raised when a new genlist item is double clicked or pressed (enter|return|spacebar). + /// ItemActivated is raised when a new genlist item is double-clicked or pressed (enter|return|spacebar). /// /// preview public event EventHandler ItemActivated; /// - /// ItemDoubleClicked is raised when a new genlist item is double clicked. + /// ItemDoubleClicked is raised when a new genlist item is double-clicked. /// /// preview public event EventHandler ItemDoubleClicked; @@ -437,13 +437,13 @@ namespace ElmSharp /// /// ItemUnrealized is raised when a new genlist item is unrealized. - /// After calling unrealize, the item's content objects are deleted and the item object itself is deleted or is put into a floating cache. + /// After calling unrealize, the item's content objects are deleted, and the item object itself is deleted or is put into a floating cache. /// /// preview public event EventHandler ItemUnrealized; /// - /// ItemLongPressed is raised when a genlist item is pressed for a certain amount of time. By default it's 1 second. + /// ItemLongPressed is raised when a genlist item is pressed for a certain amount of time. By default, it's 1 second. /// /// preview public event EventHandler ItemLongPressed; @@ -469,7 +469,7 @@ namespace ElmSharp public event EventHandler ItemMovedBefore; /// - /// Changed is raised when genlist is changed. + /// Changed is raised when the genlist has changed. /// /// preview public event EventHandler Changed @@ -479,7 +479,7 @@ namespace ElmSharp } /// - /// ScrollAnimationStarted is raised when scrolling animation has started. + /// ScrollAnimationStarted is raised when the scrolling animation has started. /// /// preview public event EventHandler ScrollAnimationStarted @@ -489,7 +489,7 @@ namespace ElmSharp } /// - /// ScrollAnimationStopped is raised when scrolling animation has stopped. + /// ScrollAnimationStopped is raised when the scrolling animation has stopped. /// /// preview public event EventHandler ScrollAnimationStopped @@ -499,11 +499,11 @@ namespace ElmSharp } /// - /// Appends a new item to the end of a given genlist widget. + /// Appends a new item to the end of a given GenList widget. /// /// The itemClass defines how to display the data. /// The item data. - /// Return a new added genlist item that contains data and itemClass. + /// Return a newly added genlist item that contains the data and itemClass. /// /// /// preview @@ -513,12 +513,12 @@ namespace ElmSharp } /// - /// Appends a new item with to the end of a given genlist widget. + /// Appends a new item with to the end of a given GenList widget. /// /// The itemClass defines how to display the data. /// The item data. /// The genlist item type. - /// Return a new added genlist item that contains data and itemClass. + /// Return a newly added genlist item that contains the data and itemClass. /// preview public GenListItem Append(GenItemClass itemClass, object data, GenListItemType type) { @@ -526,13 +526,13 @@ namespace ElmSharp } /// - /// Appends a new item with to the end of a given genlist widget or the end of the children list if the parent is given. + /// Appends a new item with to the end of a given GenList widget or the end of the children list, if the parent is given. /// /// 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. + /// Return a newly added genlist item that contains the data and itemClass. /// preview public GenListItem Append(GenItemClass itemClass, object data, GenListItemType type, GenListItem parent) { @@ -544,11 +544,11 @@ namespace ElmSharp } /// - /// Prepends a new item to the beginning of a given genlist widget. + /// Prepends a new item to the beginning of a given GenList widget. /// /// The itemClass defines how to display the data. /// The item data. - /// Return a new added genlist item that contains data and itemClass. + /// Return a newly added genlist item that contains data and itemClass. /// preview public GenListItem Prepend(GenItemClass itemClass, object data) { @@ -561,7 +561,7 @@ namespace ElmSharp /// The itemClass defines how to display the data. /// The item data. /// The genlist item type. - /// Return a new added genlist item that contains data and itemClass. + /// Return a newly added genlist item that contains data and itemClass. /// preview public GenListItem Prepend(GenItemClass itemClass, object data, GenListItemType type) { @@ -569,13 +569,13 @@ namespace ElmSharp } /// - /// Prepends a new item with to the beginning of a given genlist widget or the beginning of the children list if the parent is given. + /// Prepends a new item with to the beginning of a given GenList widget or the beginning of the children list, if the parent is given. /// /// 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. + /// Return a newly added genlist item that contains the data and itemClass. /// preview public GenListItem Prepend(GenItemClass itemClass, object data, GenListItemType type, GenListItem parent) { @@ -593,7 +593,7 @@ namespace ElmSharp /// The itemClass defines how to display the data. /// The item data. /// The item before which to place this new one. - /// Return a new added genlist item that contains data and itemClass. + /// Return a newly added genlist item that contains data and itemClass. /// preview public GenListItem InsertBefore(GenItemClass itemClass, object data, GenListItem before) { @@ -601,14 +601,14 @@ namespace ElmSharp } /// - /// Inserts an item with before another item in a genlist widget. - /// It is the same tree level or group as the item before which it is inserted.???? + /// Inserts an item with before another item in a GenList widget. + /// It is the same tree level or group as the item before which it is inserted. /// /// The itemClass defines how to display the data. /// The item data. /// The item before which to place this new one. /// The genlist item type. - /// Return a new added genlist item that contains data and itemClass. + /// Return a newly added genlist item that contains data and itemClass. /// preview public GenListItem InsertBefore(GenItemClass itemClass, object data, GenListItem before, GenListItemType type) { @@ -616,14 +616,14 @@ namespace ElmSharp } /// - /// Inserts an item with before another item under a parent in a genlist widget. + /// Inserts an item with before another item under a parent in a GenList widget. /// /// The itemClass defines how to display the data. /// The item data. /// The item before 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. + /// Return a newly added genlist item that contains data and itemClass. /// preview public GenListItem InsertBefore(GenItemClass itemClass, object data, GenListItem before, GenListItemType type, GenListItem parent) { @@ -644,14 +644,14 @@ namespace ElmSharp } /// - /// Inserts an item with after another item under a parent in a genlist widget. + /// Inserts an item with after another item under a parent in a GenList widget. /// /// The itemClass defines how to display the data. /// The item data. /// 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. + /// Return a newly added genlist item that contains data and itemClass. /// preview public GenListItem InsertAfter(GenItemClass itemClass, object data, GenListItem after, GenListItemType type, GenListItem parent) { @@ -672,14 +672,14 @@ namespace ElmSharp } /// - /// Insert an item in a genlist widget using a user-defined sort function. + /// Inserts an item in a GenList widget using a user-defined sort function. /// /// 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 the 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. + /// Return a genlist item that contains the data and itemClass. /// preview public GenListItem InsertSorted(GenItemClass itemClass, object data, Comparison comparison, GenListItemType type, GenListItem parent) { @@ -707,9 +707,9 @@ namespace ElmSharp } /// - /// Shows the given item with position type in a genlist. - /// When animated is true, genlist will jump to the given item and display it (by animatedly scrolling), if it is not fully visible. This may use animation and may take some time. - /// When animated is false, genlist will jump to the given item and display it (by jumping to that position), if it is not fully visible. + /// Shows the given item with the position type in a genlist. + /// When animated is true, the genlist will jump to the given item and display it (by animatedly scrolling), if it is not fully visible. This may use animation and take sometime. + /// When animated is false, the genlist will jump to the given item and display it (by jumping to that position), if it is not fully visible. /// /// The item to display. /// The position to show the given item to . @@ -729,7 +729,7 @@ namespace ElmSharp /// /// Updates the content of all the realized items. - /// This updates all the realized items by calling all the again to get the content, text and states. + /// This updates all the realized items by calling all again to get the content, text, and states. /// Use this when the original item data has changed and the changes are desired to reflect. /// To update just one item, use . /// @@ -741,8 +741,8 @@ namespace ElmSharp } /// - /// Removes all items from a given genlist widget. - /// This removes (and deletes) all items in obj, making it empty. + /// Removes all the items from a given genlist widget. + /// This removes (and deletes) all items in the object, making it empty. /// To delete just one item, use . /// /// @@ -753,14 +753,14 @@ namespace ElmSharp } /// - /// Get the item that is at the x, y canvas coords. + /// Gets the item that is at the X, Y canvas coordinates. /// - /// The input x coordinate - /// The input y coordinate - /// The position relative to the item returned here - /// -1, 0, or 1, depending on whether the coordinate is on the upper portion of that item (-1), in the middle section (0), or on the lower part (1). + /// The input X-coordinate. + /// The input Y-coordinate. + /// The position relative to the item returned here. + /// -1, 0, or 1 depending on whether the coordinate is on the upper portion of that item (-1), in the middle section (0), or on the lower part (1). /// - /// + /// The item at the given coordinates. /// preview public GenListItem GetItemByPosition(int x, int y, out int pos) { @@ -771,7 +771,7 @@ namespace ElmSharp /// /// Gets the nth item in a given genlist widget, placed at position nth, in its internal items list. /// - /// The number of the item to grab (0 being the first) + /// The number of the item to grab (0 being the first). /// /// preview public GenListItem GetItemByIndex(int index) @@ -781,7 +781,7 @@ namespace ElmSharp } /// - /// The callback of Unrealize Event + /// The callback of the Unrealized event. /// /// preview protected override void OnRealized() @@ -794,8 +794,8 @@ namespace ElmSharp /// /// Creates a widget handle. /// - /// Parent EvasObject - /// Handle IntPtr + /// Parent EvasObject. + /// Handle IntPtr. /// preview protected override IntPtr CreateHandle(EvasObject parent) { diff --git a/src/ElmSharp/ElmSharp/GenListItem.cs b/src/ElmSharp/ElmSharp/GenListItem.cs index edd56c3..9284515 100755 --- a/src/ElmSharp/ElmSharp/GenListItem.cs +++ b/src/ElmSharp/ElmSharp/GenListItem.cs @@ -20,7 +20,7 @@ using System.ComponentModel; namespace ElmSharp { /// - /// The type of item's part type. + /// The type of the item's part types. /// /// preview [Flags] @@ -32,7 +32,7 @@ namespace ElmSharp All = 0, /// - /// The text part type. + /// The Text part type. /// Text = (1 << 0), @@ -42,7 +42,7 @@ namespace ElmSharp Content = (1 << 1), /// - /// The state of part. + /// The State part type. /// State = (1 << 2), @@ -54,8 +54,8 @@ namespace ElmSharp /// /// It inherits . - /// A instance to the genlist item added. - /// It contains Update() method to update a genlist item which is given. + /// A instance to the genlist item is added. + /// It contains the Update() method to update a genlist item which is given. /// /// preview public class GenListItem : GenItem @@ -98,9 +98,9 @@ namespace ElmSharp /// /// Updates the content of an item. - /// This updates an item by calling all the again to get the content, text, and states. + /// This updates an item by calling all again to get the content, text, and states. /// Use this when the original item data has changed and the changes are desired to reflect. - /// To update already realized items, use . + /// To update the already realized items, use . /// /// /// preview @@ -111,12 +111,12 @@ namespace ElmSharp /// /// Updates the part of an item. - /// This updates an item's part by calling item's fetching functions again to get the contents, texts and states. + /// This updates an item's part by calling the item's fetching functions again to get the contents, texts, and states. /// Use this when the original item data has changed and the changes are desired to be reflected. /// To update an item's all property, use . /// - /// The part could be "elm.text", "elm.swalllow.icon", "elm.swallow.end", "elm.swallow.content" and so on. It is also used for globbing to match '*', '?', and '.'. It can be used at updating multi fields. - /// The type of item's part type. + /// The part could be "elm.text", "elm.swalllow.icon", "elm.swallow.end", "elm.swallow.content", and so on. It is also used for globbing to match '*', '?', and '.'. It can be used for updating multi-fields. + /// The type of the item's part type. /// /// preview public void UpdateField(string part, GenListItemFieldType type) @@ -125,7 +125,7 @@ namespace ElmSharp } /// - /// Demote an item to the end of the list. + /// Demotes an item to the end of the list. /// /// preview public void DemoteItem() @@ -167,7 +167,7 @@ namespace ElmSharp } /// - /// Get the previous item in a genlist widget's internal list of items. + /// Gets the previous item in a genlist widget's internal list of items. /// /// /// preview @@ -184,7 +184,7 @@ namespace ElmSharp } /// - /// Sets or gets the content to be shown in the tooltip item + /// Sets or gets the content to be shown in the tooltip item. /// /// preview [EditorBrowsable(EditorBrowsableState.Never)] @@ -242,7 +242,7 @@ namespace ElmSharp } /// - /// Set the text to be shown in the genlist item. + /// Sets the text to be shown in the genlist item. /// /// The text to set in the content. /// preview @@ -252,7 +252,7 @@ namespace ElmSharp } /// - /// Unset tooltip from item. + /// Unsets the tooltip from the item. /// /// preview public override void UnsetTooltip() @@ -261,7 +261,7 @@ namespace ElmSharp } /// - /// Gets or sets the style of given genlist item's tooltip. + /// Gets or sets the style of the given genlist item's tooltip. /// /// preview public override string TooltipStyle @@ -277,7 +277,7 @@ namespace ElmSharp } /// - /// Gets or sets whether disable size restrictions on an object's tooltip. + /// Gets or sets the disable size restrictions on an object's tooltip. /// /// preview public bool IsTooltipWindowMode @@ -293,7 +293,7 @@ namespace ElmSharp } /// - /// Gets the index of the item. It is only valid once displayed. + /// Gets the index of the item. It is only valid, once displayed. /// /// preview public int Index @@ -305,7 +305,7 @@ namespace ElmSharp } /// - /// Gets the depth of expanded item. + /// Gets the depth of the expanded item. /// /// preview public int ExpandedItemDepth @@ -317,10 +317,10 @@ namespace ElmSharp } /// - /// Remove all sub-items (children) of the given item. + /// Remove all the subitems (children) of the given item. /// /// - /// This removes all items that are children (and their descendants) of the given item it. + /// This removes the items that are the children (and their descendants) of the given item. /// /// preview public void ClearSubitems() @@ -329,7 +329,7 @@ namespace ElmSharp } /// - /// Update the item class of an item. + /// Updates the item class of the item. /// This sets another class of the item, changing the way that it is displayed. After changing the item class, is called on the item. /// /// The item class for the item. @@ -343,7 +343,7 @@ namespace ElmSharp } /// - /// Set the content to be shown in the tooltip item. + /// Sets the content to be shown in the tooltip item. /// /// preview protected override void UpdateTooltipDelegate() diff --git a/src/ElmSharp/ElmSharp/GestureLayer.cs b/src/ElmSharp/ElmSharp/GestureLayer.cs index bde146f..6209ea6 100644 --- a/src/ElmSharp/ElmSharp/GestureLayer.cs +++ b/src/ElmSharp/ElmSharp/GestureLayer.cs @@ -22,7 +22,7 @@ namespace ElmSharp { /// /// The GestureLayer is used to detect gestures. - /// Inherits Widget + /// Inherits Widget. /// /// preview public class GestureLayer : Widget @@ -35,9 +35,9 @@ namespace ElmSharp private readonly List _handlers = new List(); /// - /// Creates and initializes a new instance of GestureLayer class. + /// Creates and initializes a new instance of the GestureLayer class. /// - /// The parent is a given container which will be attached by GestureLayer as a child. It's type. + /// The parent is a given container which will be attached by the GestureLayer as a child. It's the type. /// preview public GestureLayer(EvasObject parent) : base(parent) { @@ -45,85 +45,85 @@ namespace ElmSharp } /// - /// Enumeration for supported gesture types. + /// Enumeration for the supported gesture types. /// /// preview public enum GestureType { /// - /// N fingers single taps + /// N fingers single taps. /// Tap = 1, /// - /// N fingers single long-taps + /// N fingers single long-taps. /// LongTap, /// - /// N fingers double-single taps + /// N fingers double-single taps. /// DoubleTap, /// - /// N fingers triple-single taps + /// N fingers triple-single taps. /// TripleTap, /// - /// Reports momentum in the direction of move + /// Reports momentum in the direction of the move. /// Momentum, /// - /// N fingers line gesture + /// N fingers line gesture. /// Line, /// - /// N fingers flick gesture + /// N fingers flick gesture. /// Flick, /// - /// Zoom + /// Zoom. /// Zoom, /// - /// Rotate + /// Rotate. /// Rotate, } /// - /// Enumeration for gesture states. + /// Enumeration for the gesture states. /// /// preview public enum GestureState { /// - /// Gesture not started + /// Gesture not started. /// Undefined = -1, /// - /// Gesture started + /// Gesture started. /// Start, /// - /// Gesture is ongoing + /// Gesture is ongoing. /// Move, /// - /// Gesture completed + /// Gesture completed. /// End, /// - /// Ongoing gesture is aborted + /// Ongoing gesture is aborted. /// Abort, } @@ -147,7 +147,7 @@ namespace ElmSharp } /// - /// Sets or gets the gesture layer continues enable of an object + /// Sets or gets the gesture layer to continue enable of an object. /// /// preview public bool Continues @@ -179,7 +179,7 @@ namespace ElmSharp } /// - /// Sets or gets the gesture layer long tap start timeout of an object + /// Sets or gets the gesture layer long tap start timeout of an object. /// /// preview public double LongTapTimeout @@ -195,7 +195,7 @@ namespace ElmSharp } /// - /// Sets or gets the gesture layer double tap timeout of an object + /// Sets or gets the gesture layer double tap timeout of an object. /// /// preview public double DoubleTapTimeout @@ -211,7 +211,7 @@ namespace ElmSharp } /// - /// Sets or gets the gesture layer flick time limit (in ms) of an object + /// Sets or gets the gesture layer flick time limit (in ms) of an object. /// /// preview public int FlickTimeLimit @@ -227,7 +227,7 @@ namespace ElmSharp } /// - /// Sets or gets the gesture layer line min length of an object + /// Sets or gets the gesture layer line minimum length of an object. /// /// preview public int MinimumLineLength @@ -243,7 +243,7 @@ namespace ElmSharp } /// - /// Sets or gets the gesture layer line angular tolerance of an object + /// Sets or gets the gesture layer line angular tolerance of an object. /// /// preview public double LineAngularTolerance @@ -259,7 +259,7 @@ namespace ElmSharp } /// - /// Sets or gets the gesture layer line distance tolerance of an object + /// Sets or gets the gesture layer line distance tolerance of an object. /// /// preview public int LineDistanceTolerance @@ -275,7 +275,7 @@ namespace ElmSharp } /// - /// Sets or gets step-value for rotate action. + /// Sets or gets the step-value for the rotate action. /// /// preview public double RotateStep @@ -291,7 +291,7 @@ namespace ElmSharp } /// - /// Sets or gets the gesture layer rotate angular tolerance of an object + /// Sets or gets the gesture layer rotate angular tolerance of an object. /// /// preview public double RotateAngularTolerance @@ -307,7 +307,7 @@ namespace ElmSharp } /// - /// Sets or gets control step value for zoom action. + /// Sets or gets the control step value for the zoom action. /// /// preview public double ZoomStep @@ -323,7 +323,7 @@ namespace ElmSharp } /// - /// Sets or gets the gesture layer zoom distance tolerance of an object + /// Sets or gets the gesture layer zoom distance tolerance of an object. /// /// preview public int ZoomDistanceTolerance @@ -339,7 +339,7 @@ namespace ElmSharp } /// - /// Sets or gets the gesture layer zoom finger factor of an object + /// Sets or gets the gesture layer zoom finger factor of an object. /// /// preview public double ZoomFingerFactor @@ -355,7 +355,7 @@ namespace ElmSharp } /// - /// Sets or gets the gesture layer zoom wheel factor of an object + /// Sets or gets the gesture layer zoom wheel factor of an object. /// /// preview public double ZoomWheelFactor @@ -373,7 +373,7 @@ namespace ElmSharp #endregion Properties /// - /// Attach a gesture layer widget to an Evas object (setting the widget's target). + /// Attaches a gesture layer widget to an Evas object (setting the widget's target). /// A gesture layer's target may be any Evas object. This object will be used to listen to mouse and key events. /// /// The object to attach. @@ -384,7 +384,7 @@ namespace ElmSharp } /// - /// Set the gesture state change callback. + /// Sets the gesture state change callback. /// When all callbacks for the gesture are set to null, it means this gesture is disabled. /// /// The gesture you want to track state of. @@ -431,7 +431,7 @@ namespace ElmSharp } /// - /// clear the gesture state change callback. + /// Clears the gesture state change callback. /// /// preview public void ClearCallbacks() @@ -455,7 +455,7 @@ namespace ElmSharp // Following methods have been added for convenience, so the user will not have to convert Info structures himself /// - /// Set the tap callback. + /// Sets the tap callback. /// /// The gesture you want to track state of. /// The event the callback tracks (START, MOVE, END, ABORT). @@ -467,7 +467,7 @@ namespace ElmSharp } /// - /// Set the gesture state change callback with Momentum Gesture Type + /// Sets the gesture state change callback with momentum gesture type. /// /// The event the callback tracks (START, MOVE, END, ABORT). /// The callback itself. @@ -478,7 +478,7 @@ namespace ElmSharp } /// - /// Set the gesture state change callback with Line Gesture Type + /// Sets the gesture state change callback with line gesture type. /// /// The event the callback tracks (START, MOVE, END, ABORT). /// The callback itself. @@ -489,7 +489,7 @@ namespace ElmSharp } /// - /// Set the gesture state change callback with Flick Gesture Type + /// Sets the gesture state change callback with flick gesture type. /// /// The event the callback tracks (START, MOVE, END, ABORT). /// The callback itself. @@ -500,7 +500,7 @@ namespace ElmSharp } /// - /// Set the gesture state change callback with Zoom Gesture Type + /// Sets the gesture state change callback with zoom gesture type. /// /// The event the callback tracks (START, MOVE, END, ABORT). /// The callback itself. @@ -511,7 +511,7 @@ namespace ElmSharp } /// - /// Set the gesture state change callback with Rotate Gesture Type + /// Sets the gesture state change callback with rotate gesture type. /// /// The event the callback tracks (START, MOVE, END, ABORT). /// The callback itself. @@ -524,7 +524,7 @@ namespace ElmSharp #endregion Typed callback setting methods /// - /// Call this function to construct a new gesture-layer object. + /// Calls this function to construct a new gesture-layer object. /// /// The gesture layer's parent widget. /// @@ -535,7 +535,7 @@ namespace ElmSharp } /// - /// clear the gesture state change callback. + /// Clears the gesture state change callback. /// /// preview protected override void OnUnrealize() @@ -594,20 +594,20 @@ namespace ElmSharp #region Info structures /// - /// The struct of TapData + /// The struct of TapData. /// /// preview [StructLayout(LayoutKind.Sequential)] public struct TapData { /// - /// The x coordinate of the center point. + /// The X coordinate of the center point. /// /// preview public Int32 X; /// - /// The y coordinate of the center point. + /// The Y coordinate of the center point. /// /// preview public Int32 Y; @@ -630,7 +630,7 @@ namespace ElmSharp } /// - /// The struct of MomentumData + /// The struct of MomentumData. /// /// preview [StructLayout(LayoutKind.Sequential)] @@ -655,7 +655,7 @@ namespace ElmSharp public Int32 X2; /// - /// Final-swipe direction ending point on Y + /// Final-swipe direction ending point on Y. /// /// preview public Int32 Y2; @@ -663,13 +663,13 @@ namespace ElmSharp #pragma warning disable 3003 /// - /// Timestamp of start of final x-swipe. + /// Timestamp of start of final X-swipe. /// /// preview public UInt32 HorizontalSwipeTimestamp; /// - /// Timestamp of start of final y-swipe. + /// Timestamp of start of final Y-swipe. /// /// preview public UInt32 VerticalSwipeTimestamp; @@ -696,7 +696,7 @@ namespace ElmSharp } /// - /// The struct of LineData + /// The struct of LineData. /// /// preview [StructLayout(LayoutKind.Sequential)] @@ -721,7 +721,7 @@ namespace ElmSharp public Int32 X2; /// - /// Final-swipe direction ending point on Y + /// Final-swipe direction ending point on Y. /// /// preview public Int32 Y2; @@ -729,13 +729,13 @@ namespace ElmSharp #pragma warning disable 3003 /// - /// Timestamp of start of final x-swipe. + /// Timestamp of start of final X-swipe. /// /// preview public UInt32 HorizontalSwipeTimestamp; /// - /// Timestamp of start of final y-swipe. + /// Timestamp of start of final Y-swipe. /// /// preview public UInt32 VerticalSwipeTimestamp; @@ -768,20 +768,20 @@ namespace ElmSharp } /// - /// The struct of ZoomData + /// The struct of ZoomData. /// /// preview [StructLayout(LayoutKind.Sequential)] public struct ZoomData { /// - /// The x coordinate of zoom center point reported to user. + /// The X coordinate of zoom center point reported to the user. /// /// preview public Int32 X; /// - /// The y coordinate of zoom center point reported to user. + /// The Y coordinate of zoom center point reported to the user. /// /// preview public Int32 Y; @@ -805,20 +805,20 @@ namespace ElmSharp } /// - /// The struct of RotateData + /// The struct of RotateData. /// /// preview [StructLayout(LayoutKind.Sequential)] public struct RotateData { /// - /// The x coordinate of rotation center point reported to user. + /// The X coordinate of rotation center point reported to the user. /// /// preview public Int32 X; /// - /// The y coordinate of rotation center point reported to user. + /// The Y coordinate of rotation center point reported to the user. /// /// preview public Int32 Y; diff --git a/src/ElmSharp/ElmSharp/Hoversel.cs b/src/ElmSharp/ElmSharp/Hoversel.cs index ec8ec91..86b81f2 100755 --- a/src/ElmSharp/ElmSharp/Hoversel.cs +++ b/src/ElmSharp/ElmSharp/Hoversel.cs @@ -19,13 +19,13 @@ using System; namespace ElmSharp { /// - /// The HoverselItemEventArgs is an HoverselItem's EventArgs + /// The HoverselItemEventArgs is a HoverselItem's EventArgs. /// /// preview public class HoverselItemEventArgs : EventArgs { /// - /// Hoversel's Item + /// The hoversel's item. /// /// preview public HoverselItem Item { get; set; } @@ -52,7 +52,7 @@ namespace ElmSharp /// /// Creates and initializes a new instance of the Hoversel class. /// - /// The parent is a given container which will be attached by Hoversel as a child. It's type. + /// The parent is a given container, which will be attached by Hoversel as a child. It's type. /// preview public Hoversel(EvasObject parent) : base(parent) { @@ -84,25 +84,25 @@ namespace ElmSharp } /// - /// Clicked will be triggered when Hoversel is clicked + /// Clicked will be triggered when the hoversel is clicked. /// /// preview public event EventHandler Clicked; /// - /// Expanded will be triggered when Hoversel is activated by clicking the hoversel or by a function + /// Expanded will be triggered when the hoversel is activated by clicking the hoversel, or by a function. /// /// preview public event EventHandler Expanded; /// - /// Dismissed will be triggered when Hoversel Dismissed + /// Dismissed will be triggered when the hoversel is dismissed. /// /// preview public event EventHandler Dismissed; /// - /// ItemSelected will be triggered when Hoversel's Item Selected + /// ItemSelected will be triggered when the hoversel's item is selected. /// /// preview public event EventHandler ItemSelected; @@ -152,7 +152,7 @@ namespace ElmSharp } /// - /// Gets or sets the status of whether update icon and text of hoversel same to those of selected item automatically. + /// Gets or sets the status of whether to update the icon and text of hoversel same to those of the selected item automatically. /// /// preview public bool AutoUpdate @@ -168,7 +168,7 @@ namespace ElmSharp } /// - /// This triggers the hoversel popup from code, the same as if the user had clicked the button. + /// This triggers the hoversel popup from the code, the same as if the user had clicked the button. /// /// preview public void HoverBegin() @@ -195,10 +195,10 @@ namespace ElmSharp } /// - /// Add an item to the hoversel button. + /// Adds an item to the hoversel button. /// This adds an item to the hoversel to show when it is clicked. /// - /// Item's label + /// Item's label. /// A handle to the added item. /// preview public HoverselItem AddItem(string label) @@ -212,8 +212,8 @@ namespace ElmSharp /// /// Creates a widget handle. /// - /// Parent EvasObject - /// Handle IntPtr + /// Parent EvasObject. + /// Handle IntPtr. /// preview protected override IntPtr CreateHandle(EvasObject parent) { diff --git a/src/ElmSharp/ElmSharp/HoverselItem.cs b/src/ElmSharp/ElmSharp/HoverselItem.cs index 135c683..797481d 100755 --- a/src/ElmSharp/ElmSharp/HoverselItem.cs +++ b/src/ElmSharp/ElmSharp/HoverselItem.cs @@ -19,7 +19,7 @@ using System; namespace ElmSharp { /// - /// The HoverselItem is the Item of Hoversel + /// The HoverselItem is the item of Hoversel. /// /// preview public class HoverselItem : ItemObject @@ -29,13 +29,13 @@ namespace ElmSharp } /// - /// HoverselItem's label + /// The HoverselItem's label. /// /// preview public string Label { get; internal set; } /// - /// ItemSelected will be triggered when HoverselItem Selected + /// ItemSelected will be triggered when the HoverselItem is selected. /// /// preview public event EventHandler ItemSelected; diff --git a/src/ElmSharp/ElmSharp/IAccessibleObject.cs b/src/ElmSharp/ElmSharp/IAccessibleObject.cs index e8e4bc0..915bf7c 100755 --- a/src/ElmSharp/ElmSharp/IAccessibleObject.cs +++ b/src/ElmSharp/ElmSharp/IAccessibleObject.cs @@ -17,7 +17,7 @@ namespace ElmSharp.Accessible { /// - /// IAccessibleObject is a interface which defines properties and methods of accessible object. + /// IAccessibleObject is an interface, which defines the properties and methods of an accessible object. /// /// preview public interface IAccessibleObject @@ -29,22 +29,22 @@ namespace ElmSharp.Accessible ReadingInfoType ReadingInfoType { get; set; } /// - /// Gets or sets the role of the object in accessibility domain. + /// Gets or sets the role of the object in an accessibility domain. /// /// preview AccessRole Role { get; set; } /// - /// Gets or sets highlightable of given widget. + /// Gets or sets the highlightable of the given widget. /// /// preview bool CanHighlight { get; set; } /// - /// Gets or sets the translation domain of "name" and "description" properties. - /// Translation domain should be set if application wants to support i18n for accessibily "name" and "description" properties. - /// When translation domain is set values of "name" and "description" properties will be translated with dgettext function using current translation domain as "domainname" parameter. - /// It is application developer responsibility to ensure that translation files are loaded and binded to translation domain when accessibility is enabled. + /// Gets or sets the translation domain of the "name" and "description" properties. + /// Translation domain should be set if the application wants to support i18n for accessing the "name" and "description" properties. + /// When the translation domain is set, values of the "name" and "description" properties will be translated with dgettext function using the current translation domain as "domainname" parameter. + /// It is the application developer's responsibility to ensure that translation files are loaded and binded to the translation domain when accessibility is enabled. /// /// preview string TranslationDomain { get; set; } @@ -56,7 +56,7 @@ namespace ElmSharp.Accessible string Name { get; set; } /// - /// Gets or sets contextual information about object. + /// Gets or sets contextual information about the object. /// /// preview string Description { get; set; } @@ -68,7 +68,7 @@ namespace ElmSharp.Accessible AccessibleInfoProvider NameProvider { get; set; } /// - /// Gets or sets the delegate for . + /// Gets or sets the delegate for . /// /// preview AccessibleInfoProvider DescriptionProvider { get; set; } @@ -76,27 +76,27 @@ namespace ElmSharp.Accessible /// /// Defines the relationship between two accessible objects. /// Relationships can be queried by Assistive Technology clients to provide customized feedback, improving overall user experience. - /// AppendRelation API is asymmetric, which means that appending, for example, relation from object A to B, do not append relation from object B to object A. + /// AppendRelation API is asymmetric, which means that appending (For example, relation from object A to B) do not append relation from object B to object A. /// - /// The relationship between source object and target object of a given type. + /// The relationship between the source object and target object of a given type. /// preview void AppendRelation(IAccessibleRelation relation); /// /// Removes the relationship between two accessible objects. /// - /// The relationship between source object and target object of a given type. + /// The relationship between the source object and target object of a given type. /// preview void RemoveRelation(IAccessibleRelation relation); /// - /// Highlights accessible widget. + /// Highlights the accessible widget. /// /// preview void Highlight(); /// - /// Clears highlight of accessible widget. + /// Clears the highlight of the accessible widget. /// /// preview void Unhighlight(); diff --git a/src/ElmSharp/ElmSharp/IAnimatorMotionMapper.cs b/src/ElmSharp/ElmSharp/IAnimatorMotionMapper.cs index 0c83042..9e96620 100644 --- a/src/ElmSharp/ElmSharp/IAnimatorMotionMapper.cs +++ b/src/ElmSharp/ElmSharp/IAnimatorMotionMapper.cs @@ -5,26 +5,26 @@ using System.Text; namespace ElmSharp { /// - /// The AnimatorMotionMapper interface + /// The AnimatorMotionMapper interface. /// /// preview public interface IAnimatorMotionMapper { /// - /// Maps an input position from 0.0 to 1.0 along a timeline to a position in a different curve + /// Maps an input position from 0.0 to 1.0 along a timeline to a position in a different curve. /// /// preview double Calculate(double position); } /// - /// The LinearMotionMapper class + /// The LinearMotionMapper class. /// /// preview public class LinearMotionMapper : IAnimatorMotionMapper { /// - /// Maps an input position from 0.0 to 1.0 along a timeline to a position in a different curve + /// Maps an input position from 0.0 to 1.0 along a timeline to a position in a different curve. /// /// preview public double Calculate(double position) @@ -34,13 +34,13 @@ namespace ElmSharp } /// - /// The AccelerateMotionMapper class + /// The AccelerateMotionMapper class. /// /// preview public class AccelerateMotionMapper : IAnimatorMotionMapper { /// - /// Maps an input position from 0.0 to 1.0 along a timeline to a position in a different curve + /// Maps an input position from 0.0 to 1.0 along a timeline to a position in a different curve. /// /// preview public double Calculate(double position) @@ -50,13 +50,13 @@ namespace ElmSharp } /// - /// The DecelerateMotionMapper class + /// The DecelerateMotionMapper class. /// /// preview public class DecelerateMotionMapper : IAnimatorMotionMapper { /// - /// Maps an input position from 0.0 to 1.0 along a timeline to a position in a different curve + /// Maps an input position from 0.0 to 1.0 along a timeline to a position in a different curve. /// /// preview public double Calculate(double position) @@ -66,13 +66,13 @@ namespace ElmSharp } /// - /// The SinusoidalMotionMapper class + /// The SinusoidalMotionMapper class. /// /// preview public class SinusoidalMotionMapper : IAnimatorMotionMapper { /// - /// Maps an input position from 0.0 to 1.0 along a timeline to a position in a different curve + /// Maps an input position from 0.0 to 1.0 along a timeline to a position in a different curve. /// /// preview public double Calculate(double position) @@ -81,20 +81,20 @@ namespace ElmSharp } } - /// - /// The AccelerateFactorMotionMapper class + /// . + /// The AccelerateFactorMotionMapper class. /// /// preview public class AccelerateFactorMotionMapper : IAnimatorMotionMapper { /// - /// The power factor of AccelerateFactorMotionMapper + /// The power factor of AccelerateFactorMotionMapper. /// /// preview public double PowerFactor { get; set; } = 0; /// - /// Maps an input position from 0.0 to 1.0 along a timeline to a position in a different curve + /// Maps an input position from 0.0 to 1.0 along a timeline to a position in a different curve. /// /// preview public double Calculate(double position) @@ -104,19 +104,19 @@ namespace ElmSharp } /// - /// The DecelerateFactorMotionMapper class + /// The DecelerateFactorMotionMapper class. /// /// preview public class DecelerateFactorMotionMapper : IAnimatorMotionMapper { /// - /// The power factor of DecelerateFactorMotionMapper + /// The power factor of DecelerateFactorMotionMapper. /// /// preview public double PowerFactor { get; set; } = 0; /// - /// Maps an input position from 0.0 to 1.0 along a timeline to a position in a different curve + /// Maps an input position from 0.0 to 1.0 along a timeline to a position in a different curve. /// /// preview public double Calculate(double position) @@ -126,19 +126,19 @@ namespace ElmSharp } /// - /// The SinusoidalFactorMotionMapper class + /// The SinusoidalFactorMotionMapper class. /// /// preview public class SinusoidalFactorMotionMapper : IAnimatorMotionMapper { /// - /// The power factor of SinusoidalFactorMotionMapper + /// The power factor of SinusoidalFactorMotionMapper. /// /// preview public double PowerFactor { get; set; } = 0; /// - /// Maps an input position from 0.0 to 1.0 along a timeline to a position in a different curve + /// Maps an input position from 0.0 to 1.0 along a timeline to a position in a different curve. /// /// preview public double Calculate(double position) @@ -148,25 +148,25 @@ namespace ElmSharp } /// - /// The DivisorInterpolatedMotionMapper class + /// The DivisorInterpolatedMotionMapper class. /// /// preview public class DivisorInterpolatedMotionMapper : IAnimatorMotionMapper { /// - /// The Divisor of DivisorInterpolatedMotionMapper + /// The Divisor of DivisorInterpolatedMotionMapper. /// /// preview public double Divisor { get; set; } = 0; /// - /// The power of DivisorInterpolatedMotionMapper + /// The power of DivisorInterpolatedMotionMapper. /// /// preview public double Power { get; set; } = 0; /// - /// Maps an input position from 0.0 to 1.0 along a timeline to a position in a different curve + /// Maps an input position from 0.0 to 1.0 along a timeline to a position in a different curve. /// /// preview public double Calculate(double position) @@ -176,25 +176,25 @@ namespace ElmSharp } /// - /// The BounceMotionMapper class + /// The BounceMotionMapper class. /// /// preview public class BounceMotionMapper : IAnimatorMotionMapper { /// - /// The bounces of BounceMotionMapper + /// The bounces of BounceMotionMapper. /// /// preview public int Bounces { get; set; } = 0; /// - /// The decay factor of BounceMotionMapper + /// The decay factor of BounceMotionMapper. /// /// preview public double DecayFactor { get; set; } = 0; /// - /// Maps an input position from 0.0 to 1.0 along a timeline to a position in a different curve + /// Maps an input position from 0.0 to 1.0 along a timeline to a position in a different curve. /// /// preview public double Calculate(double position) @@ -204,25 +204,25 @@ namespace ElmSharp } /// - /// The SpringMotionMapper class + /// The SpringMotionMapper class. /// /// preview public class SpringMotionMapper : IAnimatorMotionMapper { /// - /// The wobbles of SpringMotionMapper + /// The wobbles of SpringMotionMapper. /// /// preview public int Wobbles { get; set; } = 0; /// - /// The decat factir of SpringMotionMapper + /// The decay factor of SpringMotionMapper. /// /// preview public double DecayFactor { get; set; } = 0; /// - /// Maps an input position from 0.0 to 1.0 along a timeline to a position in a different curve + /// Maps an input position from 0.0 to 1.0 along a timeline to a position in a different curve. /// /// preview public double Calculate(double position) @@ -232,37 +232,37 @@ namespace ElmSharp } /// - /// The CubicBezierMotionMapper class + /// The CubicBezierMotionMapper class. /// /// preview public class CubicBezierMotionMapper : IAnimatorMotionMapper { /// - /// The X1 of CubicBezierMotionMapper + /// The X1 of CubicBezierMotionMapper. /// /// preview public double X1 { get; set; } = 0; /// - /// The Y1 of CubicBezierMotionMapper + /// The Y1 of CubicBezierMotionMapper. /// /// preview public double Y1 { get; set; } = 0; /// - /// The X2 of CubicBezierMotionMapper + /// The X2 of CubicBezierMotionMapper. /// /// preview public double X2 { get; set; } = 0; /// - /// The Y2 of CubicBezierMotionMapper + /// The Y2 of CubicBezierMotionMapper. /// /// preview public double Y2 { get; set; } = 0; /// - /// Maps an input position from 0.0 to 1.0 along a timeline to a position in a different curve + /// Maps an input position from 0.0 to 1.0 along a timeline to a position in a different curve. /// /// preview public double Calculate(double position) diff --git a/src/ElmSharp/ElmSharp/Icon.cs b/src/ElmSharp/ElmSharp/Icon.cs index 5f2dac4..070b447 100755 --- a/src/ElmSharp/ElmSharp/Icon.cs +++ b/src/ElmSharp/ElmSharp/Icon.cs @@ -25,35 +25,35 @@ namespace ElmSharp public enum IconLookupOrder { /// - /// Icon look up order: freedesktop, theme + /// Icon look up order: freedesktop, theme. /// FreeDesktopFirst = 0, /// - /// Icon look up order: theme, freedesktop + /// Icon look up order: theme, freedesktop. /// ThemeFirst, /// - /// Icon look up order: freedesktop + /// Icon look up order: freedesktop. /// FreeDesktopOnly, /// - /// Icon look up order: theme + /// Icon look up order: theme. /// ThemeOnly } /// - /// The Icon is a widget that displays standard icon images ("delete", "edit", "arrows", etc.) - /// or images coming from a custom file (PNG, JPG, EDJE, etc.), on icon context. - /// Inherits Image + /// The Icon is a widget that displays the standard icon images ("delete", "edit", "arrows", etc.) + /// or images coming from a custom file (PNG, JPG, EDJE, etc.), on the icon context. + /// Inherits Image. /// /// preview public class Icon : Image { /// - /// Creates and initializes a new instance of Icon class. + /// Creates and initializes a new instance of the Icon class. /// - /// The parent is a given container which will be attached by Icon as a child. It's type. + /// The parent is a given container, which will be attached by Icon as a child. It's type. /// preview public Icon(EvasObject parent) : base(parent) { @@ -94,8 +94,8 @@ namespace ElmSharp /// /// Sets the file that is used, but uses a generated thumbnail. /// - /// The path to the file that is used as an icon image - /// The group that the icon belongs to + /// The path to the file that is used as an icon image. + /// The group that the icon belongs to. /// preview public void SetThumb(string file, string group) { @@ -106,7 +106,7 @@ namespace ElmSharp /// Adds a new icon object to the parent. /// /// EvasObject - /// The new object, otherwise NULL if it cannot be created + /// The new object, otherwise null if it cannot be created. /// preview protected override IntPtr CreateHandle(EvasObject parent) { diff --git a/src/ElmSharp/ElmSharp/Image.cs b/src/ElmSharp/ElmSharp/Image.cs index 368eba9..da69b82 100644 --- a/src/ElmSharp/ElmSharp/Image.cs +++ b/src/ElmSharp/ElmSharp/Image.cs @@ -24,7 +24,7 @@ namespace ElmSharp /// /// The Image is a widget that allows one to load and display an image file on it, /// be it from a disk file or from a memory region. - /// Inherits Widget + /// Inherits Widget. /// /// preview public class Image : Widget @@ -37,9 +37,9 @@ namespace ElmSharp EvasImage _imageObject = null; /// - /// Creates and initializes a new instance of Image class. + /// Creates and initializes a new instance of the Image class. /// - /// The parent is a given container which will be attached by Image as a child. It's type. + /// The parent is a given container, which will be attached by the image as a child. It's type. /// preview public Image(EvasObject parent) : base(parent) { @@ -60,7 +60,7 @@ namespace ElmSharp public event EventHandler LoadingCompleted; /// - /// Clicked will be triggered when the image is fail to load. + /// Clicked will be triggered when the image fails to load. /// /// preview public event EventHandler LoadingFailed; @@ -110,7 +110,7 @@ namespace ElmSharp } /// - /// Sets or gets whether the object is down resizeable. + /// Sets or gets whether the object is down resizable. /// /// preview public bool CanScaleDown @@ -127,7 +127,7 @@ namespace ElmSharp } /// - /// Sets or gets whether the object is up resizeable. + /// Sets or gets whether the object is up resizable. /// /// preview public bool CanScaleUp @@ -269,7 +269,7 @@ namespace ElmSharp } /// - /// Sets or gets whether alpha channel data is being used on the given image object. + /// Sets or gets whether the alpha channel data is being used on the given image object. /// /// preview public bool IsOpaque @@ -308,7 +308,7 @@ namespace ElmSharp } /// - /// Sets or gets the image color + /// Sets or gets the image color. /// /// preview public override Color Color @@ -335,7 +335,7 @@ namespace ElmSharp } /// - /// Sets the background color + /// Sets the background color. /// /// preview public override Color BackgroundColor @@ -358,7 +358,7 @@ namespace ElmSharp /// Gets the inlined image object of the image widget. /// This property allows one to get the underlying EvasObject of type Image from this elementary widget. It can be useful to do things like save the image to a file, etc. /// - /// Be careful to not manipulate it, as it is under the control of widget. + /// Be careful not to manipulate it, as it is under the control of the widget. /// preview public EvasImage ImageObject { @@ -380,10 +380,10 @@ namespace ElmSharp /// /// Sets the dimensions for an image object's border, a region which is not scaled together with its center ever. /// - /// The border's left width - /// The border's right width - /// The border's top width - /// The border's bottom width + /// The border's left width. + /// The border's right width. + /// The border's top width. + /// The border's bottom width. /// preview public void SetBorder(int left, int right, int top, int bottom) { @@ -425,7 +425,7 @@ namespace ElmSharp /// /// Sets the file that is used as the image's source. /// - /// The path to the file that is used as an image source + /// The path to the file that is used as an image source. /// (true = success, false = error) /// preview public bool Load(string file) @@ -439,9 +439,9 @@ namespace ElmSharp } /// - /// Sets the uri that is used as the image's source. + /// Sets the URI that is used as the image's source. /// - /// The uri to the file that is used as an image source + /// The URI to the file that is used as an image source. /// (true = success, false = error) /// preview public bool Load(Uri uri) @@ -456,12 +456,12 @@ namespace ElmSharp /// Sets a location in the memory to be used as an image object's source bitmap. /// /// - /// This function is handy when the contents of an image file are mapped into the memory, for example. - /// The format string should be something like "png", "jpg", "tga", "tiff", "bmp" etc, when provided (null, on the contrary). + /// This function is handy when the contents of an image file are mapped into the memory, for example, + /// the format string should be something like "png", "jpg", "tga", "tiff", "bmp" etc, when provided (null, on the contrary). /// This improves the loader performance as it tries the "correct" loader first, before trying a range of other possible loaders until one succeeds. /// - /// The binary data that is used as an image source - /// The size of the binary data blob img + /// The binary data that is used as an image source. + /// The size of the binary data blob img. /// (true = success, false = error) /// preview [Obsolete("This method will be removed. Use Load(Stream stream) instead.")] @@ -478,7 +478,7 @@ namespace ElmSharp /// /// Sets the stream that is used as the image's source. /// - /// The stream that is used as an image source + /// The stream that is used as an image source. /// (true = success, false = error) /// preview public bool Load(Stream stream) @@ -503,8 +503,8 @@ namespace ElmSharp /// /// Sets the file that is used as the image's source with async. /// - /// The path to the file that is used as an image source - /// cancellation token + /// The path to the file that is used as an image source. + /// The cancellation token. /// (true = success, false = error) /// preview public Task LoadAsync(string file, CancellationToken cancellationToken = default(CancellationToken)) @@ -557,10 +557,10 @@ namespace ElmSharp } /// - /// Sets the uri that is used as the image's source with async. + /// Sets the URI that is used as the image's source with async. /// - /// The uri to the file that is used as an image source - /// cancellation token + /// The URI to the file that is used as an image source. + /// The cancellation token. /// (true = success, false = error) /// preview public Task LoadAsync(Uri uri, CancellationToken cancellationToken = default(CancellationToken)) @@ -574,8 +574,8 @@ namespace ElmSharp /// /// Sets the stream that is used as the image's source with async. /// - /// The stream that is used as an image source - /// cancellation token + /// The stream that is used as an image source. + /// The cancellation token. /// (true = success, false = error) /// preview public async Task LoadAsync(Stream stream, CancellationToken cancellationToken = default(CancellationToken)) @@ -640,10 +640,10 @@ namespace ElmSharp } /// - /// Sets the color of color class for a given widget. + /// Sets the color of the Color class for a given widget. /// - /// The name of color class. - /// The struct of color + /// The name of the Color class. + /// The struct of the Color class. /// preview public override void SetPartColor(string part, Color color) { @@ -654,10 +654,10 @@ namespace ElmSharp } /// - /// Gets the color of color class for a given widget. + /// Gets the color of the Color class for a given widget. /// - /// The name of color class. - /// color object + /// The name of the Color class. + /// The color object. /// preview public override Color GetPartColor(string part) { @@ -668,8 +668,8 @@ namespace ElmSharp /// /// Sets the content at a part of a given container widget. /// - /// The parent is a given container which will be attached by Image as a child. It's type. - /// The new object, otherwise null if it cannot be created + /// The parent is a given container, which will be attached by the image as a child. It's type. + /// The new object, otherwise null if it cannot be created. /// preview protected override IntPtr CreateHandle(EvasObject parent) { @@ -684,70 +684,70 @@ namespace ElmSharp } /// - /// Enumeration for the fill mode of image border + /// Enumeration for the fill mode of the image border. /// /// preview public enum ImageBorderFillMode { /// - /// None mode of image border + /// None mode of the image border. /// None, /// - /// Default mode of image border + /// Default mode of the image border. /// Default, /// - /// Solid mode of image border + /// Solid mode of the image border. /// Solid, } /// - /// Enumeration for the possible orientation options + /// Enumeration for the possible orientation options. /// /// preview public enum ImageOrientation : int { /// - /// No orientation change + /// No orientation change. /// None = 0, /// - /// Rotate 90 degrees clockwise + /// Rotate 90 degrees clockwise. /// Rotate90, /// - /// Rotate 180 degrees clockwise + /// Rotate 180 degrees clockwise. /// Rotate180, /// - /// Rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) + /// Rotate 90 degrees counter-clockwise (i.e., 270 degrees clockwise). /// Rotate270, /// - /// Flip image horizontally + /// Flip the image horizontally. /// FlipHorizontal, /// - /// Flip image vertically + /// Flip the image vertically. /// FlipVertical, /// - /// Flip the image along the y = (width - x) line (bottom-left to top-right) + /// Flip the image along the Y = (width - X) line (bottom-left to top-right). /// FlipTranspose, /// - /// Flip the image along the y = x line (top-left to bottom-right) + /// Flip the image along the Y = X line (top-left to bottom-right). /// FlipTransverse } diff --git a/src/ElmSharp/ElmSharp/Index.cs b/src/ElmSharp/ElmSharp/Index.cs index 6e715dd..5b54757 100755 --- a/src/ElmSharp/ElmSharp/Index.cs +++ b/src/ElmSharp/ElmSharp/Index.cs @@ -20,8 +20,8 @@ using System.Collections.Generic; namespace ElmSharp { /// - /// An index widget gives you an index for fast access to whichever group of other UI items one might have. - /// Inherits Layout + /// The Index widget gives you an index for fast access to whichever group of the other UI items one might have. + /// Inherits Layout. /// /// preview public class Index : Layout @@ -30,9 +30,9 @@ namespace ElmSharp SmartEvent _delayedChanged; /// - /// Creates and initializes a new instance of Index class. + /// Creates and initializes a new instance of the Index class. /// - /// The parent is a given container which will be attached by Index as a child. It's type. + /// The parent is a given container, which will be attached by Index as a child. It's type. /// preview public Index(EvasObject parent) : base(parent) { @@ -47,7 +47,7 @@ namespace ElmSharp public event EventHandler Changed; /// - /// Sets or gets the auto hiding feature is enabled or not for a given index widget. + /// Sets or gets whether the auto hiding feature is enabled or not for a given index widget. /// /// preview public bool AutoHide @@ -63,7 +63,7 @@ namespace ElmSharp } /// - /// Sets or gets a value whether horizontal mode is enabled or not. + /// Sets or gets a value whether the horizontal mode is enabled or not. /// /// preview public bool IsHorizontal @@ -79,7 +79,7 @@ namespace ElmSharp } /// - /// Sets or gets the value of indicator's disabled status. + /// Sets or gets a value of the indicator's disabled status. /// /// preview public bool IndicatorVisible @@ -95,7 +95,7 @@ namespace ElmSharp } /// - /// Sets or gets the omit feature is enabled or not for a given index widget. + /// Sets or gets whether the omit feature is enabled or not for a given index widget. /// /// preview public bool OmitEnabled @@ -111,8 +111,8 @@ namespace ElmSharp } /// - /// Set a delay change time for index object. - /// delay time is 0.2 sec by default. + /// Sets a delay change time for the index object. + /// The delay time is 0.2 seconds by default. /// /// preview public double Delay @@ -144,8 +144,8 @@ namespace ElmSharp } /// - /// Control standard_priority group of index. - /// Priority group will be shown as many items as it can, and other group will be shown one character only. + /// Controls the standard_priority group of the index. + /// Priority group will be shown as many items as it can, and other group will be shown for one character only. /// /// preview public int Priority @@ -161,7 +161,7 @@ namespace ElmSharp } /// - /// Gets the last selected item, for a given index widget. + /// Gets the last selected item for a given index widget. /// /// preview public IndexItem SelectedItem @@ -174,10 +174,10 @@ namespace ElmSharp } /// - /// Append a new item on a given index widget. + /// Appends a new item on a given index widget. /// - /// the label which the item should be indexed - /// A object to the IndexItem added or null, on errors + /// The label for which the item should be indexed. + /// An object to the IndexItem if added, or null on errors. /// preview public IndexItem Append(string label) { @@ -187,10 +187,10 @@ namespace ElmSharp } /// - /// Prepend a new item on a given index widget. + /// Prepends a new item on a given index widget. /// - /// the label which the item should be indexed - /// A handle to the item added or NULL, on errors + /// The label for which the item should be indexed. + /// A handle to the item if added, or null on errors. /// preview public IndexItem Prepend(string label) { @@ -200,11 +200,11 @@ namespace ElmSharp } /// - /// Insert a new item into the index object before item before. + /// Inserts a new item into the index object before the item before. /// - /// the label which the item should be indexed + /// The label for which the item should be indexed. /// The index item to insert after. - /// A object to the IndexItem added or null, on errors + /// An object to the IndexItem if added, or null on errors. /// preview public IndexItem InsertBefore(string label, IndexItem before) { @@ -214,11 +214,11 @@ namespace ElmSharp } /// - /// Insert a new item into the index object after item after. + /// Inserts a new item into the index object after the item after. /// - /// the label which the item should be indexed + /// The label for which the item should be indexed. /// The index item to insert after. - /// A object to the IndexItem added or null, on errors + /// An object to the IndexItem if added, or null on errors. /// preview public IndexItem InsertAfter(string label, IndexItem after) { @@ -228,9 +228,9 @@ namespace ElmSharp } /// - /// Flush the changes made to the index items so they work correctly. + /// Flushes the changes made to the index items so that they work correctly. /// - /// The index level (one of 0 or 1) where changes were made + /// The index level (one of 0 or 1) where the changes were made. /// preview public void Update(int level) { @@ -238,7 +238,7 @@ namespace ElmSharp } /// - /// Removes all items from a given index widget. + /// Removes all the items from a given index widget. /// /// preview public void Clear() @@ -249,8 +249,8 @@ namespace ElmSharp /// /// Creates a widget handle. /// - /// Parent EvasObject - /// Handle IntPtr + /// Parent EvasObject. + /// Handle IntPtr. /// preview protected override IntPtr CreateHandle(EvasObject parent) { diff --git a/src/ElmSharp/ElmSharp/IndexItem.cs b/src/ElmSharp/ElmSharp/IndexItem.cs index 349ae03..110c627 100755 --- a/src/ElmSharp/ElmSharp/IndexItem.cs +++ b/src/ElmSharp/ElmSharp/IndexItem.cs @@ -18,16 +18,16 @@ using System; namespace ElmSharp { /// - /// The IndexItem is used to manage index item - /// Inherits ItemObject + /// The IndexItem is used to manage the index item. + /// Inherits ItemObject. /// /// preview public class IndexItem : ItemObject { /// - /// Creates and initializes a new instance of IndexItem class. + /// Creates and initializes a new instance of the IndexItem class. /// - /// the text is set to the Text. It's 'string' type. + /// The text is set to the Text. It's the 'string' type. /// preview public IndexItem(string text) : base(IntPtr.Zero) { @@ -35,13 +35,13 @@ namespace ElmSharp } /// - /// Selected will be triggered when the index item is selected + /// Selected will be triggered when the index item is selected. /// /// preview public event EventHandler Selected; /// - /// Gets the text + /// Gets the text. /// /// preview public string Text { get; private set; } @@ -49,7 +49,7 @@ namespace ElmSharp /// /// Sets the selected state of an item. /// - /// The selected state + /// The selected state. /// preview public void Select(bool selected) { diff --git a/src/ElmSharp/ElmSharp/ItemObject.cs b/src/ElmSharp/ElmSharp/ItemObject.cs index 5e3211e..6a6342c 100644 --- a/src/ElmSharp/ElmSharp/ItemObject.cs +++ b/src/ElmSharp/ElmSharp/ItemObject.cs @@ -20,7 +20,7 @@ using System.Collections.Generic; namespace ElmSharp { /// - /// The ItemObject is used to manage item object + /// The ItemObject is used to manage the item object. /// /// preview public class ItemObject @@ -36,7 +36,7 @@ namespace ElmSharp EvasObject _trackObject = null; /// - /// Creates and initializes a new instance of ItemObject class. + /// Creates and initializes a new instance of the ItemObject class. /// /// IntPtr /// preview @@ -58,13 +58,13 @@ namespace ElmSharp //} /// - /// Gets the id of item object + /// Gets the ID of the item object. /// /// preview public int Id { get; private set; } /// - /// Sets or gets whether the item object is enabled + /// Sets or gets whether the item object is enabled. /// /// preview public bool IsEnabled @@ -74,7 +74,7 @@ namespace ElmSharp } /// - /// Gets track object of the item. + /// Gets the track object of the item. /// /// preview public EvasObject TrackObject @@ -88,7 +88,7 @@ namespace ElmSharp } /// - /// Sets or gets the style of the Item. + /// Sets or gets the style of the item. /// /// preview public virtual string Style @@ -125,13 +125,13 @@ namespace ElmSharp } /// - /// Deleted will be triggered when the item object is deleted + /// Deleted will be triggered when the item object is deleted. /// /// preview public event EventHandler Deleted; /// - /// Delete the item object + /// Deletes the item object. /// /// preview public void Delete() @@ -141,22 +141,22 @@ namespace ElmSharp } /// - /// Set a content of an object item and delete old content + /// Sets a content of an object item and deletes the old content. /// - /// The content part name (null for the default content) - /// The content of the object item + /// The content part name (null for the default content). + /// The content of the object item. /// preview public void SetPartContent(string part, EvasObject content) { SetPartContent(part, content, false); } - /// - /// Set a content of an object item + /// . + /// Sets a content of the object item. /// /// The content part name (null for the default content) - /// The content of the object item - /// judge whether delete old content + /// The content of the object item. + /// Judge whether to delete the old content. /// preview public void SetPartContent(string part, EvasObject content, bool preserveOldContent) { @@ -170,10 +170,10 @@ namespace ElmSharp } /// - /// Set a label of an object item + /// Sets the label of the object item. /// - /// The text part name (null for the default label) - /// Text of the label + /// The text part name (null for the default label). + /// Text of the label. /// preview public void SetPartText(string part, string text) { @@ -181,9 +181,9 @@ namespace ElmSharp } /// - /// Gets a label of an object item + /// Gets the label of the object item. /// - /// The text part name (null for the default label) + /// The text part name (null for the default label). /// /// preview public string GetPartText(string part) @@ -192,10 +192,10 @@ namespace ElmSharp } /// - /// Sets color of an object item + /// Sets the color of the object item. /// - /// The text part name (null for the default label) - /// the color + /// The text part name (null for the default label). + /// The color. /// preview public void SetPartColor(string part, Color color) { @@ -206,10 +206,10 @@ namespace ElmSharp } /// - /// Gets color of an object item + /// Gets the color of the object item. /// - /// The text part name (null for the default label) - /// the color of object item + /// The text part name (null for the default label). + /// The color of an object item. /// preview public Color GetPartColor(string part) { @@ -219,9 +219,9 @@ namespace ElmSharp } /// - /// Deletes color of an object item + /// Deletes the color of the object item. /// - /// The text part name + /// The text part name. /// preview public void DeletePartColor(string part) { @@ -229,7 +229,7 @@ namespace ElmSharp } /// - /// Add a function for a signal emitted by object item edje. + /// Adds a function for a signal emitted by the object item edje. /// /// The signal's name. /// The signal's source. @@ -252,7 +252,7 @@ namespace ElmSharp } /// - /// Remove a signal-triggered function from a object item edje object. + /// Removes a signal-triggered function from the object item edje object. /// /// The signal's name. /// The signal's source. @@ -287,7 +287,7 @@ namespace ElmSharp } /// - /// Gets the handle of object item + /// Gets the handle of the object item. /// /// ItemObject /// preview @@ -299,7 +299,7 @@ namespace ElmSharp } /// - /// OnInvalidate of object item + /// OnInvalidate of the object item. /// /// preview protected virtual void OnInvalidate() { } @@ -368,8 +368,8 @@ namespace ElmSharp /// /// The object to compare with the current instance. /// - /// true if obj and this instance are the same type and represent the same value. - /// otherwise, false. + /// true if the object and this instance are of the same type and represent the same value, + /// otherwise false. /// public override bool Equals(object obj) { @@ -395,7 +395,7 @@ namespace ElmSharp IntPtr _parent = IntPtr.Zero; /// - /// Creates and initializes a new instance of ItemEvasObject class. + /// Creates and initializes a new instance of the ItemEvasObject class. /// /// IntPtr public ItemEvasObject(IntPtr parent) : base() @@ -407,8 +407,8 @@ namespace ElmSharp /// /// Creates a widget handle. /// - /// Parent EvasObject - /// Handle IntPtr + /// Parent EvasObject. + /// Handle IntPtr. protected override IntPtr CreateHandle(EvasObject parent) { return Interop.Elementary.elm_object_item_track(_parent); diff --git a/src/ElmSharp/ElmSharp/ItemObjectExtension.cs b/src/ElmSharp/ElmSharp/ItemObjectExtension.cs index bc4db53..98fd12f 100755 --- a/src/ElmSharp/ElmSharp/ItemObjectExtension.cs +++ b/src/ElmSharp/ElmSharp/ItemObjectExtension.cs @@ -19,15 +19,15 @@ using System; namespace ElmSharp { /// - /// The ItemObjectExtension is used to manage item object extension + /// The ItemObjectExtension is used to manage the item object extension. /// /// preview public static class ItemObjectExtension { /// - /// Grab high light of item object + /// Grabs the highlight of the item object. /// - /// the item object which is grabbed high light + /// The item object, which has grabbed the highlight. /// preview public static void GrabHighlight(this ItemObject obj) { @@ -35,9 +35,9 @@ namespace ElmSharp } /// - /// Clear high light of item object + /// Clears the highlight of the item object. /// - /// the item object which is cleared high light + /// The item object, which has cleared the highlight. /// preview public static void ClearHighlight(this ItemObject obj) { diff --git a/src/ElmSharp/ElmSharp/Label.cs b/src/ElmSharp/ElmSharp/Label.cs index bbde2f3..bcd8ef1 100755 --- a/src/ElmSharp/ElmSharp/Label.cs +++ b/src/ElmSharp/ElmSharp/Label.cs @@ -18,8 +18,8 @@ using System; namespace ElmSharp { /// - /// Label is a widget to display text, with simple html-like markup. - /// Inherits Layout + /// The Label is a widget to display text, with a simple HTML-like markup. + /// Inherits Layout. /// /// preview public class Label : Layout @@ -27,9 +27,9 @@ namespace ElmSharp SmartEvent _slideCompleted; /// - /// Creates and initializes a new instance of Label class. + /// Creates and initializes a new instance of the Label class. /// - /// The parent is a given container which will be attached by Label as a child. It's type. + /// The parent is a given container, which will be attached by the Label as a child. It's type. /// preview public Label(EvasObject parent) : base(parent) { @@ -47,7 +47,7 @@ namespace ElmSharp public event EventHandler SlideCompleted; /// - /// Sets or gets wrap width of the label. + /// Sets or gets the wrap width of the label. /// /// preview public int LineWrapWidth @@ -84,7 +84,7 @@ namespace ElmSharp } /// - /// Sets or gets the slide mode of the label widget. + /// Sets or gets the slide mode of the Label widget. /// /// preview public LabelSlideMode SlideMode @@ -116,11 +116,11 @@ namespace ElmSharp } /// - /// Sets or gets the slide Speed of the label. + /// Sets or gets the slide speed of the label. /// /// /// The speed of the slide animation in px per seconds. - /// If you set the duration of the slide using elm_label_slide_duration_set() you cannot get the correct speed using this function until the label is actually rendered and resized. + /// If you set the duration of the slide using elm_label_slide_duration_set(), you cannot get the correct speed using this function until the label is actually rendered and resized. /// /// /// preview @@ -156,7 +156,7 @@ namespace ElmSharp /// Sets or gets the style of the label text. /// /// - /// APIs, elm_label_text_style_user_peek/pop/push, are internal APIs only in Tizen. Avalilable since Tizen_4.0. + /// APIs, elm_label_text_style_user_peek/pop/push, are internal APIs only in Tizen. Available since Tizen_4.0. /// /// /// preview @@ -180,7 +180,7 @@ namespace ElmSharp } /// - /// Start slide effect. + /// Starts the slide effect. /// /// preview public void PlaySlide() @@ -192,7 +192,7 @@ namespace ElmSharp /// Sets the content at a part of a given container widget. /// /// EvasObject - /// The new object, otherwise null if it cannot be created + /// The new object, otherwise null if it cannot be created. /// preview protected override IntPtr CreateHandle(EvasObject parent) { @@ -201,21 +201,21 @@ namespace ElmSharp } /// - /// Enumeration for slide mode of a label widget + /// Enumeration for the slide modes of a label widget. /// /// preview public enum LabelSlideMode { /// - /// no slide effect + /// No slide effect. /// None = 0, /// - /// slide only if the label area is bigger than the text width length + /// Slide only if the label area is bigger than the text width length. /// Auto, /// - /// slide always + /// Slide always. /// Always } diff --git a/src/ElmSharp/ElmSharp/Layout.cs b/src/ElmSharp/ElmSharp/Layout.cs index af5ab10..b2c6f8e 100644 --- a/src/ElmSharp/ElmSharp/Layout.cs +++ b/src/ElmSharp/ElmSharp/Layout.cs @@ -19,8 +19,8 @@ using System; namespace ElmSharp { /// - /// This is a container widget that takes a standard Edje design file and wraps it very thinly in a widget. - /// Inherits Widget + /// This is a container widget that takes a standard edje design file and wraps it very thinly in a widget. + /// Inherits Widget. /// /// preview public class Layout : Container @@ -31,16 +31,16 @@ namespace ElmSharp IntPtr _edjeHandle; /// - /// Creates and initializes a new instance of Layout class. + /// Creates and initializes a new instance of the Layout class. /// - /// The parent is a given container which will be attached by Layout as a child. It's type. + /// The parent is a given container, which will be attached by the layout as a child. It's type. /// preview public Layout(EvasObject parent) : base(parent) { } /// - /// Creates and initializes a new instance of Layout class. + /// Creates and initializes a new instance of the Layout class. /// /// preview protected Layout() : base() @@ -74,7 +74,7 @@ namespace ElmSharp } /// - /// Gets or sets accessibility state of texblock(text) parts in the layout object. + /// Gets or sets the accessibility state of texblock (text) parts in a layout object. /// /// preview public bool TextBlockAccessibility @@ -91,10 +91,10 @@ namespace ElmSharp /// /// Freezes the Elementary layout object. - /// This function puts all changes on hold. + /// This function puts all the changes on hold. /// Successive freezes will nest, requiring an equal number of thaws. /// - /// The frozen state or 0 if the object is not frozen or on error. + /// The frozen state, or 0 if the object is not frozen or on error. /// preview public int Freeze() { @@ -105,7 +105,7 @@ namespace ElmSharp /// Thaws the Elementary object. /// If sucessives freezes were done, an equal number of thaws will be required. /// - /// The frozen state or 0 if the object is not frozen or on error. + /// The frozen state, or 0 if the object is not frozen or on error. /// preview public int Thaw() { @@ -117,7 +117,7 @@ namespace ElmSharp /// Manually forces a sizing re-evaluation. /// This is useful when the minimum size required by the edje theme of this layout has changed. /// The change on the minimum size required by the edje theme is not immediately reported to the elementary layout, so one needs to call this function in order to tell the widget (layout) that it needs to reevaluate its own size. - /// The minimum size of the theme is calculated based on minimum size of parts, the size of elements inside containers like box and table, etc. + /// The minimum size of the theme is calculated based on the minimum size of parts, the size of elements inside containers like the box and table, etc. /// All of this can change due to state changes, and that's when this function should be called. /// /// preview @@ -127,11 +127,11 @@ namespace ElmSharp } /// - /// Request sizing reevaluation, restricted to current width and/or height. - /// Useful mostly when there are TEXTBLOCK parts defining the height of the object and nothing else restricting it to a minimum width.Calling this function will restrict the minimum size in the Edje calculation to whatever size it the layout has at the moment. + /// Requests sizing re-evaluation, restricted to the current width and/or height. + /// Useful mostly when there are TEXTBLOCK parts defining the height of an object and nothing else, restricting it to a minimum width. Calling this function will restrict minimum size in the Edje calculation to whatever size the layout has at the moment. /// - /// Restrict minimum size ot the current width. - /// Restrict minimum size ot the current height. + /// Restrict minimum size of the current width. + /// Restrict minimum size of the current height. /// preview public void Resizing(bool width, bool height) { @@ -139,12 +139,12 @@ namespace ElmSharp } /// - /// Get the edje data from the given layout. - /// This function fetches data specified inside the edje theme of this layout. - /// This function return NULL if data is not found. + /// Gets the edje data from the given layout. + /// This function fetches the data specified inside the edje theme of this layout. + /// This function returns null if the data is not found. /// - /// The data key - /// The data + /// The data key. + /// The data. /// preview public string GetEdjeData(string key) { @@ -154,7 +154,7 @@ namespace ElmSharp /// /// Gets the text set in the given part. /// - /// The TEXT part to retrieve the text off. + /// The text part to retrieve the text off. /// /// preview public override string GetPartText(string part) @@ -165,7 +165,7 @@ namespace ElmSharp /// /// Sets the text set in the given part. /// - /// The TEXT part to retrieve the text off. + /// The text part to retrieve the text off. /// The text to set. /// /// preview @@ -175,13 +175,13 @@ namespace ElmSharp } /// - /// Append child to layout box part. - /// Once the object is appended, it will become child of the layout. - /// Its lifetime will be bound to the layout, whenever the layout dies the child will be deleted automatically. + /// Appends a child to the layout box part. + /// Once the object is appended, it will become a child of the layout. + /// Its lifetime will be bound to the layout. Whenever the layout dies, the child will be deleted automatically. /// - /// The part - /// The Object to append - /// Sucess is true + /// The part. + /// The object to append. + /// Success is true. /// preview public bool BoxAppend(string part, EvasObject child) { @@ -190,13 +190,13 @@ namespace ElmSharp } /// - /// Prepend child to layout box part. - /// Once the object is prepended, it will become child of the layout. - /// Its lifetime will be bound to the layout, whenever the layout dies the child will be deleted automatically. + /// Prepends a child to the layout box part. + /// Once the object is prepended, it will become a child of the layout. + /// Its lifetime will be bound to the layout. Whenever the layout dies, the child will be deleted automatically. /// - /// The part - /// The Object to prepend - /// Sucess is true + /// The part. + /// The object to prepend. + /// Success is true. /// preview public bool BoxPrepend(string part, EvasObject child) { @@ -205,12 +205,12 @@ namespace ElmSharp } /// - /// Remove a child of the given part box. + /// Removes a child from the given part box. /// The object will be removed from the box part and its lifetime will not be handled by the layout anymore. /// - /// The part - /// The Object to remove - /// Sucess is true + /// The part. + /// The object to remove. + /// Success if true /// preview public bool BoxRemove(string part, EvasObject child) { @@ -219,12 +219,12 @@ namespace ElmSharp } /// - /// Remove all children of the given part box. + /// Removes all the children from the given part box. /// The objects will be removed from the box part and their lifetime will not be handled by the layout anymore. /// - /// The part - /// If true, then all objects will be deleted as well, otherwise they will just be removed and will be dangling on the canvas. - /// Sucess is true + /// The part. + /// If true, then all the objects will be deleted as well, otherwise they will just be removed and will be dangling on the canvas. + /// Success if true. /// preview public bool BoxRemoveAll(string part, bool clear) { @@ -233,14 +233,14 @@ namespace ElmSharp } /// - /// Insert child to layout box part at a given position. - /// Once the object is inserted, it will become child of the layout. - /// Its lifetime will be bound to the layout, whenever the layout dies the child will be deleted automatically. + /// Inserts a child to the layout box part at a given position. + /// Once the object is inserted, it will become a child of the layout. + /// Its lifetime will be bound to the layout. Whenever the layout dies, the child will be deleted automatically. /// - /// The part - /// The child object to insert into box. + /// The part. + /// The child object to insert into the box. /// The numeric position >=0 to insert the child. - /// Sucess is true + /// Success if true. /// preview public bool BoxInsertAt(string part, EvasObject child, uint position) { @@ -249,14 +249,14 @@ namespace ElmSharp } /// - /// Insert child to layout box part before a reference object. + /// Inserts a child to the layout box part before a reference object. /// Once the object is inserted, it will become child of the layout. - /// Its lifetime will be bound to the layout, whenever the layout dies the child will be deleted automatically. + /// Its lifetime will be bound to the layout. Whenever the layout dies, the child will be deleted automatically. /// - /// - /// The child object to insert into box. - /// Another reference object to insert before in box. - /// Sucess is true + /// The part. + /// The child object to insert into the box. + /// Another reference object to insert before the box. + /// Success is true. /// preview public bool BoxInsertBefore(string part, EvasObject child, EvasObject reference) { @@ -267,9 +267,9 @@ namespace ElmSharp /// /// Sets the layout content. /// - /// The swallow part name in the edje file + /// The swallow part name in the edje file. /// The child that will be added in this layout object. - /// TRUE on success, FALSE otherwise + /// TRUE on success, FALSE otherwise. /// preview public override bool SetPartContent(string part, EvasObject content) { @@ -279,10 +279,10 @@ namespace ElmSharp /// /// Sets the layout content. /// - /// The name of particular part - /// The content + /// The name of a particular part. + /// The content. /// true, preserve old content will be unset. false, preserve old content will not be unset. - /// TRUE on success, FALSE otherwise + /// TRUE on success, FALSE otherwise. /// preview public override bool SetPartContent(string part, EvasObject content, bool preserveOldContent) { @@ -297,9 +297,9 @@ namespace ElmSharp /// /// Sets the edje group from the elementary theme that is used as a layout. /// - /// The class of the group - /// The group - /// The style to use + /// The class of the group. + /// The group. + /// The style to use. /// preview public void SetTheme(string klass, string group, string style) { @@ -309,8 +309,8 @@ namespace ElmSharp /// /// Sets the file that is used as a layout. /// - /// The path to the file (edj) that is used as a layout - /// The group that the layout belongs to in the edje file + /// The path to the file (edje) that is used as a layout. + /// The group that the layout belongs to in the edje file. /// preview public void SetFile(string file, string group) { @@ -318,7 +318,7 @@ namespace ElmSharp } /// - /// Sets the back ground color of layout + /// Sets the background color of a layout. /// /// preview public override Color BackgroundColor @@ -339,10 +339,10 @@ namespace ElmSharp } /// - /// Sets the vertical text alignment of layout's text part + /// Sets the vertical text alignment of the layout's text part. /// /// - /// API, elm_layout_text_valign_set, is an internal API only in Tizen. Avalilable since Tizen_4.0. + /// API, elm_layout_text_valign_set, is an internal API only in Tizen. Available since Tizen_4.0. /// /// preview public virtual void SetVerticalTextAlignment(string part, double valign) @@ -351,10 +351,10 @@ namespace ElmSharp } /// - /// Gets the vertical text alignment of layout's text part + /// Gets the vertical text alignment of the layout's text part. /// /// - /// API, elm_layout_text_valign_get, is internal API only in Tizen. Avalilable since Tizen_4.0. + /// API, elm_layout_text_valign_get, is an internal API only in Tizen. Available since Tizen_4.0. /// /// preview public virtual double GetVerticalTextAlignment(string part) @@ -363,7 +363,7 @@ namespace ElmSharp } /// - /// The callback of Realized Event + /// The callback of the Realized Event. /// /// preview protected override void OnRealized() @@ -385,8 +385,8 @@ namespace ElmSharp /// /// Sets the content at a part of a given container widget. /// - /// The parent is a given container which will be attached by Layout as a child. It's type. - /// The new object, otherwise null if it cannot be created + /// The parent is a given container which will be attached by the layout as a child. It's type. + /// The new object, otherwise null if it cannot be created. /// preview protected override IntPtr CreateHandle(EvasObject parent) { diff --git a/src/ElmSharp/ElmSharp/List.cs b/src/ElmSharp/ElmSharp/List.cs index afd3473..be147b7 100755 --- a/src/ElmSharp/ElmSharp/List.cs +++ b/src/ElmSharp/ElmSharp/List.cs @@ -20,7 +20,7 @@ using System.Collections.Generic; namespace ElmSharp { /// - /// Enumeration for setting list's resizing behavior, transverse axis scrolling and items cropping. + /// Enumeration for setting the list's resizing behavior, transverse axis scrolling, and items cropping. /// /// preview public enum ListMode @@ -28,7 +28,7 @@ namespace ElmSharp /// /// The list won't set any of its size hints to inform how a possible container should resize it. /// Then, if it's not created as a "resize object", it might end with zeroed dimensions. - /// The list will respect the container's geometry and, if any of its items won't fit into its transverse axis, one won't be able to scroll it in that direction. + /// The list will respect the container's geometry, and if any of its items won't fit into its transverse axis, one won't be able to scroll it in that direction. /// Compress = 0, /// @@ -36,13 +36,13 @@ namespace ElmSharp /// Scroll, /// - /// Sets a minimum size hint on the genlist object, so that containers may respect it (and resize itself to fit the child properly). + /// Sets a minimum size hint on the genlist object, so that the containers may respect it (and resize itself to fit the child properly). /// More specifically, a minimum size hint will be set for its transverse axis, so that the largest item in that direction fits well. /// This is naturally bound by the list object's maximum size hints, set externally. /// Limit, /// - /// Besides setting a minimum size on the transverse axis, just like on Limit, the list will set a minimum size on th longitudinal axis, trying to reserve space to all its children to be visible at a time. + /// Besides setting a minimum size on the transverse axis, just like on limit, the list will set a minimum size on the longitudinal axis, trying to reserve space to all its children to be visible at a time. /// This is naturally bound by the list object's maximum size hints, set externally. /// Expand @@ -50,14 +50,14 @@ namespace ElmSharp /// /// It inherits System.EventArgs. - /// It contains Item which is type. - /// All events of List contain ListItemEventArgs as a parameter. + /// It contains an item which is type. + /// All the events of a list contain ListItemEventArgs as a parameter. /// /// preview public class ListItemEventArgs : EventArgs { /// - /// Gets or sets List item. The return type is . + /// Gets or sets the list item. The return type is . /// /// preview public ListItem Item { get; set; } @@ -71,7 +71,7 @@ namespace ElmSharp /// /// It inherits . - /// The List is a widget that aims to display simple list item which has 2 icons and 1 text, and can be selected. + /// The List is a widget that aims to display a simple list item which has 2 icons, 1 text, and can be selected. /// For more robust lists, should probably be used. /// /// @@ -89,7 +89,7 @@ namespace ElmSharp /// /// Creates and initializes a new instance of the List class. /// - /// The parent is a given container which will be attached by List as a child. It's type. + /// The parent is a given container, which will be attached by the list as a child. It's type. /// preview public List(EvasObject parent) : base(parent) { @@ -106,7 +106,7 @@ namespace ElmSharp } /// - /// Gets or sets which mode to use for the list. + /// Gets or sets which mode to be used for the list. /// /// preview public ListMode Mode @@ -141,32 +141,32 @@ namespace ElmSharp public event EventHandler ItemSelected; /// - /// ItemUnselected is raised when the list item is Unselected. + /// ItemUnselected is raised when a list item is Unselected. /// /// preview public event EventHandler ItemUnselected; /// - /// ItemDoubleClicked is raised when a new list item is double clicked. + /// ItemDoubleClicked is raised when a new list item is double-clicked. /// /// preview public event EventHandler ItemDoubleClicked; /// - /// ItemLongPressed is raised when a list item is pressed for a certain amount of time. By default it's 1 second. + /// ItemLongPressed is raised when a list item is pressed for a certain amount of time. By default, it's 1 second. /// /// preview public event EventHandler ItemLongPressed; /// - /// ItemActivated is raised when a new list item is double clicked or pressed (enter|return|spacebar). + /// ItemActivated is raised when a new list item is double-clicked or pressed (enter|return|spacebar). /// /// preview public event EventHandler ItemActivated; /// /// Starts the list. - /// Call before running on the list object. + /// Called before running on the list object. /// If not called, it won't display the list properly. /// /// preview @@ -232,7 +232,7 @@ namespace ElmSharp } /// - /// Removes all items from a given list widget. + /// Removes all the items from a given list widget. /// To delete just one item, use . /// /// preview @@ -249,8 +249,8 @@ namespace ElmSharp /// /// Creates a widget handle. /// - /// Parent EvasObject - /// Handle IntPtr + /// Parent EvasObject. + /// Handle IntPtr. /// preview protected override IntPtr CreateHandle(EvasObject parent) { diff --git a/src/ElmSharp/ElmSharp/ListItem.cs b/src/ElmSharp/ElmSharp/ListItem.cs index 8c5a594..00b5c62 100644 --- a/src/ElmSharp/ElmSharp/ListItem.cs +++ b/src/ElmSharp/ElmSharp/ListItem.cs @@ -20,8 +20,8 @@ namespace ElmSharp { /// /// It inherits . - /// A instance to the list item added. - /// It contains Text, LeftIcon and RightIcon properties to show a list item which is given. + /// An instance to the list item is added. + /// It contains the Text, LeftIcon, and RightIcon properties to show the list item which is given. /// /// preview public class ListItem : ItemObject diff --git a/src/ElmSharp/ElmSharp/MultiButtonEntry.cs b/src/ElmSharp/ElmSharp/MultiButtonEntry.cs index 1a3185d..571f3f8 100755 --- a/src/ElmSharp/ElmSharp/MultiButtonEntry.cs +++ b/src/ElmSharp/ElmSharp/MultiButtonEntry.cs @@ -21,7 +21,7 @@ namespace ElmSharp { /// /// It inherits . - /// The MultiButtonEntry is a widget letting an user enter text and each chunk of text managed as a set of buttons. + /// The MultiButtonEntry is a widget, that lets a user enter text and each chunk of the text managed as a set of buttons. /// Each text button is inserted by pressing the "return" key. If there is no space in the current row, a new button is added to the next row. /// When a text button is pressed, it will become focused. Backspace removes the focus. When the multi-button entry loses focus, items longer than one line are shrunk to one line. /// The typical use case of multi-button entry is composing emails/messages to a group of addresses, each of which is an item that can be clicked for further actions. @@ -49,7 +49,7 @@ namespace ElmSharp /// /// Creates and initializes a new instance of the MultiButtonEntry class. /// - /// The parent is a given container which will be attached by MultiButtonEntry as a child. It's type. + /// The parent is a given container, which will be attached by the MultiButtonEntry as a child. It's type. /// preview public MultiButtonEntry(EvasObject parent) : base(parent) { @@ -102,8 +102,8 @@ namespace ElmSharp public event EventHandler ExpandedStateChanged; /// - /// ItemSelected is raised when an item is selected by api, user interaction, and etc. - /// This is also raised when a user press back space while cursor is on the first field of entry. + /// ItemSelected is raised when an item is selected by API, user interaction, and etc. + /// This is also raised when a user presses backspace, while the cursor is on the first field of the entry. /// /// preview public event EventHandler ItemSelected; @@ -133,7 +133,7 @@ namespace ElmSharp public event EventHandler ItemDeleted; /// - /// Gets the selected item in the multibuttonentry. + /// Gets the selected item in the MultiButtonEntry. /// /// preview public MultiButtonEntryItem SelectedItem @@ -146,7 +146,7 @@ namespace ElmSharp } /// - /// Gets or sets whether the multibuttonentry is editable or not. + /// Gets or sets whether the MultiButtonEntry is editable or not. /// /// preview public bool IsEditable @@ -162,7 +162,7 @@ namespace ElmSharp } /// - /// Gets or sets the multibuttonentry to expanded state. + /// Gets or sets the MultiButtonEntry to expanded state. /// If true, expanded state. /// If false, single line state. /// @@ -180,7 +180,7 @@ namespace ElmSharp } /// - /// Gets the first item in the multibuttonentry. + /// Gets the first item in the MultiButtonEntry. /// /// preview public MultiButtonEntryItem FirstItem @@ -193,7 +193,7 @@ namespace ElmSharp } /// - /// Gets the last item in the multibuttonentry. + /// Gets the last item in the MultiButtonEntry. /// /// preview public MultiButtonEntryItem LastItem @@ -206,7 +206,7 @@ namespace ElmSharp } /// - /// Gets the entry object int the multibuttonentry. + /// Gets the entry object int the MultiButtonEntry. /// /// preview public Entry Entry @@ -225,8 +225,8 @@ namespace ElmSharp /// /// Creates a widget handle. /// - /// Parent EvasObject - /// Handle IntPtr + /// Parent EvasObject. + /// Handle IntPtr. /// preview protected override IntPtr CreateHandle(EvasObject parent) { @@ -234,9 +234,9 @@ namespace ElmSharp } /// - /// Append a new item to the multibuttonentry. + /// Appends a new item to the multibuttonentry. /// - /// The label of new item. + /// The label of the new item. /// A MultiButtonEntryItem to the item added. /// preview public MultiButtonEntryItem Append(string label) @@ -247,9 +247,9 @@ namespace ElmSharp } /// - /// Prepend a new item to the multibuttonentry. + /// Prepends a new item to the MultiButtonEntry. /// - /// The label of new item. + /// The label of the new item. /// A MultiButtonEntryItem to the item added. /// preview public MultiButtonEntryItem Prepend(string label) @@ -260,7 +260,7 @@ namespace ElmSharp } /// - /// Add a new item to the multibuttonentry before the indicated object reference. + /// Adds a new item to the MultiButtonEntry before the indicated object reference. /// /// The item before which to add it. /// The label of new item. @@ -274,7 +274,7 @@ namespace ElmSharp } /// - /// Add a new item to the multibuttonentry after the indicated object. + /// Adds a new item to the MultiButtonEntry after the indicated object. /// /// The item after which to add it. /// The label of new item. @@ -288,7 +288,7 @@ namespace ElmSharp } /// - /// Remove all items in the multibuttonentry. + /// Removes all items in the MultiButtonEntry. /// /// preview public void Clear() @@ -302,7 +302,7 @@ namespace ElmSharp } /// - /// Append an item filter function for text inserted in the Multibuttonentry. + /// Appends an item filter function for the text inserted in the multibuttonentry. /// /// The function to use as item filter. /// preview @@ -316,7 +316,7 @@ namespace ElmSharp } /// - /// Prepend a filter function for text inserted in the Multibuttonentry. + /// Prepends a filter function for the text inserted in the MultiButtonEntry. /// /// The function to use as text filter. /// preview @@ -330,7 +330,7 @@ namespace ElmSharp } /// - /// Remove a filter from the list. + /// Removes a filter from the list. /// /// The filter function to remove. /// preview @@ -344,10 +344,10 @@ namespace ElmSharp } /// - /// Set a function to format the string that will be used to display the hidden items counter. + /// Sets a function to format the string that will be used to display the hidden items counter. /// If func is NULL, the default format will be used, which is "+ 'the hidden items counter'". /// - /// The function to return string to show + /// The function to return string to show. /// preview public void SetFormatCallback(Func func) { @@ -400,7 +400,7 @@ namespace ElmSharp /// /// Creates and initializes a new instance of the EntryInner class. /// - /// The parent is a given container which will be attached by MultiButtonEntry as a child. It's type. + /// The parent is a given container, which will be attached by the MultiButtonEntry as a child. It's type. internal EntryInner(EvasObject parent) : base(parent) { } @@ -408,8 +408,8 @@ namespace ElmSharp /// /// Creates a widget handle. /// - /// Parent EvasObject - /// Handle IntPtr + /// Parent EvasObject. + /// Handle IntPtr. protected override IntPtr CreateHandle(EvasObject parent) { return Interop.Elementary.elm_multibuttonentry_entry_get(parent.Handle); @@ -420,13 +420,13 @@ namespace ElmSharp /// /// It inherits System.EventArgs. /// The MultiButtonEntryItemEventArgs is a argument for all events of MultiButtonEntry. - /// It contains Item which is type. + /// It contains the Item which is type. /// /// preview public class MultiButtonEntryItemEventArgs : EventArgs { /// - /// Gets or sets MultiButtonEntryItem item. The return type is . + /// Gets or sets the MultiButtonEntryItem item. The return type is . /// /// preview public MultiButtonEntryItem Item { get; set; } diff --git a/src/ElmSharp/ElmSharp/MultiButtonEntryItem.cs b/src/ElmSharp/ElmSharp/MultiButtonEntryItem.cs index 4ddd090..1337f58 100755 --- a/src/ElmSharp/ElmSharp/MultiButtonEntryItem.cs +++ b/src/ElmSharp/ElmSharp/MultiButtonEntryItem.cs @@ -20,8 +20,8 @@ namespace ElmSharp { /// /// It inherits . - /// MutltiButtonEntryItem is a item which is added to MultiButtonEntry. - /// It contains Next and Prev properties to get next and previous item. + /// MutltiButtonEntryItem is an item, which is added to MultiButtonEntry. + /// It contains Next and Prev properties to get the next and previous item. /// /// preview public class MultiButtonEntryItem : ItemObject @@ -29,7 +29,7 @@ namespace ElmSharp /// /// Creates and initializes a new instance of the MultiButtonEntryItem class. /// - /// The text of MultiButtonEntryItem's Label name. + /// The text of the MultiButtonEntryItem's label name. /// preview public MultiButtonEntryItem(string text) : base(IntPtr.Zero) { @@ -64,7 +64,7 @@ namespace ElmSharp } /// - /// Get the next item in the multibuttonentry. + /// Get the next item in the MultiButtonEntry. /// /// preview public MultiButtonEntryItem Next @@ -77,7 +77,7 @@ namespace ElmSharp } /// - /// Get the previous item in the multibuttonentry. + /// Get the previous item in the MultiButtonEntry. /// /// preview public MultiButtonEntryItem Prev diff --git a/src/ElmSharp/ElmSharp/NamedHint.cs b/src/ElmSharp/ElmSharp/NamedHint.cs index ee00a4c..5468810 100644 --- a/src/ElmSharp/ElmSharp/NamedHint.cs +++ b/src/ElmSharp/ElmSharp/NamedHint.cs @@ -17,19 +17,19 @@ namespace ElmSharp { /// - /// Predefined values for Hints properties in EvasObject + /// Predefined values for the hint properties in EvasObject. /// /// preview public static class NamedHint { /// - /// This value can be used to and + /// This value can be used for and . /// /// preview public static double Expand = 1.0; /// - /// This value can be used to and + /// This value can be used for and . /// /// preview public static double Fill = -1.0; diff --git a/src/ElmSharp/ElmSharp/NaviItem.cs b/src/ElmSharp/ElmSharp/NaviItem.cs index 602c6be..179e721 100644 --- a/src/ElmSharp/ElmSharp/NaviItem.cs +++ b/src/ElmSharp/ElmSharp/NaviItem.cs @@ -19,7 +19,7 @@ using System; namespace ElmSharp { /// - /// The NaviItem is a widget to contain the contents to show in Naviframe. + /// The NaviItem is a widget that contain the contents to show in Naviframe. /// Inherits ItemObject /// /// preview @@ -50,7 +50,7 @@ namespace ElmSharp public event EventHandler Popped; /// - /// Gets the content object. The name of content part is "elm.swallow.content". + /// Gets the content object. The name of the content part is "elm.swallow.content". /// /// preview public EvasObject Content @@ -59,7 +59,7 @@ namespace ElmSharp } /// - /// Sets or gets a value whether title area is enabled or not. + /// Sets or gets a value whether the title area is enabled or not. /// /// preview public bool TitleBarVisible @@ -75,7 +75,7 @@ namespace ElmSharp } /// - /// Sets or gets the title bar background color + /// Sets or gets the title bar background color. /// /// preview public Color TitleBarBackgroundColor @@ -115,8 +115,8 @@ namespace ElmSharp } /// - /// Invalidate the EventArgs if _isPopped is false. - /// The method should be overridden in children class. + /// Invalidates the EventArgs if _isPopped is false. + /// The method should be overridden in the children class. /// /// preview protected override void OnInvalidate() diff --git a/src/ElmSharp/ElmSharp/Naviframe.cs b/src/ElmSharp/ElmSharp/Naviframe.cs index b7389c9..a3f0ef2 100755 --- a/src/ElmSharp/ElmSharp/Naviframe.cs +++ b/src/ElmSharp/ElmSharp/Naviframe.cs @@ -20,21 +20,21 @@ using System.Collections.Generic; namespace ElmSharp { /// - /// The NaviframeEventArgs is a event args class for navi frame. - /// Inherits EventArgs + /// The NaviframeEventArgs is an event arguments class for naviframe. + /// Inherits EventArgs. /// /// preview public class NaviframeEventArgs : EventArgs { /// - /// Sets or gets the content object. The name of content part is "elm.swallow.content". + /// Sets or gets the content object. The name of the content part is "elm.swallow.content". /// /// preview public EvasObject Content { get; set; } } /// - /// Naviframe is a widget to stands for navigation frame. It's a views manager for applications. - /// Inherits Widget + /// The Naviframe is a widget to stand for the navigation frame. It's a views manager for applications. + /// Inherits Widget. /// /// preview public class Naviframe : Widget @@ -43,7 +43,7 @@ namespace ElmSharp readonly List _itemStack = new List(); /// - /// Creates and initializes a new instance of Naviframe class. + /// Creates and initializes a new instance of the Naviframe class. /// /// The parent is a given container which will be attached by Naviframe as a child. It's type. /// preview @@ -54,25 +54,25 @@ namespace ElmSharp } /// - /// Popped will be triggered when NaviItem is removed. + /// Popped will be triggered when the NaviItem is removed. /// /// - /// It is always called when NaviItem was removed. + /// It is always called when the NaviItem is removed. /// (even if removed by NaviItem.Delete()) - /// This event will be invoked in progress of Pop/Delete operation. - /// After called Popped event, Pop/Delete method will be returned + /// This event will be invoked in progress of the Pop/Delete operation. + /// After calling the Popped event, the Pop/Delete method will be returned. /// /// preview public event EventHandler Popped; /// - /// AnimationFinished will be triggered when animation is finished. + /// AnimationFinished will be triggered when the animation is finished. /// /// preview public event EventHandler AnimationFinished; /// - /// Gets the list of navi item + /// Gets the list of the navi item. /// /// preview public IReadOnlyList NavigationStack @@ -81,7 +81,7 @@ namespace ElmSharp } /// - /// Sets or gets the the preserve content objects when items are popped. + /// Sets or gets the preserve content objects when items are popped. /// /// preview public bool PreserveContentOnPop @@ -97,7 +97,7 @@ namespace ElmSharp } /// - /// Sets or gets whether the default back button is enabled + /// Sets or gets whether the default back button is enabled. /// /// preview public bool DefaultBackButtonEnabled @@ -113,11 +113,11 @@ namespace ElmSharp } /// - /// Push a new item to the top of the naviframe stack and show it. + /// Pushes a new item to the top of the naviframe stack and shows it. /// The title and style are null. /// - /// The main content object. The name of content part is "elm.swallow.content". - /// The created item or null upon failure. + /// The main content object. The name of the content part is "elm.swallow.content". + /// The created item, or null upon failure. /// preview public NaviItem Push(EvasObject content) { @@ -125,11 +125,11 @@ namespace ElmSharp } /// - /// Push a new item to the top of the naviframe stack and show it. - /// The style are null. + /// Pushes a new item to the top of the naviframe stack and shows it. + /// The style is null. /// - /// The main content object. The name of content part is "elm.swallow.content". - /// The current item title. null would be default. + /// The main content object. The name of the content part is "elm.swallow.content". + /// The current item title. Null would be default. /// /// preview public NaviItem Push(EvasObject content, string title) @@ -138,12 +138,12 @@ namespace ElmSharp } /// - /// Push a new item to the top of the naviframe stack and show it. + /// Pushes a new item to the top of the naviframe stack and shows it. /// - /// The main content object. The name of content part is "elm.swallow.content". - /// The current item title. null would be default. - /// The current item style name. null would be default. - /// The created item or null upon failure. + /// The main content object. The name of the content part is "elm.swallow.content". + /// The current item title. Null would be default. + /// The current item style name. Null would be default. + /// The created item, or null upon failure. /// preview public NaviItem Push(EvasObject content, string title, string style) { @@ -155,12 +155,12 @@ namespace ElmSharp } /// - /// Insert a new item into the naviframe before item. + /// Inserts a new item into the naviframe before the item. /// The title is "" and the style is null. /// - /// The item which the new item is inserted before. - /// The main content object. The name of content part is "elm.swallow.content". - /// The created item or null upon failure. + /// The item for which a new item is inserted before. + /// The main content object. The name of the content part is "elm.swallow.content". + /// The created item, or null upon failure. /// preview public NaviItem InsertBefore(NaviItem before, EvasObject content) { @@ -168,13 +168,13 @@ namespace ElmSharp } /// - /// Insert a new item into the naviframe before item. + /// Inserts a new item into the naviframe before the item. /// The style is null. /// - /// The item which the new item is inserted before. - /// The main content object. The name of content part is "elm.swallow.content". - /// The current item title. null would be default. - /// The created item or null upon failure. + /// The item for which a new item is inserted before. + /// The main content object. The name of the content part is "elm.swallow.content". + /// The current item title. Null would be default. + /// The created item, or null upon failure. /// preview public NaviItem InsertBefore(NaviItem before, EvasObject content, string title) { @@ -182,13 +182,13 @@ namespace ElmSharp } /// - /// Insert a new item into the naviframe before item. + /// Inserts a new item into the naviframe before the item. /// - /// The item which the new item is inserted before. - /// The main content object. The name of content part is "elm.swallow.content". - /// The current item title. null would be default. - /// The current item style name. null would be default. - /// The created item or null upon failure. + /// The item for which a new item is inserted before. + /// The main content object. The name of the content part is "elm.swallow.content". + /// The current item title. Null would be default. + /// The current item style name. Null would be default. + /// The created item, or null upon failure. /// preview public NaviItem InsertBefore(NaviItem before, EvasObject content, string title, string style) { @@ -201,12 +201,12 @@ namespace ElmSharp } /// - /// Insert a new item into the naviframe after item. + /// Inserts a new item into the naviframe after the item. /// The title is "" and the style is null. /// - /// The item which the new item is inserted after. - /// The main content object. The name of content part is "elm.swallow.content". - /// The created item or null upon failure. + /// The item for which a new item is inserted after. + /// The main content object. The name of the content part is "elm.swallow.content". + /// The created item, or null upon failure. /// preview public NaviItem InsertAfter(NaviItem after, EvasObject content) { @@ -214,13 +214,13 @@ namespace ElmSharp } /// - /// Insert a new item into the naviframe after item. + /// Inserts a new item into the naviframe after the item. /// The style is null. /// - /// The item which the new item is inserted after. - /// The main content object. The name of content part is "elm.swallow.content". - /// The current item title. null would be default. - /// The created item or null upon failure. + /// The item which a new item is inserted after. + /// The main content object. The name of the content part is "elm.swallow.content". + /// The current item title. Null would be default. + /// The created item, or null upon failure. /// preview public NaviItem InsertAfter(NaviItem after, EvasObject content, string title) { @@ -228,13 +228,13 @@ namespace ElmSharp } /// - /// Insert a new item into the naviframe after item. + /// Inserts a new item into the naviframe after the item. /// - /// The item which the new item is inserted after. - /// The main content object. The name of content part is "elm.swallow.content". - /// The current item title. null would be default. - /// The current item style name. null would be default. - /// The created item or null upon failure. + /// The item for which a new item is inserted after. + /// The main content object. The name of the content part is "elm.swallow.content". + /// The current item title. Null would be default. + /// The current item style name. Null would be default. + /// The created item, or null upon failure. /// preview public NaviItem InsertAfter(NaviItem after, EvasObject content, string title, string style) { @@ -247,7 +247,7 @@ namespace ElmSharp } /// - /// Pop an item that is on top of the stack. + /// Pops an item that is on top of the stack. /// /// preview public void Pop() @@ -258,8 +258,8 @@ namespace ElmSharp /// /// Creates a widget handle. /// - /// Parent EvasObject - /// Handle IntPtr + /// Parent EvasObject. + /// Handle IntPtr. /// preview protected override IntPtr CreateHandle(EvasObject parent) { diff --git a/src/ElmSharp/ElmSharp/Panel.cs b/src/ElmSharp/ElmSharp/Panel.cs index 30b0e6c..da1db4c 100755 --- a/src/ElmSharp/ElmSharp/Panel.cs +++ b/src/ElmSharp/ElmSharp/Panel.cs @@ -19,25 +19,25 @@ using System; namespace ElmSharp { /// - /// Enumeration for paneldirection type. + /// Enumeration for the PanelDirection types. /// /// preview public enum PanelDirection { /// - /// Top to bottom + /// Top to bottom. /// Top = 0, /// - /// Bottom to top + /// Bottom to top. /// Bottom, /// - /// Left to right + /// Left to right. /// Left, /// - /// Right to left + /// Right to left. /// Right, } @@ -51,9 +51,9 @@ namespace ElmSharp SmartEvent _toggled; /// - /// Creates and initializes a new instance of Panel class. + /// Creates and initializes a new instance of the Panel class. /// - /// The EvasObject to which the new Panel will be attached as a child. + /// The EvasObject to which the new panel will be attached as a child. /// preview public Panel(EvasObject parent) : base(parent) { @@ -94,13 +94,13 @@ namespace ElmSharp } /// - /// Toggled will be triggered when toggles Panel. + /// Toggled will be triggered when the panel is toggled. /// /// preview public event EventHandler Toggled; /// - /// Enable or disable scrolling in the Panel. + /// Enable or disable scrolling in the panel. /// /// /// Bool value can be false or true. @@ -112,10 +112,10 @@ namespace ElmSharp } /// - /// Sets the scroll size of Panel. + /// Sets the scroll size of the panel. /// /// - /// The size of scroll area. + /// The size of the scroll area. /// /// preview public void SetScrollableArea(double ratio) @@ -124,7 +124,7 @@ namespace ElmSharp } /// - /// Toggles the hidden state of the Panel. + /// Toggles the hidden state of the panel. /// /// preview public void Toggle() @@ -135,8 +135,8 @@ namespace ElmSharp /// /// Creates a widget handle. /// - /// Parent EvasObject - /// Handle IntPtr + /// Parent EvasObject. + /// Handle IntPtr. /// preview protected override IntPtr CreateHandle(EvasObject parent) { diff --git a/src/ElmSharp/ElmSharp/Panes.cs b/src/ElmSharp/ElmSharp/Panes.cs index be4a703..ac0b851 100755 --- a/src/ElmSharp/ElmSharp/Panes.cs +++ b/src/ElmSharp/ElmSharp/Panes.cs @@ -20,7 +20,7 @@ namespace ElmSharp { /// /// The Panes is a widget that adds a draggable bar between two contents. - /// When dragged this bar resizes contents' size. + /// When dragged, this bar resizes the contents' size. /// /// preview public class Panes : Layout @@ -43,19 +43,19 @@ namespace ElmSharp } /// - /// Pressed will be triggered when panes have been pressed (button isn't released yet). + /// Pressed will be triggered when the panes have been pressed (button isn't released yet). /// /// preview public event EventHandler Pressed; /// - /// Unpressed will be triggered when panes are released after being pressed. + /// Unpressed will be triggered when the panes are released after being pressed. /// /// preview public event EventHandler Unpressed; /// - /// Sets or gets resize mode of a given Panes widget. + /// Sets or gets the resize mode of a given Panes widget. /// True means the left and right panes resize homogeneously. /// /// preview @@ -72,16 +72,16 @@ namespace ElmSharp } /// - /// Sets or Gets the size proportion of the Panes widget's left side. + /// Sets or gets the size proportion of the Panes widget's left side. /// /// - /// By default it's homogeneous, i.e., both sides have the same size.If something different is required, + /// By default, it's homogeneous, i.e., both sides have the same size. If something different is required, /// it can be set with this function. For example, if the left content should be displayed over 75% of the panes size, - /// size should be passed as 0.75. This way, the right content is resized to 25% of the panes size. - /// If displayed vertically, left content is displayed at the top, and right content at the bottom. + /// the size should be passed as 0.75. This way, the right content is resized to 25% of the panes size. + /// If displayed vertically, left content is displayed at the top and right content at the bottom. /// This proportion changes when the user drags the panes bar. /// - /// The value is float type and between 0.0 and 1.0 representing the size proportion of the left side. + /// The float type value between 0.0 and 1.0 represents the size proportion of the left side. /// /// preview public double Proportion @@ -100,9 +100,9 @@ namespace ElmSharp /// Sets or gets the orientation of a given Panes widget. /// /// - /// Use this function to change how your panes is to be disposed: vertically or horizontally. + /// Use this function to change how your panes are to be disposed: vertically or horizontally. /// Horizontal panes have "top" and "bottom" contents, vertical panes have "left" and "right" contents. - /// By default panes is in a vertical mode. + /// By default, the panes are in a vertical mode. /// /// preview public bool IsHorizontal @@ -119,8 +119,8 @@ namespace ElmSharp /// /// Sets or gets the absolute minimum size of panes widget's left side. - /// If displayed vertically, left content is displayed at top. - /// value representing minimum size of left side in pixels. + /// If displayed vertically, left content is displayed at the top. + /// The value represents minimum size of the left side in pixels. /// /// preview public int LeftMinimumSize @@ -136,10 +136,10 @@ namespace ElmSharp } /// - /// Sets or gets the relative minimum size of panes widget's left side. - /// proportion of minimum size of left side. - /// If displayed vertically, left content is displayed at top. - /// value between 0.0 and 1.0 representing size proportion of minimum size of left side. + /// Sets or gets the relative minimum size of the panes widget's left side. + /// The proportion of minimum size of the left side. + /// If displayed vertically, left content is displayed at the top. + /// The value between 0.0 and 1.0 represents size proportion of the minimum size of the left side. /// /// preview public double LeftMinimumRelativeSize @@ -155,9 +155,9 @@ namespace ElmSharp } /// - /// Sets or gets the absolute minimum size of panes widget's right side. - /// If displayed vertically, right content is displayed at top. - /// value representing minimum size of right side in pixels. + /// Sets or gets the absolute minimum size of the panes widget's right side. + /// If displayed vertically, right content is displayed at the top. + /// The value represents the minimum size of the right side in pixels. /// /// preview public int RightMinimumSize @@ -173,10 +173,10 @@ namespace ElmSharp } /// - /// Sets or gets the relative minimum size of panes widget's right side. - /// proportion of minimum size of right side. - /// If displayed vertically, right content is displayed at top. - /// value between 0.0 and 1.0 representing size proportion of minimum size of right side. + /// Sets or gets the relative minimum size of the panes widget's right side. + /// Proportion of the minimum size of the right side. + /// If displayed vertically, right content is displayed at the top. + /// The value between 0.0 and 1.0 represents size proportion of the minimum size of the right side. /// /// preview public double RightMinimumRelativeSize @@ -194,8 +194,8 @@ namespace ElmSharp /// /// Creates a widget handle. /// - /// Parent EvasObject - /// Handle IntPtr + /// Parent EvasObject. + /// Handle IntPtr. /// preview protected override IntPtr CreateHandle(EvasObject parent) { diff --git a/src/ElmSharp/ElmSharp/Point.cs b/src/ElmSharp/ElmSharp/Point.cs index 2dd901b..df047f2 100755 --- a/src/ElmSharp/ElmSharp/Point.cs +++ b/src/ElmSharp/ElmSharp/Point.cs @@ -19,7 +19,7 @@ using System; namespace ElmSharp { /// - /// The Point is a struct that defines a 2-D point as a pair of generic type. + /// The Point is a struct that defines the 2D point as a pair of generic type. /// /// preview public struct Point : IEquatable @@ -37,7 +37,7 @@ namespace ElmSharp public int Y; /// - /// A human-readable representation of the . + /// A human readable representation of . /// /// The string is formatted as "{{X={0} Y={1}}}". /// preview @@ -47,7 +47,7 @@ namespace ElmSharp } /// - /// Gets hash code. + /// Gets the hash code. /// /// The hash code. /// preview @@ -64,8 +64,8 @@ namespace ElmSharp /// /// The object to compare with the current instance. /// - /// true if obj and this instance are the same type and represent the same value. - /// otherwise, false. + /// true if the object and this instance are of the same type and represent the same value, + /// otherwise false. /// /// preview public override bool Equals(object obj) @@ -81,8 +81,8 @@ namespace ElmSharp /// /// The to compare with the current instance. /// - /// true if obj and this instance are the same type and represent the same value. - /// otherwise, false. + /// true if the object and this instance are the same type and represent the same value, + /// otherwise false. /// /// preview public bool Equals(Point other) @@ -91,11 +91,11 @@ namespace ElmSharp } /// - /// Whether the two s are equal. + /// Whether both s are equal. /// - /// A on the left hand side. - /// A on the right hand side. - /// True if the two s have equal values. + /// A on the left hand side. + /// A on the right hand side. + /// True if both s have equal values. /// preview public static bool operator ==(Point p1, Point p2) { @@ -103,11 +103,11 @@ namespace ElmSharp } /// - /// Whether two s are not equal. + /// Whether both s are not equal. /// - /// A on the left hand side. - /// A on the right hand side. - /// True if the two s do not have equal values. + /// A on the left hand side. + /// A on the right hand side. + /// True if both s do not have equal values. /// preview public static bool operator !=(Point p1, Point p2) { diff --git a/src/ElmSharp/ElmSharp/Point3D.cs b/src/ElmSharp/ElmSharp/Point3D.cs index d9ffda8..4b2551c 100755 --- a/src/ElmSharp/ElmSharp/Point3D.cs +++ b/src/ElmSharp/ElmSharp/Point3D.cs @@ -19,31 +19,31 @@ using System; namespace ElmSharp { /// - /// The Point3D is a Struct that defining a 3-D point. + /// The Point3D is a struct that defines a 3D point. /// /// preview public struct Point3D : IEquatable { /// - /// The X coordinate of a 3D point. + /// The X-coordinate of a 3D point. /// /// preview public int X; /// - /// The Y coordinate of a 3D point. + /// The Y-coordinate of a 3D point. /// /// preview public int Y; /// - /// The Z coordinate of a 3D point. + /// The Z-coordinate of a 3D point. /// /// preview public int Z; /// - /// A human-readable representation of the . + /// A human-readable representation of . /// /// The string is formatted as "{{X={0} Y={1} Z={2}}}". /// preview @@ -70,8 +70,8 @@ namespace ElmSharp /// /// The object to compare with the current instance. /// - /// true if obj and this instance are the same type and represent the same value. - /// otherwise, false. + /// true if the object and this instance are of the same type and represent the same value, + /// otherwise false. /// /// preview public override bool Equals(object obj) @@ -87,7 +87,7 @@ namespace ElmSharp /// /// The to compare with the current instance. /// - /// true if obj and this instance are the same type and represent the same value. + /// true if the object and this instance are of the same type and represent the same value. /// otherwise, false. /// /// preview @@ -97,11 +97,11 @@ namespace ElmSharp } /// - /// Whether the two s are equal. + /// Whether both s are equal. /// - /// A on the left hand side. - /// A on the right hand side. - /// True if the two s have equal values. + /// A on the left hand side. + /// A on the right hand side. + /// True if both s have equal values. /// preview public static bool operator ==(Point3D p1, Point3D p2) { @@ -109,11 +109,11 @@ namespace ElmSharp } /// - /// Whether two s are not equal. + /// Whether both s are not equal. /// - /// A on the left hand side. - /// A on the right hand side. - /// True if the two s do not have equal values. + /// A on the left hand side. + /// A on the right hand side. + /// True if both s do not have equal values. /// preview public static bool operator !=(Point3D p1, Point3D p2) { diff --git a/src/ElmSharp/ElmSharp/Polygon.cs b/src/ElmSharp/ElmSharp/Polygon.cs index e050fdf..153b2eb 100755 --- a/src/ElmSharp/ElmSharp/Polygon.cs +++ b/src/ElmSharp/ElmSharp/Polygon.cs @@ -19,7 +19,7 @@ using System; namespace ElmSharp { /// - /// The Polygon is a widget that used to draw a polygon (filled). + /// The Polygon is a widget that is used to draw a polygon (filled). /// /// preview public class Polygon : EvasObject @@ -34,9 +34,9 @@ namespace ElmSharp } /// - /// Adds a new vertex to the Polygon. - /// The X coordinate of the new vertex. - /// The Y coordinate of the new vertex. + /// Adds a new vertex to the polygon. + /// The X-coordinate of the new vertex. + /// The Y-coordinate of the new vertex. /// /// preview public void AddPoint(int x, int y) @@ -45,7 +45,7 @@ namespace ElmSharp } /// - /// Adds a new vertex to the Polygon. + /// Adds a new vertex to the polygon. /// The coordinates of the new vertex. /// /// preview @@ -55,7 +55,7 @@ namespace ElmSharp } /// - /// Removes all the vertices of the Polygon, making it empty. + /// Removes all the vertices of the polygon, making it empty. /// /// preview public void ClearPoints() @@ -66,8 +66,8 @@ namespace ElmSharp /// /// Creates a widget handle. /// - /// Parent EvasObject - /// Handle IntPtr + /// Parent EvasObject. + /// Handle IntPtr. /// preview protected override IntPtr CreateHandle(EvasObject parent) { diff --git a/src/ElmSharp/ElmSharp/Popup.cs b/src/ElmSharp/ElmSharp/Popup.cs index 1d68195..5372526 100755 --- a/src/ElmSharp/ElmSharp/Popup.cs +++ b/src/ElmSharp/ElmSharp/Popup.cs @@ -20,13 +20,13 @@ using System.Collections.Generic; namespace ElmSharp { /// - /// Enumeration for the popup orientation type. + /// Enumeration for the popup orientation types. /// /// preview public enum PopupOrientation { /// - /// Appears in the top of parent, default. + /// Appears in the top of parent, by default. /// Top, /// @@ -64,7 +64,7 @@ namespace ElmSharp } /// - /// The Popup is a widget that is an enhancement of Notify. + /// The Popup is a widget that is an enhancement of notify. /// In addition to content area, there are two optional sections, namely title area and action area. /// /// preview @@ -79,7 +79,7 @@ namespace ElmSharp /// /// Creates and initializes a new instance of the Popup class. /// - /// The EvasObject to which the new Popup will be attached as a child. + /// The EvasObject to which the new popup will be attached as a child. /// preview public Popup(EvasObject parent) : base(parent) { @@ -109,7 +109,7 @@ namespace ElmSharp } /// - /// Dismissed will be triggered when Popup have been dismissed. + /// Dismissed will be triggered when the popup has been dismissed. /// /// preview public event EventHandler Dismissed; @@ -121,19 +121,19 @@ namespace ElmSharp public event EventHandler OutsideClicked; /// - /// OutsideClicked will be triggered when Popup is closed as a result of timeout. + /// OutsideClicked will be triggered when the popup is closed as a result of timeout. /// /// preview public event EventHandler TimedOut; /// - /// OutsideClicked will be triggered when the Popup transition is finished in showing. + /// OutsideClicked will be triggered when the popup transition has finished in showing. /// /// preview public event EventHandler ShowAnimationFinished; /// - /// Sets or gets the position in which Popup will appear in its parent. + /// Sets or gets the position in which the popup will appear in its parent. /// /// preview public PopupOrientation Orientation @@ -149,7 +149,7 @@ namespace ElmSharp } /// - /// Sets or gets the wrapping type of content text packed in content area of Popup widget. + /// Sets or gets the wrapping type of content text packed in the content area of Popup widget. /// /// preview public WrapType ContentTextWrapType @@ -165,13 +165,13 @@ namespace ElmSharp } /// - /// Sets or gets the timeout value set to the Popup(in seconds). + /// Sets or gets the timeout value set to the popup (in seconds). /// /// /// Since calling Show() on a popup restarts the timer controlling when it is hidden, - /// setting this before the popup is shown will in effect mean starting the timer when the popup is shown. - /// TimedOut is called afterwards which can be handled if needed. - /// 0.0 and the popup is previously visible,]]> + /// setting this before the popup is shown, will in effect mean starting the timer when the popup is shown. + /// TimedOut is called afterwards, which can be handled, if needed. + /// 0.0 and the popup is previously visible,]]> /// the timer will be started with this value, canceling any running timer. /// /// preview @@ -188,10 +188,10 @@ namespace ElmSharp } /// - /// Sets or gets whether events should be passed to event blocked area by a click outside. + /// Sets or gets whether events should be passed to the event blocked area by a click outside. /// /// - /// The visible region of popup is surrounded by a translucent region called Blocked Event area. + /// The visible region of the popup is surrounded by a translucent region called the Blocked event area. /// /// preview public bool AllowEvents @@ -239,7 +239,7 @@ namespace ElmSharp } /// - /// Gets the Opacity value of the Popup. + /// Gets the opacity value of the popup. /// /// preview public override int Opacity @@ -256,10 +256,10 @@ namespace ElmSharp } /// - /// Adds label to a Popup widget. + /// Adds the label to a Popup widget. /// /// - /// The new PopupItem which contains label . + /// The new PopupItem which contains a label. /// preview public PopupItem Append(string label) { @@ -267,11 +267,11 @@ namespace ElmSharp } /// - /// Adds Label and icon to a Popup widget. + /// Adds the Label and icon to a Popup widget. /// - /// The Label which will be added into a new PopupItem. - /// The icon which will be added into a new PopupItem. - /// The new PopupItem which contains label and icon. + /// The Label, which will be added into a new PopupItem. + /// The icon, which will be added into a new PopupItem. + /// The new PopupItem, which contains the label and icon. /// preview public PopupItem Append(string label, EvasObject icon) { @@ -283,7 +283,7 @@ namespace ElmSharp /// /// Uses this function to dismiss the popup in hide effect. - /// when the Popup is dismissed, the "dismissed" signal will be emitted. + /// When the Popup is dismissed, the "dismissed" signal will be emitted. /// /// preview public void Dismiss() @@ -294,8 +294,8 @@ namespace ElmSharp /// /// Creates a widget handle. /// - /// Parent EvasObject - /// Handle IntPtr + /// Parent EvasObject. + /// Handle IntPtr. /// preview protected override IntPtr CreateHandle(EvasObject parent) { diff --git a/src/ElmSharp/ElmSharp/PopupItem.cs b/src/ElmSharp/ElmSharp/PopupItem.cs index 78c8bdc..8f347e5 100755 --- a/src/ElmSharp/ElmSharp/PopupItem.cs +++ b/src/ElmSharp/ElmSharp/PopupItem.cs @@ -19,7 +19,7 @@ using System; namespace ElmSharp { /// - /// The PopupItem is a class that including icon and text. + /// The PopupItem is a class that includes the icon and text. /// /// preview public class PopupItem : ItemObject @@ -31,13 +31,13 @@ namespace ElmSharp } /// - /// Gets the text label of popupitem.Return value is string. + /// Gets the text label of the popupitem. Return value is string. /// /// preview public string Text { get; internal set; } /// - /// Gets the icon EvasObject of popupitem. + /// Gets the EvasObject icon of the popupitem. /// /// preview public EvasObject Icon { get; internal set; } diff --git a/src/ElmSharp/ElmSharp/ProgressBar.cs b/src/ElmSharp/ElmSharp/ProgressBar.cs index 4e30436..817e37d 100755 --- a/src/ElmSharp/ElmSharp/ProgressBar.cs +++ b/src/ElmSharp/ElmSharp/ProgressBar.cs @@ -19,7 +19,7 @@ using System; namespace ElmSharp { /// - /// The ProgressBar is a widget for visually representing the progress status of a given job/task. + /// The ProgressBar is a widget for visually representing the progress status of a given job or task. /// /// preview public class ProgressBar : Layout @@ -41,20 +41,20 @@ namespace ElmSharp } /// - /// ValueChanged will be triggered when value of ProgressBar change. + /// ValueChanged will be triggered when the value of the ProgressBar changes. /// /// preview public event EventHandler ValueChanged; /// - /// Sets or gets the value wheather a given ProgressBar widget is at the "pulsing mode". + /// Sets or gets the value whether a given ProgressBar widget is at the "pulsing mode". /// /// /// By default, progress bars display values from low to high value boundaries. /// There are, though, contexts in which the progress of a given task is unknown. - /// For such cases, one can set a progress bar widget to a "pulsing state", + /// For such cases, one can set the progress bar widget to a "pulsing state", /// to give the user an idea that some computation is being held, - /// but without exact progress values. In the default theme, + /// but without the exact progress values. In the default theme, /// it animates its bar with the contents filling in constantly and back to non-filled, in a loop. /// /// preview @@ -71,11 +71,11 @@ namespace ElmSharp } /// - /// Sets or gets the value of ProgressBar. + /// Sets or gets the value of the ProgressBar. /// /// /// Use this property to set the progress bar levels. - /// If you pass a value out of the specified range(0.0~1.0), + /// If you pass a value out of the specified range (0.0~1.0), /// it is interpreted as the closest of the boundary values in the range. /// /// preview @@ -92,7 +92,7 @@ namespace ElmSharp } /// - /// Sets or gets the span value of ProgressBar. + /// Sets or gets the span value of the ProgressBar. /// /// preview public int SpanSize @@ -108,7 +108,7 @@ namespace ElmSharp } /// - /// Sets or gets the value wheather a given ProgressBar widget is horizontal. + /// Sets or gets the value whether a given ProgressBar widget is horizontal. /// /// preview public bool IsHorizontal @@ -140,12 +140,12 @@ namespace ElmSharp } /// - /// Sets or gets format string for a given progress bar widget's units label. + /// Sets or gets the format string for a given progress bar widget's units label. /// /// - /// If NULL is passed on format, it makes obj units area to be hidden completely. + /// If null is passed on format, it makes the object units area to be hidden completely. /// If not, it sets the format string for the units label's text. - /// The units label is provided with a floating point value, so the units text displays at most one floating point value. + /// The units label are provided with a floating point value, so the units text displays at the most one floating point value. /// Note that the units label is optional. Use a format string such as "%1.2f meters" for example. /// /// preview @@ -190,10 +190,10 @@ namespace ElmSharp } /// - /// Gets the part value of the given part of the Progressbar. + /// Gets the part value of a given part of the Progressbar. /// /// Part of the Progressbar. - /// Returns value range is from 0.0 to 1.0. + /// Value range is from 0.0 to 1.0. /// preview public double GetPartValue(string part) { @@ -217,7 +217,7 @@ namespace ElmSharp } /// - /// Sets the part value of the give part of the Progressbar. + /// Sets the part value of a given part of the Progressbar. /// /// Part of the Progressbar. /// Value range is from 0.0 to 1.0. @@ -230,8 +230,8 @@ namespace ElmSharp /// /// Creates a widget handle. /// - /// Parent EvasObject - /// Handle IntPtr + /// Parent EvasObject. + /// Handle IntPtr. /// preview protected override IntPtr CreateHandle(EvasObject parent) { diff --git a/src/ElmSharp/ElmSharp/Radio.cs b/src/ElmSharp/ElmSharp/Radio.cs index 3d889b8..f8d8b93 100755 --- a/src/ElmSharp/ElmSharp/Radio.cs +++ b/src/ElmSharp/ElmSharp/Radio.cs @@ -19,7 +19,7 @@ using System; namespace ElmSharp { /// - /// The Radio is a widget that allows for 1 or more options to be displayed and have the user choose only 1 of them. + /// The Radio is a widget that allows for 1 or more options to be displayed, and have the user choose only 1 of them. /// /// preview public class Radio : Layout @@ -38,13 +38,13 @@ namespace ElmSharp } /// - /// ValueChanged will be triggered when value of Radio change. + /// ValueChanged will be triggered when value of the radio changes. /// /// preview public event EventHandler ValueChanged; /// - /// Sets or gets a unique value to each Radio button. + /// Sets or gets a unique value to each radio button. /// /// preview public int StateValue @@ -92,8 +92,8 @@ namespace ElmSharp /// /// Creates a widget handle. /// - /// Parent EvasObject - /// Handle IntPtr + /// Parent EvasObject. + /// Handle IntPtr. /// preview protected override IntPtr CreateHandle(EvasObject parent) { diff --git a/src/ElmSharp/ElmSharp/ReadingInfoType.cs b/src/ElmSharp/ElmSharp/ReadingInfoType.cs index 8c7bf79..922b29f 100755 --- a/src/ElmSharp/ElmSharp/ReadingInfoType.cs +++ b/src/ElmSharp/ElmSharp/ReadingInfoType.cs @@ -26,23 +26,23 @@ namespace ElmSharp.Accessible public enum ReadingInfoType { /// - /// None + /// None. /// None = 0, /// - /// Name for reading info type + /// Name for reading info type. /// Name = 0x1, /// - /// Role for reading info type + /// Role for reading info type. /// Role = 0x2, /// - /// Description for reading info type + /// Description for reading info type. /// Description = 0x4, /// - /// State for reading info type + /// State for reading info type. /// State = 0x8 } diff --git a/src/ElmSharp/ElmSharp/Rect.cs b/src/ElmSharp/ElmSharp/Rect.cs index be2176a..81294d1 100755 --- a/src/ElmSharp/ElmSharp/Rect.cs +++ b/src/ElmSharp/ElmSharp/Rect.cs @@ -20,7 +20,7 @@ using System.Runtime.InteropServices; namespace ElmSharp { /// - /// The Rect is a struct that represent rectangluar space. + /// The Rect is a struct that represents the rectangular space. /// /// preview [StructLayout(LayoutKind.Sequential)] @@ -29,8 +29,8 @@ namespace ElmSharp /// /// Creates and initializes a new instance of the Rect class. /// - /// X axis value. - /// Y axis value. + /// X-axis value. + /// Y-axis value. /// Width value. /// Height value. /// preview @@ -43,67 +43,67 @@ namespace ElmSharp } /// - /// Gets or sets the position of this Rectangle on the X axis. + /// Gets or sets the position of this rectangle on the X-axis. /// /// preview public int X { get; set; } /// - /// Gets or sets the position of this Rectangle on the Y axis. + /// Gets or sets the position of this rectangle on the Y-axis. /// /// preview public int Y { get; set; } /// - /// Gets or sets the width of this Rectangle. + /// Gets or sets the width of this rectangle. /// /// preview public int Width { get; set; } /// - /// Gets or sets the height of this Rectangle. + /// Gets or sets the height of this rectangle. /// /// preview public int Height { get; set; } /// - /// Gets the position of this Rectangle on the X axis. + /// Gets the position of this rectangle on the X-axis. /// /// preview public int Left { get { return X; } } /// - /// Gets the extent along the X axis. + /// Gets the extent along the X-axis. /// /// preview public int Right { get { return X + Width; } } /// - /// Gets the position of this Rectangle on the Y axis. + /// Gets the position of this rectangle on the Y-axis. /// /// preview public int Top { get { return Y; } } /// - /// Gets the extent along the Y axis. + /// Gets the extent along the Y-axis. /// /// preview public int Bottom { get { return Y + Height; } } /// - /// Gets the Point defined by Rectangle.Left and Rectangle.Top. + /// Gets the point defined by Rectangle.Left and Rectangle.Top. /// /// preview public Point Location { get { return new Point { X = X, Y = Y }; } } /// - /// Gets the extent of the Rectangle along its X and Y axis. + /// Gets the extent of the rectangle along its X-axis and Y-axis. /// /// preview public Size Size { get { return new Size { Width = Width, Height = Height }; } } /// - /// A human-readable representation of the . + /// A human-readable representation of . /// /// The string is formatted as "{{X={0} Y={1} Width={2} Height={3}}}". /// preview @@ -134,8 +134,8 @@ namespace ElmSharp /// /// The object to compare with the current instance. /// - /// true if obj and this instance are the same type and represent the same value. - /// otherwise, false. + /// true if the object and this instance are of the same type and represent the same value, + /// otherwise false. /// /// preview public override bool Equals(object obj) @@ -151,8 +151,8 @@ namespace ElmSharp /// /// The to compare with the current instance. /// - /// true if obj and this instance are the same type and represent the same value. - /// otherwise, false. + /// true if the object and this instance are of the same type and represent the same value, + /// otherwise, false /// /// preview public bool Equals(Rect other) @@ -161,11 +161,11 @@ namespace ElmSharp } /// - /// Whether the two s are equal. + /// Whether both 's are equal. /// - /// A on the left hand side. - /// A on the right hand side. - /// True if the two s have equal values. + /// A on the left hand side. + /// A on the right hand side. + /// True if both 's have equal values. /// preview public static bool operator ==(Rect r1, Rect r2) { @@ -173,11 +173,11 @@ namespace ElmSharp } /// - /// Whether two s are not equal. + /// Whether both 's are not equal. /// - /// A on the left hand side. - /// A on the right hand side. - /// True if the two s do not have equal values. + /// A on the left hand side. + /// A on the right hand side. + /// True if both 's do not have equal values. /// preview public static bool operator !=(Rect r1, Rect r2) { diff --git a/src/ElmSharp/ElmSharp/Rectangle.cs b/src/ElmSharp/ElmSharp/Rectangle.cs index 3aecebf..ac65d0f 100755 --- a/src/ElmSharp/ElmSharp/Rectangle.cs +++ b/src/ElmSharp/ElmSharp/Rectangle.cs @@ -19,7 +19,7 @@ using System; namespace ElmSharp { /// - /// The Rectangle is a class that used to draw a solid colored rectangle. + /// The Rectangle is a class that is used to draw a solid colored rectangle. /// /// preview public class Rectangle : EvasObject @@ -27,7 +27,7 @@ namespace ElmSharp /// /// Creates and initializes a new instance of the Rectangle class. /// - /// The to which the new Slider will be attached as a child. + /// The to which the new slider will be attached as a child. /// preview public Rectangle(EvasObject parent) : base(parent) { @@ -37,8 +37,8 @@ namespace ElmSharp /// /// Creates a widget handle. /// - /// Parent EvasObject - /// Handle IntPtr + /// Parent EvasObject. + /// Handle IntPtr. /// preview protected override IntPtr CreateHandle(EvasObject parent) { diff --git a/src/ElmSharp/ElmSharp/Scroller.cs b/src/ElmSharp/ElmSharp/Scroller.cs index 6cf1c94..5763724 100755 --- a/src/ElmSharp/ElmSharp/Scroller.cs +++ b/src/ElmSharp/ElmSharp/Scroller.cs @@ -19,45 +19,45 @@ using System; namespace ElmSharp { /// - /// Enumeration for visible type of scrollbar. + /// Enumeration for the visible type of scrollbar. /// /// preview public enum ScrollBarVisiblePolicy { /// - /// Show scrollbars as needed + /// Show scrollbars as needed. /// Auto = 0, /// - /// Always show scrollbars + /// Always show scrollbars. /// Visible, /// - /// Never show scrollbars + /// Never show scrollbars. /// Invisible } /// - /// Enumeration for visible type of scrollbar. + /// Enumeration for the visible type of scrollbar. /// /// preview public enum ScrollBlock { /// - /// Scrolling movement is allowed in both direction.(X axis and Y axis) + /// Scrolling movement is allowed in both the directions (X-axis and Y-axis). /// None = 1, /// - /// Scrolling movement is not allowed in Y axis direction. + /// Scrolling movement is not allowed in the Y-axis direction. /// Vertical = 2, /// - /// Scrolling movement is not allowed in X axis direction. + /// Scrolling movement is not allowed in the X-axis direction. /// Horizontal = 4 } @@ -69,17 +69,17 @@ namespace ElmSharp public enum ScrollSingleDirection { /// - /// Scroll every direction. + /// Scroll in every direction. /// None, /// - /// Scroll single direction if the direction is certain. + /// Scroll in single direction if the direction is certain. /// Soft, /// - /// Scroll only single direction. + /// Scroll only in a single direction. /// Hard, } @@ -177,7 +177,7 @@ namespace ElmSharp } /// - /// Gets the current region in the content object that is visible through the Scroller. + /// Gets the current region in the content object that is visible through the scroller. /// /// preview public Rect CurrentRegion @@ -191,7 +191,7 @@ namespace ElmSharp } /// - /// Sets or gets the value of HorizontalScrollBarVisiblePolicy + /// Sets or gets the value of HorizontalScrollBarVisiblePolicy. /// /// /// ScrollBarVisiblePolicy.Auto means the horizontal scrollbar is made visible if it is needed, and otherwise kept hidden. @@ -214,7 +214,7 @@ namespace ElmSharp } /// - /// Sets or gets the value of VerticalScrollBarVisiblePolicy + /// Sets or gets the value of VerticalScrollBarVisiblePolicy. /// /// /// ScrollBarVisiblePolicy.Auto means the vertical scrollbar is made visible if it is needed, and otherwise kept hidden. @@ -240,7 +240,7 @@ namespace ElmSharp /// Sets or gets the value of ScrollBlock. /// /// - /// This function will block scrolling movement in a given direction.One can disable movements in the X axis, the Y axis or both. + /// This function will block scrolling movement in a given direction. One can disable movements in the X-axis, the Y-axis, or both. /// The default value is ScrollBlock.None, where movements are allowed in both directions. /// /// preview @@ -257,7 +257,7 @@ namespace ElmSharp } /// - /// Sets or gets scroll current page number. + /// Sets or gets the scroll current page number. /// /// /// Current page means the page which meets the top of the viewport. @@ -276,7 +276,7 @@ namespace ElmSharp } /// - /// Sets or gets scroll current page number. + /// Sets or gets the scroll current page number. /// /// /// Current page means the page which meets the left of the viewport. @@ -407,11 +407,11 @@ namespace ElmSharp } /// - /// Set scrolling gravity values for a scroller. - /// The gravity, defines how the scroller will adjust its view when the size of the scroller contents increase. - /// The scroller will adjust the view to glue itself as follows. - /// x=0.0, for staying where it is relative to the left edge of the content x=1.0, for staying where it is relative to the rigth edge of the content y=0.0, for staying where it is relative to the top edge of the content y=1.0, for staying where it is relative to the bottom edge of the content - /// Default values for x and y are 0.0 + /// Sets the scrolling gravity values for a scroller. + /// The gravity defines how the scroller will adjust its view when the size of the scroller contents increase. + /// The scroller will adjust the view to glue itself as follows: + /// x=0.0, for staying where it is relative to the left edge of the content, x=1.0, for staying where it is relative to the rigth edge of the content, y=0.0, for staying where it is relative to the top edge of the content, y=1.0, for staying where it is relative to the bottom edge of the content. + /// Default values for x and y are 0.0. /// /// preview public double HorizontalGravity @@ -430,11 +430,11 @@ namespace ElmSharp } /// - /// Set scrolling gravity values for a scroller. - /// The gravity, defines how the scroller will adjust its view when the size of the scroller contents increase. - /// The scroller will adjust the view to glue itself as follows. - /// x=0.0, for staying where it is relative to the left edge of the content x=1.0, for staying where it is relative to the rigth edge of the content y=0.0, for staying where it is relative to the top edge of the content y=1.0, for staying where it is relative to the bottom edge of the content - /// Default values for x and y are 0.0 + /// Sets the scrolling gravity values for a scroller. + /// The gravity defines how the scroller will adjust its view when the size of the scroller contents increase. + /// The scroller will adjust the view to glue itself as follows: + /// x=0.0, for staying where it is relative to the left edge of the content, x=1.0, for staying where it is relative to the rigth edge of the content, y=0.0, for staying where it is relative to the top edge of the content, y=1.0, for staying where it is relative to the bottom edge of the content. + /// Default values for x and y are 0.0. /// /// preview public double VerticalGravity @@ -453,7 +453,7 @@ namespace ElmSharp } /// - /// Get scroll last page number. + /// Gets the scroll last page number. /// The page number starts from 0. 0 is the first page. This returns the last page number among the pages. /// /// preview @@ -468,7 +468,7 @@ namespace ElmSharp } /// - /// Get scroll last page number. + /// Gets the scroll last page number. /// The page number starts from 0. 0 is the first page. This returns the last page number among the pages. /// /// preview @@ -483,7 +483,7 @@ namespace ElmSharp } /// - /// Set an infinite loop_ for a scroller. + /// Sets an infinite loop_ for a scroller. /// This function sets the infinite loop vertically. /// If the content is set, it will be shown repeatedly. /// @@ -504,7 +504,7 @@ namespace ElmSharp } /// - /// Set an infinite loop_ for a scroller. + /// Sets an infinite loop_ for a scroller. /// This function sets the infinite loop horizontally. /// If the content is set, it will be shown repeatedly. /// @@ -563,7 +563,7 @@ namespace ElmSharp } /// - /// Gets or Sets the page snapping behavior of a scroller. + /// Gets or sets the page snapping behavior of a scroller. /// /// /// When scrolling, if a scroller is paged (see VerticalRelativePageSize), @@ -588,7 +588,7 @@ namespace ElmSharp } /// - /// Gets or Sets the page snapping behavior of a scroller. + /// Gets or sets the page snapping behavior of a scroller. /// /// /// When scrolling, if a scroller is paged (see HorizontalRelativePageSize), @@ -653,7 +653,7 @@ namespace ElmSharp /// /// Gets or sets the event propagation for a scroller. /// This enables or disables event propagation from the scroller content to the scroller and its parent. - /// By default event propagation is enabled. + /// By default, event propagation is enabled. /// /// preview public bool ContentPropagateEvents @@ -740,11 +740,11 @@ namespace ElmSharp /// /// Sets the scroller minimum size limited to the minimum size of the content. - /// By default the scroller will be as small as its design allows, irrespective of its content. + /// By default, the scroller will be as small as its design allows, irrespective of its content. /// This will make the scroller minimum size the right size horizontally and/or vertically to perfectly fit its content in that direction. /// - /// Enable limiting minimum size horizontally - /// Enable limiting minimum size vertically + /// Enable limiting minimum size horizontally. + /// Enable limiting minimum size vertically. /// preview public void MinimumLimit(bool horizontal, bool vertical) { @@ -828,7 +828,7 @@ namespace ElmSharp } /// - /// The callback of Realized Event + /// The callback of the Realized event. /// /// preview protected override void OnRealized() @@ -843,8 +843,8 @@ namespace ElmSharp /// /// Creates a widget handle. /// - /// Parent EvasObject - /// Handle IntPtr + /// Parent EvasObject. + /// Handle IntPtr. /// preview protected override IntPtr CreateHandle(EvasObject parent) { diff --git a/src/ElmSharp/ElmSharp/Size.cs b/src/ElmSharp/ElmSharp/Size.cs index a3b81b0..b8713ae 100755 --- a/src/ElmSharp/ElmSharp/Size.cs +++ b/src/ElmSharp/ElmSharp/Size.cs @@ -19,7 +19,7 @@ using System; namespace ElmSharp { /// - /// The Size is a struct that defining height and width as a pair of generic type. + /// The Size is a struct defining the height and width as a pair of generic type. /// /// preview public struct Size : IEquatable @@ -37,10 +37,10 @@ namespace ElmSharp public int Height; /// - /// Initializes a new instance of the Size structure from the specified dimensions. + /// Initializes a new instance of the size structure from specified dimensions. /// - /// The width to set - /// The height to set + /// The width to set. + /// The height to set. /// preview public Size(int width, int height) { @@ -49,7 +49,7 @@ namespace ElmSharp } /// - /// A human-readable representation of the . + /// A human-readable representation of . /// /// The string is formatted as "{{Width={0} Height={1}}}". /// preview @@ -59,7 +59,7 @@ namespace ElmSharp } /// - /// Gets hash code. + /// Gets the hash code. /// /// The hash code. /// preview @@ -76,8 +76,8 @@ namespace ElmSharp /// /// The object to compare with the current instance. /// - /// true if obj and this instance are the same type and represent the same value. - /// otherwise, false. + /// true if the object and this instance are of the same type and represent the same value, + /// otherwise false. /// /// preview public override bool Equals(object obj) @@ -93,8 +93,8 @@ namespace ElmSharp /// /// The to compare with the current instance. /// - /// true if obj and this instance are the same type and represent the same value. - /// otherwise, false. + /// true if the object and this instance are of the same type and represent the same value, + /// otherwise false. /// /// preview public bool Equals(Size other) @@ -103,11 +103,11 @@ namespace ElmSharp } /// - /// Whether the two s are equal. + /// Whether both s are equal. /// - /// A on the left hand side. - /// A on the right hand side. - /// True if the two s have equal values. + /// A on the left hand side. + /// A on the right hand side. + /// True if both s have equal values. /// preview public static bool operator ==(Size s1, Size s2) { @@ -115,11 +115,11 @@ namespace ElmSharp } /// - /// Whether two s are not equal. + /// Whether both s are not equal. /// - /// A on the left hand side. - /// A on the right hand side. - /// True if the two s do not have equal values. + /// A on the left hand side. + /// A on the right hand side. + /// True if both s do not have equal values. /// preview public static bool operator !=(Size s1, Size s2) { diff --git a/src/ElmSharp/ElmSharp/Slider.cs b/src/ElmSharp/ElmSharp/Slider.cs index c5a1d6d..e949e10 100755 --- a/src/ElmSharp/ElmSharp/Slider.cs +++ b/src/ElmSharp/ElmSharp/Slider.cs @@ -25,7 +25,7 @@ namespace ElmSharp public enum SliderIndicatorVisibleMode { /// - /// Show indicator on mouse down or change in slider value. + /// Shows the indicator on mouse down or change in the slider value. /// Default, @@ -62,7 +62,7 @@ namespace ElmSharp /// /// Creates and initializes a new instance of the Slider class. /// - /// The to which the new Slider will be attached as a child. + /// The to which the new slider will be attached as a child. /// preview public Slider(EvasObject parent) : base(parent) { @@ -110,7 +110,7 @@ namespace ElmSharp /// /// /// This sets the minimum width (when in the horizontal mode) or height (when in the vertical mode) - /// of the actual bar area of the slider obj. This in turn affects the object's minimum size. + /// of the actual bar area of the slider object. This in turn affects the object's minimum size. /// Use this when you're not setting other size hints expanding on the given direction /// (like weight and alignment hints), and you would like it to have a specific size. /// @@ -133,11 +133,11 @@ namespace ElmSharp /// /// The slider may display its value somewhere other than the unit label, /// for example, above the slider knob that is dragged around. This function sets the format string - /// used for this.If NULL, the indicator label won't be visible. If not, it sets the format string + /// used for this. If null, the indicator label won't be visible. If not, it sets the format string /// for the label text. For the label text floating point value is provided, so the label text can - /// display up to 1 floating point value. Note that this is optional.Use a format string + /// display up to 1 floating point value. Note that this is optional. Use a format string /// such as "%1.2f meters" for example, and it displays values like: "3.14 meters" for a value - /// equal to 3.14159.By default, the indicator label is disabled. + /// equal to 3.14159. By default, the indicator label is disabled. /// /// preview public string IndicatorFormat @@ -156,7 +156,7 @@ namespace ElmSharp /// Sets or gets the orientation of a given slider widget. /// /// - /// The orientation may be vertically or horizontally.By default, it's displayed horizontally. + /// The orientation may be vertical or horizontal. By default, it's displayed horizontally. /// /// preview public bool IsHorizontal @@ -177,7 +177,7 @@ namespace ElmSharp /// /// This defines the allowed minimum values to be selected by the user. /// If the actual value is less than min, it is updated to min. - /// Actual value can be obtained with Value.By default, min is equal to 0.0. + /// Actual value can be obtained with value. By default, the minimum is equal to 0.0. /// /// preview public double Minimum @@ -199,7 +199,7 @@ namespace ElmSharp /// /// This defines the allowed maximum values to be selected by the user. /// If the actual value is bigger then max, it is updated to max. - /// Actual value can be obtained with Value.By default, min is equal to 0.0, and max is equal to 1.0. + /// Actual value can be obtained with value. By default, minimum is equal to 0.0 and maximum is equal to 1.0. /// Maximum must be greater than minimum, otherwise the behavior is undefined. /// /// preview @@ -221,7 +221,7 @@ namespace ElmSharp /// /// /// Value will be presented on the unit label following format specified with UnitFormat and - /// on indicator with IndicatorFormat.The value must to be between Minimum and Maximum values. + /// on indicator with IndicatorFormat. The value must be between minimum and maximum values. /// /// preview public double Value @@ -242,7 +242,7 @@ namespace ElmSharp /// /// This value is used when the draggable object is moved automatically i.e., /// in case of a key event when up/down/left/right key is pressed or in case accessibility - /// is set and the flick event is used to inc/dec slider values. + /// is set and the flick event is used to increase or decrease the slider values. /// By default, the step value is equal to 0.05. /// /// preview @@ -263,7 +263,7 @@ namespace ElmSharp /// /// /// A slider may be inverted, in which case it gets its values inverted, - /// with high values being on the left or top and low values on the right or bottom, + /// with high values being on the left or top, and low values on the right or bottom, /// as opposed to normally have the low values on the former and high values on the latter, /// respectively, for the horizontal and vertical modes. /// @@ -285,7 +285,7 @@ namespace ElmSharp /// /// /// By default, the indicator is bigger when dragged by the user. - /// It won't display values set with IndicatorFormat if you disable the indicator. + /// It won't display the values set with IndicatorFormat if you disable the indicator. /// /// preview public bool IsIndicatorVisible @@ -301,7 +301,7 @@ namespace ElmSharp } /// - /// Sets or gets the visible mode of slider indicator. + /// Sets or gets the visible mode of the slider indicator. /// /// preview public SliderIndicatorVisibleMode IndicatorVisibleMode @@ -317,7 +317,7 @@ namespace ElmSharp } /// - /// Sets or gets whether to Show the indicator of slider on focus. + /// Sets or gets whether to show the indicator of a slider on focus. /// /// preview public bool IsIndicatorFocusable @@ -335,8 +335,8 @@ namespace ElmSharp /// /// Creates a widget handle. /// - /// Parent EvasObject - /// Handle IntPtr + /// Parent EvasObject. + /// Handle IntPtr. /// preview protected override IntPtr CreateHandle(EvasObject parent) { diff --git a/src/ElmSharp/ElmSharp/SmartEvent.cs b/src/ElmSharp/ElmSharp/SmartEvent.cs index b81382f..e52aeec 100755 --- a/src/ElmSharp/ElmSharp/SmartEvent.cs +++ b/src/ElmSharp/ElmSharp/SmartEvent.cs @@ -24,7 +24,7 @@ namespace ElmSharp /// /// It inherits . /// The event with TEventArgs for . - /// EvasObject can elect SmartEvent occurring inside of them to be reported back to their users via delegates. + /// EvasObject can elect the SmartEvent occurring inside them, to be reported back to their users via delegates. /// This way, you can extend EvasObject's own . /// They are defined by an event string, which identifies them uniquely. /// @@ -33,11 +33,11 @@ namespace ElmSharp public class SmartEvent : IInvalidatable where TEventArgs : EventArgs { /// - /// The delegate for creating smart event item args. + /// The delegate for creating smart event item arguments. /// /// The item data. - /// The sender obj. - /// The item sender obj. + /// The sender object. + /// The item sender object. /// Return smart event item args. /// preview public delegate TEventArgs SmartEventInfoParser(IntPtr data, IntPtr obj, IntPtr info); @@ -60,7 +60,7 @@ namespace ElmSharp } /// - /// reates and initializes a new instance of the SmartEvent class. + /// Creates and initializes a new instance of the SmartEvent class. /// /// The source of the event. /// Teh event handler. @@ -88,7 +88,7 @@ namespace ElmSharp } /// - /// Destroy the SmartEvent object. + /// Destroys the SmartEvent object. /// ~SmartEvent() { @@ -102,7 +102,7 @@ namespace ElmSharp } /// - /// Adds or removes delegate for event. + /// Adds or removes a delegate for the event. /// /// preview public event EventHandler On @@ -140,7 +140,7 @@ namespace ElmSharp } /// - /// Destroy current object + /// Destroys the current object. /// /// preview public void Dispose() @@ -150,7 +150,7 @@ namespace ElmSharp } /// - /// Make current instance invalidate. + /// Makes the current instance invalidate. /// /// preview public void MakeInvalidate() @@ -160,11 +160,11 @@ namespace ElmSharp } /// - /// Releases all resources currently used by this instance. + /// Releases all the resources currently used by this instance. /// /// - /// true if managed resources should be disposed - /// otherwise, false. + /// true if the managed resources should be disposed, + /// otherwise false. /// /// preview protected virtual void Dispose(bool disposing) @@ -186,7 +186,7 @@ namespace ElmSharp /// /// It inherits . - /// EvasObject can elect SmartEvent occurring inside of them to be reported back to their users via delegates. + /// EvasObject can elect the SmartEvent occurring inside them, to be reported back to their users via delegates. /// This way, you can extend EvasObject's own . /// They are defined by an event string, which identifies them uniquely. /// @@ -221,7 +221,7 @@ namespace ElmSharp } /// - /// Destroy the SmartEvent object. + /// Destroys the SmartEvent object. /// ~SmartEvent() { @@ -229,7 +229,7 @@ namespace ElmSharp } /// - /// Adds or removes delegate for event. + /// Adds or removes a delegate for the event. /// /// preview public event EventHandler On @@ -259,7 +259,7 @@ namespace ElmSharp } /// - /// Destroy current object + /// Destroys the current object. /// /// preview public void Dispose() @@ -269,7 +269,7 @@ namespace ElmSharp } /// - /// Make current instance invalidate. + /// Makes the current instance invalidate. /// /// preview public void MakeInvalidate() @@ -278,11 +278,11 @@ namespace ElmSharp } /// - /// Releases all resources currently used by this instance. + /// Releases all the resources currently used by this instance. /// /// - /// true if managed resources should be disposed - /// otherwise, false. + /// true if the managed resources should be disposed, + /// otherwise false. /// /// preview protected virtual void Dispose(bool disposing) diff --git a/src/ElmSharp/ElmSharp/Spinner.cs b/src/ElmSharp/ElmSharp/Spinner.cs index 5f619e4..90a3bb4 100755 --- a/src/ElmSharp/ElmSharp/Spinner.cs +++ b/src/ElmSharp/ElmSharp/Spinner.cs @@ -19,7 +19,7 @@ using System; namespace ElmSharp { /// - /// The Spinner is a widget that increase or decrease numeric values using arrow buttons, or edit values directly. + /// The Spinner is a widget that increases or decreases the numeric values using arrow buttons, or edit values directly. /// Inherits . /// /// preview @@ -41,7 +41,7 @@ namespace ElmSharp } /// - /// Creates and initializes a new instance of Layout class. + /// Creates and initializes a new instance of the Layout class. /// /// preview protected Spinner() : base() @@ -55,7 +55,7 @@ namespace ElmSharp public event EventHandler ValueChanged; /// - /// DelayedValueChanged will be triggered after a short time when the value is changed. + /// DelayedValueChanged will be triggered after a short time when the value is changed. /// /// preview public event EventHandler DelayedValueChanged; @@ -111,7 +111,7 @@ namespace ElmSharp } /// - /// Sets or gets the step that used to increment or decrement the spinner value. + /// Sets or gets the step that is used to increment or decrement the spinner value. /// /// preview public double Step @@ -143,7 +143,7 @@ namespace ElmSharp } /// - /// Sets or gets the interval on time updates for an user mouse button hold on spinner widgets' arrows. + /// Sets or gets the interval on time updates for a user mouse button to hold on the spinner widgets' arrows. /// /// preview public double Interval @@ -194,9 +194,9 @@ namespace ElmSharp /// Sets or gets the wrap of a given spinner widget. /// /// - /// If wrap is disabled, when the user tries to increment the value, but displayed value plus step value is bigger than maximum value, the new value will be the maximum value. - /// If wrap is enabled, when the user tries to increment the value, but displayed value plus step value is bigger than maximum value, the new value will be the minimum value. - /// By default it's disabled. + /// If wrap is disabled when the user tries to increment the value, but the displayed value plus step value is bigger than the maximum value, then the new value will be the maximum value. + /// If wrap is enabled when the user tries to increment the value, but the displayed value plus step value is bigger than the maximum value, then the new value will be the minimum value. + /// By default, it's disabled. /// /// preview public bool IsWrapEnabled @@ -214,7 +214,7 @@ namespace ElmSharp /// /// Sets or gets whether the spinner can be directly edited by the user or not. /// - /// By default it is enabled + /// By default, it is enabled. /// preview public bool IsEditable { @@ -229,7 +229,7 @@ namespace ElmSharp } /// - /// Set a special string to display in the place of the numerical value. + /// Sets a special string to display in the place of the numerical value. /// /// The numerical value to be replaced /// The label to be used @@ -240,9 +240,9 @@ namespace ElmSharp } /// - /// Remove a previously added special value, After this, the spinner will display the value itself instead of a label. + /// Removes a previously added special value. After this, the spinner will display the value itself instead of a label. /// - /// The replaced numerical value + /// The replaced numerical value. /// preview public void RemoveSpecialValue(double value) { @@ -250,10 +250,10 @@ namespace ElmSharp } /// - /// Get the special string display in the place of the numerical value. + /// Gets the special string display in the place of the numerical value. /// /// The replaced numerical value. - /// The value of the spinner which replaced numerical value with special string + /// The value of the spinner, which replaced the numerical value with a special string. /// preview public string GetSpecialValue(double value) { @@ -261,7 +261,7 @@ namespace ElmSharp } /// - /// The callback of Realized Event + /// The callback of the Realized event. /// /// preview protected override void OnRealized() @@ -277,8 +277,8 @@ namespace ElmSharp /// /// Creates a widget handle. /// - /// Parent EvasObject - /// Handle IntPtr + /// Parent EvasObject. + /// Handle IntPtr. /// preview protected override IntPtr CreateHandle(EvasObject parent) { diff --git a/src/ElmSharp/ElmSharp/Table.cs b/src/ElmSharp/ElmSharp/Table.cs index 7176a81..96f1f81 100755 --- a/src/ElmSharp/ElmSharp/Table.cs +++ b/src/ElmSharp/ElmSharp/Table.cs @@ -19,7 +19,7 @@ using System; namespace ElmSharp { /// - /// The Table is a container widget to arrange other widgets in a table where items can span multiple columns or rows . + /// The Table is a container widget to arrange other widgets in a table where items can span multiple columns or rows. /// Inherits . /// /// preview @@ -42,7 +42,7 @@ namespace ElmSharp /// /// Sets or gets whether the layout of this table is homogeneous. /// - /// True for homogeneous, False for no homogeneous + /// True for homogeneous, False for no homogeneous. /// preview public bool Homogeneous { @@ -92,11 +92,11 @@ namespace ElmSharp /// /// Adds a subobject on the table with the coordinates passed. /// - /// The subobject to be added to the table - /// The column number - /// The row number - /// The column span - /// The row span + /// The subobject to be added to the table. + /// The column number. + /// The row number. + /// The column span. + /// The row span. /// preview public void Pack(EvasObject obj, int col, int row, int colspan, int rowspan) { @@ -109,7 +109,7 @@ namespace ElmSharp /// /// Removes the child from the table. /// - /// The subobject + /// The subobject. /// preview public void Unpack(EvasObject obj) { @@ -120,7 +120,7 @@ namespace ElmSharp } /// - /// Removes all child objects from a table object. + /// Removes all the child objects from a table object. /// /// preview public void Clear() @@ -130,10 +130,10 @@ namespace ElmSharp } /// - /// Sets the color for particular part of the table. + /// Sets the color for a particular part of the table. /// - /// The name of part class - /// The color + /// The name of part class. + /// The color. /// preview public override void SetPartColor(string part, Color color) { @@ -144,10 +144,10 @@ namespace ElmSharp } /// - /// Gets the color of particular part of the table. + /// Gets the color of a particular part of the table. /// - /// The name of part class, it could be 'bg', 'elm.swllow.content' - /// The color of the particular part + /// The name of part class, it could be 'bg', 'elm.swllow.content'. + /// The color of a particular part. /// preview public override Color GetPartColor(string part) { @@ -159,8 +159,8 @@ namespace ElmSharp /// /// Creates a widget handle. /// - /// Parent EvasObject - /// Handle IntPtr + /// Parent EvasObject. + /// Handle IntPtr. /// preview protected override IntPtr CreateHandle(EvasObject parent) { diff --git a/src/ElmSharp/ElmSharp/Toolbar.cs b/src/ElmSharp/ElmSharp/Toolbar.cs index 33fea30..5ab0827 100755 --- a/src/ElmSharp/ElmSharp/Toolbar.cs +++ b/src/ElmSharp/ElmSharp/Toolbar.cs @@ -20,7 +20,7 @@ using System.ComponentModel; namespace ElmSharp { /// - /// Enumeration for the selection mode of Toolbar. + /// Enumeration for the selection mode of the toolbar. /// /// preview public enum ToolbarSelectionMode @@ -47,13 +47,13 @@ namespace ElmSharp } /// - /// Enumeration that sets the toolbar items display behavior, it can be scrollable, can show a menu with exceeding items, or simply hide them. + /// Enumeration for setting the toolbar items display behavior, it can be scrollable, can show a menu with exceeding items, or simply hide them. /// /// preview public enum ToolbarShrinkMode { /// - /// Sets minimum toolbar size to fit all the items. + /// Sets the minimum toolbar size to fit all the items. /// None = 0, @@ -68,7 +68,7 @@ namespace ElmSharp Scroll, /// - /// Inserts a button to pop up a menu with exceeding items. + /// Inserts a button to popup a menu with exceeding items. /// Menu, @@ -79,28 +79,28 @@ namespace ElmSharp } /// - /// Enumeration for the icon lookup order of Toolbar. + /// Enumeration for the icon lookup order of the toolbar. /// /// preview public enum ToolbarIconLookupOrder { /// - /// Icon look up order: freedesktop, theme. + /// Icon lookup order: freedesktop, theme. /// FreedesktopTheme, /// - /// Icon look up order: theme, freedesktop. + /// Icon lookup order: theme, freedesktop. /// ThemeFreedesktop, /// - /// Icon look up order: freedesktop. + /// Icon lookup order: freedesktop. /// Freedesktop, /// - /// Icon look up order: theme. + /// Icon lookup order: theme. /// Theme, } @@ -168,7 +168,7 @@ namespace ElmSharp } /// - /// Selected will be triggered when toolbar have been selected. + /// Selected will be triggered when toolbar has been selected. /// /// preview public event EventHandler Selected; @@ -176,7 +176,7 @@ namespace ElmSharp /// /// Sets or gets whether the layout of this toolbar is homogeneous. /// - /// True for homogeneous, False for no homogeneous + /// True for homogeneous, False for no homogeneous. /// preview public bool Homogeneous { @@ -223,7 +223,7 @@ namespace ElmSharp } /// - /// Sets or gets toolbar's current orientation. + /// Sets or gets the toolbar's current orientation. /// /// preview [EditorBrowsable(EditorBrowsableState.Never)] @@ -275,7 +275,7 @@ namespace ElmSharp } /// - /// Gets the number of items in a toolbar widget. + /// Gets the number of items in a Toolbar widget. /// /// preview public int ItemsCount @@ -289,7 +289,7 @@ namespace ElmSharp /// /// Sets or gets the alignment of the items. /// - /// The toolbar items alignment, a float between 0.0 and 1.0 + /// The toolbar items alignment, a float between 0.0 and 1.0. /// preview public double ItemAlignment { @@ -304,7 +304,7 @@ namespace ElmSharp } /// - /// Sets or gets the item's transverse expansion of a given toolbar widget. + /// Sets or gets the item's transverse expansion of a given Toolbar widget. /// /// /// The transverse expansion of the item, true for on and false for off. @@ -324,10 +324,10 @@ namespace ElmSharp } /// - /// Appends ToolbarItem which just contains label to the toolbar. + /// Appends the ToolbarItem, which just contains label to the toolbar. /// - /// The label of the item - /// The new ToolbarItem which appended to the toolbar + /// The label of the item. + /// The new ToolbarItem which is appended to the toolbar. /// /// /// preview @@ -337,11 +337,11 @@ namespace ElmSharp } /// - /// Appends ToolbarItem which contains label and icon to the toolbar. + /// Appends the ToolbarItem, which contains label and icon to the toolbar. /// - /// The label of the item - /// A string with the icon name or the absolute path of an image file - /// The new ToolbarItem which appended to the toolbar + /// The label of the item. + /// A string with the icon name or the absolute path of an image file. + /// The new ToolbarItem which is appended to the toolbar. /// /// /// @@ -354,10 +354,10 @@ namespace ElmSharp } /// - /// Prepends ToolbarItem which just contains label to the toolbar. + /// Prepends the ToolbarItem, which just contains label to the toolbar. /// - /// The label of the item - /// The new ToolbarItem which prepended to the toolbar + /// The label of the item. + /// The new ToolbarItem which is prepended to the toolbar. /// /// /// @@ -368,11 +368,11 @@ namespace ElmSharp } /// - /// Prepends ToolbarItem which contains label and icon to the toolbar. + /// Prepends the ToolbarItem, which contains label and icon to the toolbar. /// - /// The label of the item - /// A string with the icon name or the absolute path of an image file - /// The new which prepended to the toolbar + /// The label of the item. + /// A string with the icon name or the absolute path of an image file. + /// The new which is prepended to the toolbar. /// /// /// @@ -387,9 +387,9 @@ namespace ElmSharp /// /// Inserts a new item which just contains label into the toolbar object before item . /// - /// The toolbar item to insert before - /// The label of the item - /// The new which insert into the toolbar + /// The toolbar item to insert before. + /// The label of the item. + /// The new which is inserted into the toolbar. /// /// preview public ToolbarItem InsertBefore(ToolbarItem before, string label) @@ -400,10 +400,10 @@ namespace ElmSharp /// /// Inserts a new item which contains label and icon into the toolbar object before item . /// - /// The toolbar item to insert before - /// The label of the item - /// A string with the icon name or the absolute path of an image file - /// The new which insert into the toolbar + /// The toolbar item to insert before. + /// The label of the item. + /// A string with the icon name or the absolute path of an image file. + /// The new which is inserted into the toolbar. /// /// preview public ToolbarItem InsertBefore(ToolbarItem before, string label, string icon) @@ -416,10 +416,10 @@ namespace ElmSharp /// /// Inserts a new item which contains label and icon into the toolbar object after item . /// - /// The toolbar item to insert after - /// The label of the item - /// A string with the icon name or the absolute path of an image file - /// The new which insert into the toolbar + /// The toolbar item to insert after. + /// The label of the item. + /// A string with the icon name or the absolute path of an image file. + /// The new which is inserted into the toolbar. /// preview public ToolbarItem InsertAfter(ToolbarItem after, string label, string icon) { @@ -429,10 +429,10 @@ namespace ElmSharp } /// - /// Find the item with that label in the toolbar. + /// Finds the item with that label in the toolbar. /// - /// The label of the item - /// The into the toolbar + /// The label of the item. + /// The into the toolbar. /// preview public ToolbarItem FindItemByLabel(string label) { @@ -482,8 +482,8 @@ namespace ElmSharp /// /// Creates a widget handle. /// - /// Parent EvasObject - /// Handle IntPtr + /// Parent EvasObject. + /// Handle IntPtr. /// preview protected override IntPtr CreateHandle(EvasObject parent) { diff --git a/src/ElmSharp/ElmSharp/ToolbarItem.cs b/src/ElmSharp/ElmSharp/ToolbarItem.cs index 38f90a0..f92961d 100755 --- a/src/ElmSharp/ElmSharp/ToolbarItem.cs +++ b/src/ElmSharp/ElmSharp/ToolbarItem.cs @@ -19,7 +19,7 @@ using System; namespace ElmSharp { /// - /// The ToolbarItem is a item of Toolbar. + /// The ToolbarItem is an item of the toolbar. /// /// preview public class ToolbarItem : ItemObject @@ -86,7 +86,7 @@ namespace ElmSharp /// /// Sets or gets whether displaying the item as a separator. /// - /// Items aren't set as a separator by default. If set as a separator it displays a separator theme, so it won't display icons or labels. + /// Items aren't set as a separator by default. If set as a separator, it displays a separator theme, so it won't display the icons or labels. /// preview public bool IsSeparator { @@ -123,7 +123,7 @@ namespace ElmSharp public event EventHandler Selected; /// - /// LongPressed will be triggered when the item is pressed long time. + /// LongPressed will be triggered when the item is pressed for a long time. /// /// preview public event EventHandler LongPressed; diff --git a/src/ElmSharp/ElmSharp/Transit.cs b/src/ElmSharp/ElmSharp/Transit.cs index b677c7b..afcaa3b 100755 --- a/src/ElmSharp/ElmSharp/Transit.cs +++ b/src/ElmSharp/ElmSharp/Transit.cs @@ -24,8 +24,8 @@ using static Interop.Elementary; namespace ElmSharp { /// - /// Transit is designed to apply various animated transition effects, such like translation, rotation, etc. - /// For using these effects, create an Transit and add the desired transition effects. + /// Transit is designed to apply various animated transition effects, such as translation, rotation, etc. + /// For using these effects, create a transit and add the desired transition effects. /// /// Transit is not reusable. If the effect ends, the transit is destroyed automatically. /// preview @@ -41,13 +41,13 @@ namespace ElmSharp Elm_Transit_Effect_Transition_Cb EffectTransitionCallback; /// - /// A callback called when the transit is deleted. + /// A callback is called when the transit is deleted. /// /// preview public event EventHandler Deleted; /// - /// Creates and initializes a new instance of Transit class. + /// Creates and initializes a new instance of the Transit class. /// /// preview public Transit() @@ -64,7 +64,7 @@ namespace ElmSharp } /// - /// Destroy the Transit object. + /// Destroys the transit object. /// ~Transit() { @@ -72,7 +72,7 @@ namespace ElmSharp } /// - /// Gets or sets the transit animation time + /// Gets or sets the transit animation time. /// /// preview public double Duration @@ -88,8 +88,8 @@ namespace ElmSharp } /// - /// Gets or sets a value whether the objects states will be keep or not. - /// If it is not kept, the objects states will be reset when transition ends. + /// Gets or sets a value whether the objects states will be kept or not. + /// If it is not kept, the objects states will be reset when the transition ends. /// /// preview public bool ObjectStateKeep @@ -138,7 +138,7 @@ namespace ElmSharp } /// - /// Gets or sets if the auto reverse is on. + /// Gets or sets if auto reverse is on. /// /// preview public bool AutoReverse @@ -170,8 +170,8 @@ namespace ElmSharp } /// - /// Gets or sets the smooth scaling for transit map rendering - /// This gets smooth scaling for transit map rendering. + /// Gets or sets the smooth scaling for transit map rendering. + /// This gets the smooth scaling for transit map rendering. /// /// preview public bool Smooth @@ -187,8 +187,8 @@ namespace ElmSharp } /// - /// Get the time progression of the animation (a double value between 0.0 and 1.0). - /// The value returned is a fraction(current time / total time). + /// Gets the time progression of the animation (a double value between 0.0 and 1.0). + /// The value returned is a fraction (current time/total time). /// It represents the progression position relative to the total. /// /// preview @@ -242,7 +242,7 @@ namespace ElmSharp /// Starts the transition in given seconds. /// Once this API is called, the transit begins to measure the time. /// - /// The interval value in seconds + /// The interval value in seconds. /// preview public void Go(double interval = 0) { @@ -250,7 +250,7 @@ namespace ElmSharp } /// - /// Pause the transition. + /// Pauses the transition. /// /// preview public void Pause() @@ -260,7 +260,7 @@ namespace ElmSharp } /// - /// Resume the transition. + /// Resumes the transition. /// /// preview public void Resume() @@ -270,7 +270,7 @@ namespace ElmSharp } /// - /// Get the current chained transit list. + /// Gets the current chained transit list. /// /// Cannot add the duplicate transit. /// preview @@ -280,7 +280,7 @@ namespace ElmSharp } /// - /// Get the objects list of the transit. + /// Gets the objects list of the transit. /// /// Cannot add the duplicate object. /// preview @@ -290,7 +290,7 @@ namespace ElmSharp } /// - /// Add the effect. + /// Adds the effect. /// /// EffectBase object. /// preview @@ -303,7 +303,7 @@ namespace ElmSharp } /// - /// Destroy current object + /// Destroys the current object. /// /// preview public void Dispose() @@ -313,11 +313,11 @@ namespace ElmSharp } /// - /// Releases all resources currently used by this instance. + /// Releases all the resources currently used by this instance. /// /// - /// true if managed resources should be disposed - /// otherwise, false. + /// true if the managed resources should be disposed, + /// otherwise false. /// /// preview protected virtual void Dispose(bool disposing) @@ -366,11 +366,11 @@ namespace ElmSharp } /// - /// Add new object to apply the effects. - /// After the first addition of an object to transit, if its object list become empty again, the transit will be killed. - /// If the obj belongs to another transit, the obj will be removed from it and it will only belong to the other transit. + /// Adds a new object to apply the effects. + /// After the first addition of an object to transit, if its object list becomes empty again, the transit will be killed. + /// If the object belongs to another transit, the object will be removed from it and it will only belong to the other transit. /// - /// It is not allowed to add a new object after transit begins. + /// It is not allowed to add a new object after the transit begins. /// Object to be animated. void AddObject(EvasObject obj) { @@ -396,7 +396,7 @@ namespace ElmSharp /// /// Makes the chain relationship between two transits. /// - /// The chain transit object. This transit will be operated after transit is done. + /// The chain transit object. This transit will be operated after the transit is done. void AddChainedTransit(Transit transit) { if (_checker.Contains(transit)) @@ -407,7 +407,7 @@ namespace ElmSharp } /// - /// Cut off the chain relationship between two transits. + /// Cuts off the chain relationship between two transits. /// /// The chain transit object. void DeleteChainedTransit(Transit transit) diff --git a/src/ElmSharp/ElmSharp/TransitEffect.cs b/src/ElmSharp/ElmSharp/TransitEffect.cs index 2e1829e..e42cd5c 100755 --- a/src/ElmSharp/ElmSharp/TransitEffect.cs +++ b/src/ElmSharp/ElmSharp/TransitEffect.cs @@ -20,109 +20,109 @@ using System.Collections.Generic; namespace ElmSharp { /// - /// The axis along which flip effect should be applied. + /// Enumeration for the axis along which flip effect should be applied. /// /// preview public enum FlipAxis { /// - /// Flip on X axis + /// Flip on X-axis. /// X, /// - /// Flip on Y axis + /// Flip on Y-axis. /// Y, } /// - /// The direction in which the wipe effect should occur. + /// Enumeration for the direction in which the wipe effect should occur. /// /// preview public enum WipeDirection { /// - /// Wipe to the left + /// Wipe to the left. /// Left, /// - /// Wipe to the right + /// Wipe to the right. /// Right, /// - /// Wipe to the up + /// Wipe to the up. /// Up, /// - /// Wipe to the down + /// Wipe to the down. /// Down, } /// - /// Whether the wipe effect should show or hide the object. + /// Enumeration for whether the wipe effect should show or hide the object. /// /// preview public enum WipeType { /// - /// Hide the object during the animation + /// Hide the object during the animation. /// Hide, /// - /// Show the object during the animation + /// Show the object during the animation. /// Show, } /// - /// The type of acceleration used in the transition. + /// Enumration for the type of acceleration used in transition. /// /// preview public enum TweenMode { /// - /// Constant speed + /// Constant speed. /// Linear, /// - /// Starts slow, increase speed over time, then decrease again and stop slowly, v1 being a power factor + /// Starts slow, increases speed over time, then decrease again and stop slowly, v1 being a power factor. /// Sinusoidal, /// - /// Starts fast and decrease speed over time, v1 being a power factor + /// Starts fast and decreases speed over time, v1 being a power factor. /// Decelerate, /// - /// Starts slow and increase speed over time, v1 being a power factor + /// Starts slow and increases speed over time, v1 being a power factor. /// Accelerate, /// - /// Start at gradient v1, interpolated via power of v2 curve + /// Starts at gradient v1, interpolated via power of v2 curve. /// DivisorInterpolate, /// - /// Start at 0.0 then "drop" like a ball bouncing to the ground at 1.0, and bounce v2 times, with decay factor of v1 + /// Starts at 0.0 then "drop" like a ball bouncing to the ground at 1.0, and bounce v2 times, with decay factor of v1. /// Bounce, /// - /// Start at 0.0 then "wobble" like a spring rest position 1.0, and wobble v2 times, with decay factor of v1 + /// Starts at 0.0 then "wobble" like a spring rest position 1.0, and wobble v2 times, with decay factor of v1. /// Spring, /// - /// Follow the cubic-bezier curve calculated with the control points (x1, y1), (x2, y2) + /// Follows the cubic-bezier curve calculated with the control points (x1, y1), (x2, y2). /// BezierCurve, } @@ -134,7 +134,7 @@ namespace ElmSharp public class BlendEffect : EffectBase { /// - /// Creates and initializes a new instance of BlendEffect class. + /// Creates and initializes a new instance of the BlendEffect class. /// /// preview public BlendEffect() @@ -157,10 +157,10 @@ namespace ElmSharp Color _end; /// - /// Creates and initializes a new instance of ColorEffect class. + /// Creates and initializes a new instance of the ColorEffect class. /// - /// The begin color of the effect - /// The end color of the effect + /// The begin color of the effect. + /// The end color of the effect. /// preview public ColorEffect(Color beginColor, Color endColor) { @@ -169,7 +169,7 @@ namespace ElmSharp } /// - /// The begin color of the effect + /// The begin color of the effect. /// /// preview public Color BeginColor @@ -178,7 +178,7 @@ namespace ElmSharp } /// - /// The end color of the effect + /// The end color of the effect. /// /// preview public Color EndColor @@ -199,7 +199,7 @@ namespace ElmSharp public class FadeEffect : EffectBase { /// - /// Creates and initializes a new instance of FadeEffect class. + /// Creates and initializes a new instance of the FadeEffect class. /// /// preview public FadeEffect() @@ -223,11 +223,11 @@ namespace ElmSharp bool _resizable; /// - /// Creates and initializes a new instance of FlipEffect class. + /// Creates and initializes a new instance of the FlipEffect class. /// - /// Flipping Axis(X or Y). - /// Flipping Direction. True is clock-wise. - /// Resizable effect with FlipEffect + /// Flipping axis (X or Y). + /// Flipping Direction. True is clockwise. + /// Resizable effect with FlipEffect. /// preview public FlipEffect(FlipAxis axis, bool clockWise, bool resizable = false) { @@ -237,7 +237,7 @@ namespace ElmSharp } /// - /// Flipping Axis(X or Y). + /// Flipping axis (X or Y). /// /// preview public FlipAxis Axis @@ -246,7 +246,7 @@ namespace ElmSharp } /// - /// Flipping Direction. True is clock-wise. + /// Flipping direction. True is clockwise. /// /// preview public bool ClockWise @@ -281,10 +281,10 @@ namespace ElmSharp Size _end; /// - /// Creates and initializes a new instance of FlipEffect class. + /// Creates and initializes a new instance of the ResizingEffect class. /// - /// The begin Size of the effect - /// The end Size of the effect + /// The begin size of the effect. + /// The end size of the effect. /// preview public ResizingEffect(Size beginSize, Size endSize) { @@ -293,7 +293,7 @@ namespace ElmSharp } /// - /// The begin Size of the effect + /// The begin size of the effect. /// /// preview public Size BeginSize @@ -302,7 +302,7 @@ namespace ElmSharp } /// - /// The end Size of the effect + /// The end size of the effect. /// /// preview public Size EndSize @@ -326,10 +326,10 @@ namespace ElmSharp float _end; /// - /// Creates and initializes a new instance of RotationEffect class. + /// Creates and initializes a new instance of the RotationEffect class. /// - /// The begin degree of the effect - /// The end degree of the effect + /// The begin degree of the effect. + /// The end degree of the effect. /// preview public RotationEffect(float beginDegree, float endDegree) { @@ -338,7 +338,7 @@ namespace ElmSharp } /// - /// The begin degree of the effect + /// The begin degree of the effect. /// /// preview public float BeginDegree @@ -347,7 +347,7 @@ namespace ElmSharp } /// - /// The end degree of the effect + /// The end degree of the effect. /// /// preview public float EndDegree @@ -371,10 +371,10 @@ namespace ElmSharp Point _end; /// - /// Creates and initializes a new instance of FlipEffect class. + /// Creates and initializes a new instance of the TranslationEffect class. /// - /// The begin Point of the effect - /// The end Point of the effect + /// The begin point of the effect. + /// The end point of the effect. /// preview public TranslationEffect(Point beginPoint, Point endPoint) { @@ -383,7 +383,7 @@ namespace ElmSharp } /// - /// The begin Point of the effect + /// The begin point of the effect. /// /// preview public Point BeginPoint @@ -392,7 +392,7 @@ namespace ElmSharp } /// - /// The end Point of the effect + /// The end point of the effect. /// /// preview public Point EndPoint @@ -416,10 +416,10 @@ namespace ElmSharp WipeDirection _direction; /// - /// Creates and initializes a new instance of WipeEffect class. + /// Creates and initializes a new instance of the WipeEffect class. /// /// Wipe type. Hide or show. - /// Wipe Direction. + /// Wipe direction. /// preview public WipeEffect(WipeType type, WipeDirection direction) { @@ -437,7 +437,7 @@ namespace ElmSharp } /// - /// Wipe Direction. + /// Wipe direction. /// /// preview public WipeDirection Direction @@ -461,10 +461,10 @@ namespace ElmSharp float _end; /// - /// Creates and initializes a new instance of ZoomEffect class. + /// Creates and initializes a new instance of the ZoomEffect class. /// - /// The begin rate of the effect - /// The end rate of the effect + /// The begin rate of the effect. + /// The end rate of the effect. /// preview public ZoomEffect(float beginRate, float endRate) { @@ -473,7 +473,7 @@ namespace ElmSharp } /// - /// The begin rate of the effect + /// The begin rate of the effect. /// /// preview public float BeginRate @@ -482,7 +482,7 @@ namespace ElmSharp } /// - /// The end rate of the effect + /// The end rate of the effect. /// /// preview public float EndRate diff --git a/src/ElmSharp/ElmSharp/Utility.cs b/src/ElmSharp/ElmSharp/Utility.cs index 49877a1..4884f47 100755 --- a/src/ElmSharp/ElmSharp/Utility.cs +++ b/src/ElmSharp/ElmSharp/Utility.cs @@ -17,7 +17,7 @@ namespace ElmSharp { /// - /// This class is a static class for a utility methods. + /// This class is a static class for utility methods. /// /// preview public static class Utility @@ -43,7 +43,7 @@ namespace ElmSharp } /// - /// Removes all font paths loaded into memory by evas_font_path_app_* APIs for the application. + /// Removes all font paths loaded into the memory by evas_font_path_app_* APIs for the application. /// /// preview public static void ClearEvasGlobalFontPath() @@ -52,21 +52,21 @@ namespace ElmSharp } /// - /// Sets Edje color class. + /// Sets the Edje color class. /// - /// Color class - /// Object Red value - /// Object Red value - /// Object Red value - /// Object Red value - /// Outline Red value - /// Outline Green value - /// Outline Blue value - /// Outline Alpha value - /// Shadow Red value - /// Shadow Green value - /// Shadow Bluevalue - /// Shadow Alpha value + /// Color class. + /// Object red value. + /// Object green value. + /// Object blue value. + /// Object alpha value. + /// Outline red value. + /// Outline green value. + /// Outline blue value. + /// Outline alpha value. + /// Shadow red value. + /// Shadow green value. + /// Shadow blue value. + /// Shadow alpha value. /// /// preview public static bool SetEdjeColorClass(string colorClass, int red, int green, int blue, int alpha, int outlineRed, int outlineGreen, int outlineBlue, int outlineAlpha, @@ -76,21 +76,21 @@ namespace ElmSharp } /// - /// Gets Edje color class. + /// Gets the Edje color class. /// - /// Color class - /// Object Red value - /// Object Red value - /// Object Red value - /// Object Red value - /// Outline Red value - /// Outline Green value - /// Outline Blue value - /// Outline Alpha value - /// Shadow Red value - /// Shadow Green value - /// Shadow Bluevalue - /// Shadow Alpha value + /// Color class. + /// Object red value. + /// Object green value. + /// Object blue value. + /// Object alpha value. + /// Outline red value. + /// Outline green value. + /// Outline blue value. + /// Outline alpha value. + /// Shadow red value. + /// Shadow green value. + /// Shadow blue value. + /// Shadow alpha value. /// /// preview public static bool GetEdjeColorClass(string colorClass, out int red, out int green, out int blue, out int alpha, out int outlineRed, out int outlineGreen, out int outlineBlue, @@ -101,7 +101,7 @@ namespace ElmSharp } /// - /// Processes all queued up edje messages. + /// Processes all the queued up edje messages. /// This function triggers the processing of messages addressed to any (alive) edje objects. /// /// preview @@ -113,10 +113,10 @@ namespace ElmSharp /// /// Sets the Edje text class. /// - /// The text class name - /// The font name - /// The font size - /// True, on success or false, on error + /// The text class name. + /// The font name. + /// The font size. + /// True on success, or False on error. /// preview public static bool SetEdjeTextClass(string textClass, string font, int size) { @@ -126,10 +126,10 @@ namespace ElmSharp /// /// Gets the Edje text class. /// - /// The text class name - /// The font name - /// The font size - /// True, on success or false, on error + /// The text class name. + /// The font name. + /// The font size. + /// True on success, or False on error. /// preview public static bool GetEdjeTextClass(string textClass, out string font, out int size) { @@ -139,7 +139,7 @@ namespace ElmSharp /// /// Delete the text class. /// - /// + /// The text class name. /// preview public static void DeleteEdjeTextClass(string textClass) { @@ -147,12 +147,12 @@ namespace ElmSharp } /// - /// Pre-multiplies a rgb triplet by an alpha factor. + /// Pre-multiplies the RGB triplet by an alpha factor. /// - /// The alpha factor - /// The Red component of the color - /// The Green component of the color - /// The Blue component of the color + /// The alpha factor. + /// The red component of the color. + /// The green component of the color. + /// The blue component of the color. /// preview public static void PremulityplyEvasColorByAlpha(int alpha, ref int red, ref int green, ref int blue) { @@ -160,12 +160,12 @@ namespace ElmSharp } /// - /// Undoes pre-multiplies a rgb triplet by an alpha factor. + /// Undoes pre-multiplication of the RGB triplet by an alpha factor. /// - /// The alpha factor - /// The Red component of the color - /// The Green component of the color - /// The Blue component of the color + /// The alpha factor. + /// The red component of the color. + /// The green component of the color. + /// The blue component of the color. /// preview public static void UnPremulityplyEvasColorByAlpha(int alpha, ref int red, ref int green, ref int blue) { diff --git a/src/ElmSharp/ElmSharp/Widget.cs b/src/ElmSharp/ElmSharp/Widget.cs index 1649192..397e349 100755 --- a/src/ElmSharp/ElmSharp/Widget.cs +++ b/src/ElmSharp/ElmSharp/Widget.cs @@ -27,38 +27,38 @@ namespace ElmSharp public enum FocusDirection { /// - /// Previous direction + /// Previous direction. /// Previous, /// - /// Next direction + /// Next direction. /// Next, /// - /// Up direction + /// Up direction. /// Up, /// - /// Down direction + /// Down direction. /// Down, /// - /// Right direction + /// Right direction. /// Right, /// - /// Left direction + /// Left direction. /// Left } /// - /// The Widget is abstract class, it is the parent of other widgets. + /// The Widget is an abstract class and the parent of other widgets. /// Inherits from . /// /// preview @@ -73,7 +73,7 @@ namespace ElmSharp internal int _opacity = Color.Default.A; /// - /// Creates and initializes a new instance of Widget class. + /// Creates and initializes a new instance of the Widget class. /// /// preview protected Widget() @@ -83,17 +83,17 @@ namespace ElmSharp /// /// Creates and initializes a new instance of the Widget class. /// - /// The parent of new Widget instance + /// The parent of the new Widget instance. /// preview protected Widget(EvasObject parent) : base(parent) { } /// - /// Update the part contents + /// Updates the part contents. /// - /// The content which put to the part - /// The updated part + /// The content which is put into the part. + /// The updated part. /// preview protected void UpdatePartContents(EvasObject content, string part = "__default__") { @@ -159,7 +159,7 @@ namespace ElmSharp /// /// Gets whether a widget is focusable or not. /// - /// Widgets which are meant to be interacted with by input events are created able to be focused, by default + /// Widgets which are meant to be interacted with by input events, are created able to be focused by default. /// preview public bool IsFocusAllowed { @@ -172,7 +172,7 @@ namespace ElmSharp /// /// Sets or gets the text of the widget. /// - /// It could be override by special child class + /// It could be overridden by special child class. /// preview public virtual string Text { @@ -189,7 +189,7 @@ namespace ElmSharp /// /// Sets or gets the background color of the widget. /// - /// It could be override by special child class + /// It could be overridden by special child class. /// preview public virtual Color BackgroundColor { @@ -218,7 +218,7 @@ namespace ElmSharp /// /// Sets or gets the opacity of the widget. /// - /// It could be override by special child class + /// It could be overridden by special child class. /// preview public virtual int Opacity { @@ -271,7 +271,7 @@ namespace ElmSharp /// /// Sets or gets the widget's mirrored mode setting. - /// When widget set automatic mode(true), it follows the system mirrored mode. + /// When widget is set to automatic mode(true), it follows the system mirrored mode. /// /// preview public bool IsAutoMirroredMode @@ -289,7 +289,7 @@ namespace ElmSharp /// /// Sets the widget to be focused or not. /// - /// Weather be focused + /// Whether be focused. /// preview public void SetFocus(bool isFocus) { @@ -299,7 +299,7 @@ namespace ElmSharp /// /// Sets the ability for a widget to be focused. /// - /// True if the object can be focused, false if not(and on errors) + /// true if the object can be focused, false if not(and on errors). /// preview public void AllowFocus(bool isAllowFocus) { @@ -307,9 +307,9 @@ namespace ElmSharp } /// - /// Gives focus to next widget in widget tree. + /// Gives focus to the next widget in the widget tree. /// - /// Direction to move the focus + /// Direction to move the focus. /// preview public void FocusNext(FocusDirection direction) { @@ -317,10 +317,10 @@ namespace ElmSharp } /// - /// Set next widget with specific focus direction. + /// Sets the next widget with specific focus direction. /// - /// Focus next widget - /// Focus direction + /// Focus next widget. + /// Focus direction. /// preview public void SetNextFocusObject(EvasObject next, FocusDirection direction) { @@ -328,10 +328,10 @@ namespace ElmSharp } /// - /// Sets content to particular part of the widget, and the preserve old content will not be unset. + /// Sets content to the particular part of the widget, and the preserve old content will not be unset. /// - /// The name of particular part - /// The content + /// The name of the particular part. + /// The content. /// /// preview public virtual bool SetPartContent(string part, EvasObject content) @@ -340,10 +340,10 @@ namespace ElmSharp } /// - /// Sets content to particular part of the widget. + /// Sets content to the particular part of the widget. /// - /// The name of particular part - /// The content + /// The name of the particular part. + /// The content. /// true, preserve old content will be unset. false, preserve old content will not be unset. /// /// preview @@ -361,7 +361,7 @@ namespace ElmSharp /// /// Sets content to the widget, and the preserve old content will not be unset. /// - /// The content + /// The content. /// /// preview public void SetContent(EvasObject content) @@ -370,9 +370,9 @@ namespace ElmSharp } /// - /// Sets content the widget. + /// Sets content to the widget. /// - /// The content + /// The content. /// true, preserve old content will be unset. false, preserve old content will not be unset. /// /// preview @@ -388,10 +388,10 @@ namespace ElmSharp } /// - /// Sets text to particular part of the widget. + /// Sets text to the particular part of the widget. /// - /// The name of particular part - /// The text + /// The name of the particular part. + /// The text. /// preview public virtual bool SetPartText(string part, string text) { @@ -402,8 +402,8 @@ namespace ElmSharp /// /// Gets text of a particular part of the widget. /// - /// The name of particular part - /// Text of the particular part of the widget + /// The name of the particular part. + /// Text of the particular part of the widget. /// preview public virtual string GetPartText(string part) { @@ -413,9 +413,9 @@ namespace ElmSharp /// /// Sets color of a particular part of the widget. /// - /// The name of particular part - /// The color be set to widget - /// This method is a virtual method, it could be override by special child class + /// The name of the particular part. + /// The color to be set to the widget. + /// This method is a virtual method, it could be overridden by special child class. /// preview public virtual void SetPartColor(string part, Color color) { @@ -428,9 +428,9 @@ namespace ElmSharp /// /// Gets color of the particular part of the widget. /// - /// The name of particular part - /// The color of the particular part - /// This method is a virtual method, it could be override by special child class + /// The name of the particular part. + /// The color of the particular part. + /// This method is a virtual method, it could be overridden by special child class. /// preview public virtual Color GetPartColor(string part) { @@ -442,8 +442,8 @@ namespace ElmSharp /// /// Sets opacity of the particular part of the widget. /// - /// The name of particular part - /// The opacity of the particular part + /// The name of the particular part. + /// The opacity of the particular part. /// preview public void SetPartOpacity(string part, int opacity) { @@ -453,8 +453,8 @@ namespace ElmSharp /// /// Gets opacity of the particular part of the widget. /// - /// The name of particular part - /// Opacity value of the particular part + /// The name of the particular part. + /// Opacity value of the particular part. /// preview public int GetPartOpacity(string part) { @@ -464,7 +464,7 @@ namespace ElmSharp } /// - /// Send a signal to the edje object of the widget. + /// Sends a signal to the edje object of the widget. /// /// The signal's name. /// The signal's source. @@ -475,7 +475,7 @@ namespace ElmSharp } /// - /// The callback of Realized Event + /// The callback of the Realized event. /// /// preview protected override void OnRealized() diff --git a/src/ElmSharp/ElmSharp/Window.cs b/src/ElmSharp/ElmSharp/Window.cs index 6c147dd..c716671 100755 --- a/src/ElmSharp/ElmSharp/Window.cs +++ b/src/ElmSharp/ElmSharp/Window.cs @@ -28,39 +28,39 @@ namespace ElmSharp public enum DisplayRotation { /// - /// Rotation value of window is 0 degree + /// Rotation value of the window is 0 degree. /// Degree_0 = 1, /// - /// Rotation value of window is 90 degree + /// Rotation value of the window is 90 degrees. /// Degree_90 = 2, /// - /// Rotation value of window is 180 degree + /// Rotation value of the window is 180 degrees. /// Degree_180 = 4, /// - /// Rotation value of window is 270 degree + /// Rotation value of the window is 270 degrees. /// Degree_270 = 8 }; /// - /// Enumeration for the indicator opacity + /// Enumeration for the indicator opacity. /// /// preview public enum StatusBarMode { /// - /// Opacifies the status bar + /// Opacifies the status bar. /// Opaque = 1, /// - /// Be translucent the status bar + /// Be translucent the status bar. /// /// /// Not supported. @@ -68,20 +68,20 @@ namespace ElmSharp Translucent = 2, /// - /// Transparentizes the status bar + /// Transparentizes the status bar. /// Transparent = 3, } /// - /// Enumeration for the keygrab modes of window. + /// Enumeration for the keygrab modes of the window. /// /// preview [EditorBrowsable(EditorBrowsableState.Never)] public enum KeyGrabMode { /// - /// Unknown keygrab mode + /// Unknown keygrab mode. /// Shared = 256, @@ -91,12 +91,12 @@ namespace ElmSharp Topmost = 512, /// - /// Getting the grabbed-key only when window is top of the stack. + /// Getting the grabbed-key only when the window is top of the stack. /// Exclusive = 1024, /// - /// Getting the grabbed-key exclusively regardless of window's position. + /// Getting the grabbed-key exclusively regardless of the window's position. /// OverrideExclusive = 2048, } @@ -124,100 +124,100 @@ namespace ElmSharp }; /// - /// Enumeration for the keyboard mode + /// Enumeration for the keyboard mode. /// /// preview public enum KeyboardMode { /// - /// Unknown keyboard state + /// Unknown keyboard state. /// Unknown, /// - /// Request to deactivate the keyboard + /// Request to deactivate the keyboard. /// Off, /// - /// Enable keyboard with default layout + /// Enable keyboard with default layout. /// On, /// - /// Alpha (a-z) keyboard layout + /// Alpha (a-z) keyboard layout. /// Alpha, /// - /// Numeric keyboard layout + /// Numeric keyboard layout. /// Numeric, /// - /// PIN keyboard layout + /// Pin keyboard layout. /// Pin, /// - /// Phone keyboard layout + /// Phone keyboard layout. /// PhoneNumber, /// - /// Hexadecimal numeric keyboard layout + /// Hexadecimal numeric keyboard layout. /// Hex, /// - /// Full (QWERTY) keyboard layout + /// Full (QWERTY) keyboard layout. /// QWERTY, /// - /// Password keyboard layout + /// Password keyboard layout. /// Password, /// - /// IP keyboard layout + /// IP keyboard layout. /// IP, /// - /// Host keyboard layout + /// Host keyboard layout. /// Host, /// - /// File keyboard layout + /// File keyboard layout. /// File, /// - /// URL keyboard layout + /// URL keyboard layout. /// URL, /// - /// Keypad layout + /// Keypad layout. /// Keypad, /// - /// J2ME keyboard layout + /// J2ME keyboard layout. /// J2ME, }; /// - /// Enumeration for the window type + /// Enumeration for the window type. /// /// preview public enum WindowType { /// - /// Unknown + /// Unknown. /// Unknown, @@ -272,12 +272,12 @@ namespace ElmSharp PopupMenu, /// - /// The window is a tooltip. A short piece of explanatory text that typically appear after the mouse cursor hovers over an object for a while. + /// The window is a tooltip. A short piece of explanatory text that typically appears after the mouse cursor hovers over an object for a while. /// Tooltip, /// - /// A notification window, like a warning about battery life or a new E-Mail received. + /// A notification window, like a warning about battery life or a new e-mail received. /// Notification, @@ -287,13 +287,13 @@ namespace ElmSharp Combo, /// - /// Used to indicate the window is a representation of an object being dragged across different windows, or even applications. + /// Used to indicate the window as a representation of an object being dragged across different windows, or even applications. /// DragAndDrop, /// /// The window is rendered onto an image buffer. No actual window is created for this type, instead the window and all of its contents will be rendered to an image buffer. - /// This allows to have children window inside a parent one just like any other object would be, and do other things like applying Evas_Map effects to it. + /// This allows to have children windows inside a parent one just like any other object would be, and do other things like applying Evas_Map effects to it. /// InlinedImage, @@ -310,7 +310,7 @@ namespace ElmSharp }; /// - /// The Window is container that contain the graphical user interface of a program. + /// The Window is a container that contains the graphical user interface of a program. /// /// preview public class Window : Widget @@ -332,15 +332,15 @@ namespace ElmSharp /// Creates and initializes a new instance of the Window class. /// /// - /// Parent widget which this widow created on. + /// Parent widget which this window is created on. /// /// /// Window name. /// /// - /// Window constructor.show window indicator,set callback - /// When closing the window in any way outside the program control, - /// and set callback when window rotation changed. + /// Window constructor.show window indicator, set callback + /// when closing the window in any way outside the program control, + /// and set callback when window rotation is changed. /// /// preview public Window(Window parent, string name) : this(parent, name, WindowType.Basic) @@ -351,18 +351,18 @@ namespace ElmSharp /// Creates and initializes a new instance of the Window class. /// /// - /// Parent widget which this widow created on. + /// Parent widget which this window is created on. /// /// /// Window name. /// /// - /// Window type + /// Window type. /// /// - /// Window constructor.show window indicator,set callback - /// When closing the window in any way outside the program control, - /// and set callback when window rotation changed. + /// Window constructor.show window indicator, set callback + /// when closing the window in any way outside the program control, + /// and set callback when window rotation is changed. /// /// preview public Window(Window parent, string name, WindowType type) @@ -387,31 +387,31 @@ namespace ElmSharp } /// - /// CloseRequested will be triggered when Window close. + /// CloseRequested will be triggered when window is closed. /// /// preview public event EventHandler CloseRequested; /// - /// RotationChanged will be triggered when Window do rotation. + /// RotationChanged will be triggered when window is rotated. /// /// preview public event EventHandler RotationChanged; /// - /// Sets or gets Window name. + /// Sets or gets the window name. /// /// preview public string Name { get; set; } /// - /// Gets the Window type. + /// Gets the window type. /// /// preview public WindowType Type { get; } = WindowType.Basic; /// - /// Gets Window size with Size value(w,h) + /// Gets the window size with Size value(w,h) /// /// preview public Size ScreenSize @@ -425,7 +425,7 @@ namespace ElmSharp } /// - /// Gets the screen dpi for the screen that a Window is on. + /// Gets the screen dpi for the screen that the window is on. /// /// preview public Point ScreenDpi @@ -439,7 +439,7 @@ namespace ElmSharp } /// - /// Gets the rotation of the Window.The rotation of the window in degrees (0-360). + /// Gets the rotation of the window. The rotation of the window in degrees (0-360). /// /// preview public int Rotation @@ -451,7 +451,7 @@ namespace ElmSharp } /// - /// Gets whether window manager supports window rotation or not. + /// Gets whether the window manager supports window rotation or not. /// /// preview public bool IsRotationSupported @@ -463,14 +463,14 @@ namespace ElmSharp } /// - /// Sets or gets available rotation degree. + /// Sets or gets the available rotation degree. /// /// preview [Obsolete("Sorry, it's error typo of AvailableRotations, please use AvailableRotations")] public DisplayRotation AavailableRotations { get; set; } /// - /// Sets or gets available rotation degree. + /// Sets or gets the available rotation degree. /// /// preview public DisplayRotation AvailableRotations @@ -492,7 +492,7 @@ namespace ElmSharp } /// - /// Sets or gets whether auto deletion function is enable. + /// Sets or gets whether the auto deletion function is enabled. /// /// /// If you enable auto deletion, the window is automatically destroyed after the signal is emitted. @@ -512,10 +512,10 @@ namespace ElmSharp } /// - /// Sets or gets the alpha channel state of a window. + /// Sets or gets the alpha channel state of the window. /// /// - /// True if the window alpha channel is enabled, false otherwise. + /// true if the window alpha channel is enabled, false otherwise. /// If alpha is true, the alpha channel of the canvas will be enabled possibly making parts of the window completely or partially transparent. /// /// preview @@ -551,7 +551,7 @@ namespace ElmSharp } /// - /// Sets or gets the mode of status bar. + /// Sets or gets the mode of the status bar. /// /// preview public StatusBarMode StatusBarMode @@ -567,7 +567,7 @@ namespace ElmSharp } /// - /// Sets or gets the iconified state of a window. + /// Sets or gets the iconified state of the window. /// /// preview [EditorBrowsable(EditorBrowsableState.Never)] @@ -601,7 +601,7 @@ namespace ElmSharp } /// - /// Gets or sets the aspect ratio of a window. + /// Gets or sets the aspect ratio of the window. /// /// preview public double Aspect @@ -633,7 +633,7 @@ namespace ElmSharp } /// - /// Get the borderless state of a window. + /// Gets the borderless state of the window. /// This function requests the Window Manager to not draw any decoration around the window. /// /// preview @@ -650,7 +650,7 @@ namespace ElmSharp } /// - /// Gets or sets the demand attention state of a window. + /// Gets or sets the demand attention state of the window. /// /// preview public bool DemandAttention @@ -666,7 +666,7 @@ namespace ElmSharp } /// - /// Gets or sets the floating mode of a window. + /// Gets or sets the floating mode of the window. /// /// preview public bool FloatingMode @@ -699,7 +699,7 @@ namespace ElmSharp } /// - /// Gets or sets the enabled status for the focus highlight in a window. + /// Gets or sets the enabled status for the focus highlight in the window. /// This function will enable or disable the focus highlight only for the given window, regardless of the global setting for it. /// /// preview @@ -717,7 +717,7 @@ namespace ElmSharp /// /// Gets or sets the style for the focus highlight on this window. - /// Sets the style to use for theming the highlight of focused objects on the given window.If style is NULL, the default will be used. + /// Sets the style to use for theming the highlight of focused objects on the given window. If style is NULL, the default will be used. /// /// preview public string FocusHighlightStyle @@ -733,7 +733,7 @@ namespace ElmSharp } /// - /// Get the keyboard mode of the window. + /// Gets the keyboard mode of the window. /// /// preview public KeyboardMode KeyboardMode @@ -751,7 +751,7 @@ namespace ElmSharp /// /// Gets or sets the layer of the window. /// What this means exactly will depend on the underlying engine used. - /// In the case of X11 backed engines, the value in layer has the following meanings + /// In the case of X11 backed engines, the value in layer has the following meanings: /// less than 3 means that the window will be placed below all others, /// more than 5 means that the window will be placed above all others, /// and anything else means that the window will be placed in the default layer. @@ -770,7 +770,7 @@ namespace ElmSharp } /// - /// Gets or sets the modal state of a window. + /// Gets or sets the modal state of the window. /// /// preview public bool Modal @@ -786,8 +786,8 @@ namespace ElmSharp } /// - /// Gets or sets the noblank property of a window. - /// This is a way to request the display on which the windowis shown does not blank, screensave or otherwise hide or obscure the window.It is intended for uses such as media playback on a television where a user may not want to be interrupted by an idle screen. + /// Gets or sets the noblank property of the window. + /// This is a way to request the display on which the window is shown is not blank, screensave, or otherwise hidden or obscure. It is intended for use such as media playback on a television where a user may not want to be interrupted by an idle screen. /// The noblank property may have no effect if the window is iconified/minimized or hidden. /// /// preview @@ -804,7 +804,7 @@ namespace ElmSharp } /// - /// Get the profile of a window. + /// Gets the profile of the window. /// /// preview public string Profile @@ -820,8 +820,8 @@ namespace ElmSharp } /// - /// Get the constraints on the maximum width and height of a window relative to the width and height of its screen. - /// When this function returns true, obj will never resize larger than the screen. + /// Gets the constraints on the maximum width and height of the window relative to the width and height of its screen. + /// When this function returns true, object will never resize larger than the screen. /// /// preview public bool ScreenConstrain @@ -837,7 +837,7 @@ namespace ElmSharp } /// - /// Gets or sets the base size of a window. + /// Gets or sets the base size of the window. /// /// preview public Size BaseSize @@ -855,7 +855,7 @@ namespace ElmSharp } /// - /// Gets or sets the step size of a window. + /// Gets or sets the step size of the window. /// /// preview public Size StepSize @@ -873,7 +873,7 @@ namespace ElmSharp } /// - /// Get the screen position X of a window. + /// Gets the screen position X of a window. /// /// preview public int ScreenPositionX @@ -887,7 +887,7 @@ namespace ElmSharp } /// - /// Get the screen position Y of a window. + /// Gets the screen position Y of a window. /// /// preview public int ScreenPositionY @@ -917,7 +917,7 @@ namespace ElmSharp } /// - /// Gets or sets the urgent state of a window. + /// Gets or sets the urgent state of the window. /// /// preview public bool Urgent @@ -933,7 +933,7 @@ namespace ElmSharp } /// - /// Gets or sets the withdrawn state of a window. + /// Gets or sets the withdrawn state of the window. /// /// preview public bool Withdrawn @@ -949,12 +949,12 @@ namespace ElmSharp } /// - /// Create a socket to provide the service for Plug widget. + /// Creates a socket to provide the service for the Plug widget. /// - /// A service 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 + /// 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 creates successful, otherwise false. /// preview public bool CreateServiceSocket(string name, int number, bool systemWide) { @@ -962,7 +962,7 @@ namespace ElmSharp } /// - /// Set the rotation of the window. + /// Sets the rotation of the window. /// /// The rotation of the window, in degrees (0-360), counter-clockwise. /// Resizes the window's contents so that they fit inside the current window geometry. @@ -976,10 +976,10 @@ namespace ElmSharp } /// - /// Set the window to be skipped by focus. + /// Sets the window to be skipped by focus. /// This sets the window to be skipped by normal input. - /// This means a window manager will be asked to not focus this window as well as omit it from things like the taskbar, pager etc. - /// Call this and enable it on a window BEFORE you show it for the first time, otherwise it may have no effect. + /// This means the Windows Manager will be asked to not focus this window as well as omit it from things like the taskbar, pager etc. + /// Call this and enable it on the window BEFORE you show it for the first time, otherwise it may have no effect. /// Use this for windows that have only output information or might only be interacted with by the mouse or fingers, and never for typing input. /// Be careful that this may have side-effects like making the window non-accessible in some cases unless the window is specially handled. Use this with care. /// @@ -990,8 +990,8 @@ namespace ElmSharp } /// - /// Pull up the window object. - /// Places the window pointed by obj at the top of the stack, so that it's not covered by any other window. + /// Pulls up the window object. + /// Places the window pointed by object at the top of the stack, so that it's not covered by any other window. /// /// preview public void PullUp() @@ -1000,8 +1000,8 @@ namespace ElmSharp } /// - /// Bring down the window object. - /// Places the window pointed by obj at the bottom of the stack, so that no other window is covered by it. + /// Brings down the window object. + /// Places the window pointed by object at the bottom of the stack, so that no other window is covered by it. /// /// preview public void BringDown() @@ -1010,11 +1010,11 @@ namespace ElmSharp } /// - /// This function sends a request to the Windows Manager to activate the Window. - /// If honored by the WM, the window receives the keyboard focus. + /// This function sends a request to the Windows Manager to activate the window. + /// If honored by the Windows Manager, the window receives the keyboard focus. /// /// - /// This is just a request that a Window Manager may ignore, so calling this function does not ensure + /// This is just a request that the Windows Manager may ignore, so calling this function does not ensure /// in any way that the window is going to be the active one after it. /// /// preview @@ -1024,9 +1024,9 @@ namespace ElmSharp } /// - /// Delete subobj as a resize object of window obj. - /// This function removes the object subobj from the resize objects of the window obj. - /// It will not delete the object itself, which will be left unmanaged and should be deleted by the developer, manually handled or set as child of some other container. + /// Deletes the subobj as a resize object of the window object. + /// This function removes the object subobj from the resize objects of the window object. + /// It will not delete the object itself, which will be left unmanaged and should be deleted by the developer, manually handled, or set as child of some other container. /// /// Resize object. /// preview @@ -1036,12 +1036,12 @@ namespace ElmSharp } /// - /// Adds obj as a resize object of the Window. + /// Adds an object as a resize object of the window. /// /// - /// Setting an object as a resize object of the window means that the obj child's size and - /// position is controlled by the window directly. That is, the obj is resized to match the window size - /// and should never be moved or resized manually by the developer.In addition, + /// Setting an object as a resize object of the window means that the object child's size and + /// position is controlled by the window directly. That is, the object is resized to match the window size + /// and should never be moved or resized manually by the developer. In addition, /// resize objects of the window control the minimum size of it as well as whether it can or cannot be resized by the user. /// /// @@ -1054,11 +1054,11 @@ namespace ElmSharp } /// - /// Set keygrab value of the window. - /// This function grabs the key of window using grab_mode. + /// Sets the keygrab value of the window. + /// This function grabs the key of the window using grab_mode. /// /// The keyname to grab. - /// According to the grabmode, it can grab key differently + /// According to the grabmode, it can grab key differently. /// preview [EditorBrowsable(EditorBrowsableState.Never)] public void WinKeyGrab(string keyname, KeyGrabMode mode) @@ -1067,8 +1067,8 @@ namespace ElmSharp } /// - /// Unset keygrab value of the window. - /// This function unset keygrab value.Ungrab key of window. + /// Unsets the keygrab value of the window. + /// This function unsets keygrab value. Ungrab key of the window. /// /// The keyname to grab. /// preview @@ -1079,9 +1079,9 @@ namespace ElmSharp } /// - /// Set the keygrab of the window. + /// Sets the keygrab of the window. /// - /// keyname string to set keygrab + /// The keyname string to set keygrab. /// preview public void KeyGrabEx(string keyname) { @@ -1089,9 +1089,9 @@ namespace ElmSharp } /// - /// Unset the keygrab of the window. + /// Unsets the keygrab of the window. /// - /// keyname string to unset keygrab + /// The keyname string to unset keygrab. /// preview public void KeyUngrabEx(string keyname) { @@ -1101,8 +1101,8 @@ namespace ElmSharp /// /// Creates a widget handle. /// - /// Parent EvasObject - /// Handle IntPtr + /// Parent EvasObject. + /// Handle IntPtr. /// preview protected override IntPtr CreateHandle(EvasObject parent) { diff --git a/src/ElmSharp/ElmSharp/WrapType.cs b/src/ElmSharp/ElmSharp/WrapType.cs index 6c3c09f..2fccafa 100755 --- a/src/ElmSharp/ElmSharp/WrapType.cs +++ b/src/ElmSharp/ElmSharp/WrapType.cs @@ -19,7 +19,7 @@ using System; namespace ElmSharp { /// - /// Enumeration for the wrap type. + /// Enumeration for the wrap types. /// /// preview public enum WrapType @@ -33,12 +33,12 @@ namespace ElmSharp /// Char, /// - /// Word wrap - wrap within the allowed wrapping points + /// Word wrap - wrap within the allowed wrapping points. /// (as defined in the unicode standard). /// Word, /// - /// Mixed wrap - Word wrap, if that fails, char wrap. + /// Mixed wrap - word wrap, if that fails, char wrap. /// Mixed } diff --git a/src/ElmSharp/Interop/Interop.Elementary.Entry.cs b/src/ElmSharp/Interop/Interop.Elementary.Entry.cs index 0eda07a..a9ede67 100755 --- a/src/ElmSharp/Interop/Interop.Elementary.Entry.cs +++ b/src/ElmSharp/Interop/Interop.Elementary.Entry.cs @@ -22,7 +22,7 @@ internal static partial class Interop internal static partial class Elementary { /// - /// Types of "Enter" keys available for different keyboards layout + /// Types of "Enter" keys available for different keyboard layouts. /// public enum ReturnKeyType {