[ElmSharp] Fix XML documentation warnings. 59/153259/2
authordarkleem <cdark.lim@samsung.com>
Thu, 28 Sep 2017 06:46:47 +0000 (15:46 +0900)
committerdarkleem <cdark.lim@samsung.com>
Thu, 28 Sep 2017 06:58:33 +0000 (15:58 +0900)
      - Add to missing document

Change-Id: I9cf66dce5b27e8e09abf46c3295ba49e1c9b7029
Signed-off-by: darkleem <cdark.lim@samsung.com>
17 files changed:
src/ElmSharp/ElmSharp/Button.cs
src/ElmSharp/ElmSharp/Calendar.cs
src/ElmSharp/ElmSharp/Color.cs
src/ElmSharp/ElmSharp/Conformant.cs
src/ElmSharp/ElmSharp/Container.cs
src/ElmSharp/ElmSharp/DateTimeSelector.cs
src/ElmSharp/ElmSharp/EcoreEvent.cs
src/ElmSharp/ElmSharp/EcoreTimelineAnimator.cs
src/ElmSharp/ElmSharp/EdjeObject.cs
src/ElmSharp/ElmSharp/EvasCanvas.cs
src/ElmSharp/ElmSharp/EvasMap.cs
src/ElmSharp/ElmSharp/ItemObject.cs
src/ElmSharp/ElmSharp/Point.cs
src/ElmSharp/ElmSharp/Point3D.cs
src/ElmSharp/ElmSharp/Popup.cs
src/ElmSharp/ElmSharp/Rect.cs
src/ElmSharp/ElmSharp/Size.cs

index 69cc6ce..6fe2ae5 100755 (executable)
@@ -134,6 +134,10 @@ namespace ElmSharp
             }
         }
 
+        /// <summary>
+        /// Delete the object color class.
+        /// </summary>
+        /// <param name="part">The color class to be deleted.</param>
         [Obsolete("DeleteColorClass is obsolete, please use EdjeObject.DeleteColorClass(string)")]
         public void DeleteColorClass(string part)
         {
index 7e62e01..7a20c70 100755 (executable)
@@ -256,8 +256,8 @@ namespace ElmSharp
             {
                 var tm = new Interop.Libc.SystemTime();
                 Interop.Elementary.elm_calendar_displayed_time_get(RealHandle, out tm);
-                ///TODO
-                ///If the defect is fixed, it will be removed.
+                // TODO
+                // If the defect is fixed, it will be removed.
                 var daysInMonth = DateTime.DaysInMonth(tm.tm_year + 1900, tm.tm_mon + 1);
                 var day = tm.tm_mday;
 
@@ -292,7 +292,7 @@ namespace ElmSharp
         /// </summary>
         /// <remarks>
         /// The usage should be like this;
-        /// List<string> weekDayNames = new List<string>() { "S", "M", "T", "W", "T", "F", "S" };
+        /// <![CDATA[List<string> weekDayNames = new List<string>() { "S", "M", "T", "W", "T", "F", "S" };]]>
         /// Calendar.WeekDayNames = weekDayNames;
         /// </remarks>
         public IReadOnlyList<string> WeekDayNames
index 9b27f0f..49c48f2 100644 (file)
@@ -109,9 +109,9 @@ namespace ElmSharp
         /// With RGBA parameters.
         /// </summary>
         /// <param name="r">Red of RGBA</param>
-        /// <param name="g">Green of RGBA<</param>
-        /// <param name="b">Blue of RGBA<</param>
-        /// <param name="a">Alpha of RGBA<</param>
+        /// <param name="g">Green of RGBA</param>
+        /// <param name="b">Blue of RGBA</param>
+        /// <param name="a">Alpha of RGBA</param>
         public Color(int r, int g, int b, int a) : this(r, g, b, a, Mode.Rgb)
         {
         }
@@ -132,6 +132,10 @@ namespace ElmSharp
             }
         }
 
+        /// <summary>
+        /// Returns the hash code for this instance.
+        /// </summary>
+        /// <returns>A 32-bit signed integer hash code.</returns>
         public override int GetHashCode()
         {
             int hashcode = _r.GetHashCode();
@@ -141,6 +145,14 @@ namespace ElmSharp
             return hashcode;
         }
 
+        /// <summary>
+        /// Indicates whether this instance and a specified object are equal.
+        /// </summary>
+        /// <param name="obj">The object to compare with the current instance.</param>
+        /// <returns>
+        /// true if obj and this instance are the same type and represent the same value.
+        /// otherwise, false.
+        /// </returns>
         public override bool Equals(object obj)
         {
             if (obj is Color)
@@ -189,6 +201,10 @@ namespace ElmSharp
             return color1._r == color2._r && color1._g == color2._g && color1._b == color2._b && color1._a == color2._a;
         }
 
+        /// <summary>
+        /// Returns the fully qualified type name of this instance.
+        /// </summary>
+        /// <returns>The fully qualified type name.</returns>
         public override string ToString()
         {
             return string.Format(CultureInfo.InvariantCulture, "[Color: R={0}, G={1}, B={2}, A={3}]", R, G, B, A);
index e2a6856..e27838b 100755 (executable)
@@ -21,7 +21,7 @@ namespace ElmSharp
     /// <summary>
     /// The check is a widget that can be used in elementary apps
     /// to account for space taken up by the indicator,
-    /// virtual keypad & softkey windows when running the illume2 module of E17.
+    /// virtual keypad &amp; softkey windows when running the illume2 module of E17.
     /// </summary>
     public class Conformant : Widget
     {
index 6abb589..135c3d3 100755 (executable)
@@ -57,24 +57,43 @@ namespace ElmSharp
             }
         }
 
+        /// <summary>
+        /// Gets the collection of child EvasObject of the Container.
+        /// </summary>
         protected IEnumerable<EvasObject> Children => _children;
 
+        /// <summary>
+        /// Add an EvasObject object as a child of Container.
+        /// </summary>
+        /// <param name="obj">The EvasObject object to be added</param>
         protected void AddChild(EvasObject obj)
         {
             _children.Add(obj);
             obj.Deleted += OnChildDeleted;
         }
 
+        /// <summary>
+        /// Remove an EvasObject object as a child of Container.
+        /// </summary>
+        /// <param name="obj">The EvasObject object to be removed</param>
         protected void RemoveChild(EvasObject obj)
         {
             _children.Remove(obj);
         }
 
+        /// <summary>
+        /// Clear all children of the Container.
+        /// </summary>
         protected void ClearChildren()
         {
             _children.Clear();
         }
 
+        /// <summary>
+        /// The Container Callback that is invoked when a child is removed.
+        /// </summary>
+        /// <param name="sender">The called Container</param>
+        /// <param name="a"><see cref="EventArgs"/></param>
         void OnChildDeleted(object sender, EventArgs a)
         {
             _children.Remove((EvasObject)sender);
index d3acb9c..98d2cbe 100755 (executable)
@@ -23,19 +23,37 @@ namespace ElmSharp
     /// </summary>
     public enum DateTimeFieldType
     {
+        /// <summary>
+        /// Indicates Year field.
+        /// </summary>
         Year,
+        /// <summary>
+        /// Indicates Month field.
+        /// </summary>
         Month,
+        /// <summary>
+        /// Indicates Date field.
+        /// </summary>
         Date,
+        /// <summary>
+        /// Indicates Hour field.
+        /// </summary>
         Hour,
+        /// <summary>
+        /// Indicates Minute field.
+        /// </summary>
         Minute,
+        /// <summary>
+        /// Indicates AM/PM field.
+        /// </summary>
         AmPm
     }
 
     /// <summary>
     /// It inherits <see cref="Layout"/>
-    /// DateTimeSelector is a widget to display and input date & time values.
+    /// DateTimeSelector is a widget to display and input date &amp; 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.
+    /// (Date includes Day, Month &amp; Year along with the defined separators and Time includes Hour, Minute &amp; AM/PM fields. Separator for AM/PM field is ignored.
     /// </summary>
     public class DateTimeSelector : Layout
     {
index e42310c..35def22 100755 (executable)
@@ -104,6 +104,13 @@ namespace ElmSharp
     /// <typeparam name="TEventArgs">Kinds of EventArgs</typeparam>
     public class EcoreEvent<TEventArgs> : IDisposable where TEventArgs : EventArgs
     {
+        /// <summary>
+        /// EventInfoParser delegate of EcoreEvent class
+        /// </summary>
+        /// <param name="data">IntPtr</param>
+        /// <param name="type">EcoreEventType</param>
+        /// <param name="info">IntPtr</param>
+        /// <returns></returns>
         public delegate TEventArgs EventInfoParser(IntPtr data, EcoreEventType type, IntPtr info);
 
         private bool _disposed = false;
@@ -130,6 +137,9 @@ namespace ElmSharp
             _parser = parser;
         }
 
+        /// <summary>
+        /// Destructor for EcoreEvent class.
+        /// </summary>
         ~EcoreEvent()
         {
             Dispose(false);
@@ -169,6 +179,13 @@ namespace ElmSharp
             }
         }
 
+        /// <summary>
+        /// Releases all resources currently used by this instance.
+        /// </summary>
+        /// <param name="disposing">
+        /// true if managed resources should be disposed
+        /// otherwise, false.
+        /// </param>
         protected virtual void Dispose(bool disposing)
         {
             if (!_disposed)
@@ -186,6 +203,9 @@ namespace ElmSharp
             }
         }
 
+        /// <summary>
+        /// Destroy Current Obj
+        /// </summary>
         public void Dispose()
         {
             Dispose(true);
index 8bc0a39..b5a86f8 100644 (file)
@@ -1,9 +1,26 @@
-using System;
-using System.Collections.Generic;
-using System.Text;
+/*
+ * Copyright (c) 2016 Samsung Electronics Co., Ltd All Rights Reserved
+ *
+ * Licensed under the Apache License, Version 2.0 (the License);
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an AS IS BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+using System;
 
 namespace ElmSharp
 {
+    /// <summary>
+    /// EcoreTimelineAnimator is a helper class, it provides functions to manager animations.
+    /// </summary>
     public class EcoreTimelineAnimator
     {
         double _runtime;
@@ -12,9 +29,16 @@ namespace ElmSharp
         Interop.Ecore.EcoreTimelineCallback _nativeCallback;
         double _position;
 
+        /// <summary>
+        /// It occurs when the animator is complete.
+        /// </summary>
         public event EventHandler Finished;
 
-
+        /// <summary>
+        /// Creates and initializes a new instance of the EcoreTimelineAnimator class.
+        /// </summary>
+        /// <param name="runtime">The time to run in seconds</param>
+        /// <param name="timelineCallback">Functions called at each time line</param>
         public EcoreTimelineAnimator(double runtime, Action timelineCallback)
         {
             _runtime = runtime;
@@ -23,31 +47,53 @@ namespace ElmSharp
             _position = 0;
         }
 
+        /// <summary>
+        /// Gets whether the animation is running.
+        /// </summary>
         public bool IsRunning { get; private set; }
+
+        /// <summary>
+        /// Gets the current position of the animation.
+        /// </summary>
         public double Position => _position;
 
+        /// <summary>
+        /// Starts an animator that runs for a limited time.for a limited time.
+        /// </summary>
         public void Start()
         {
             IsRunning = true;
             _animator = Interop.Ecore.ecore_animator_timeline_add(_runtime, _nativeCallback, IntPtr.Zero);
         }
 
+        /// <summary>
+        /// Stops an animator that running.
+        /// </summary>
         public void Stop()
         {
             IsRunning = false;
             _animator = IntPtr.Zero;
         }
 
+        /// <summary>
+        /// Suspends the specified animator.
+        /// </summary>
         public void Freeze()
         {
             Interop.Ecore.ecore_animator_freeze(_animator);
         }
 
+        /// <summary>
+        /// Restores execution of the specified animator.
+        /// </summary>
         public void Thaw()
         {
             Interop.Ecore.ecore_animator_thaw(_animator);
         }
 
+        /// <summary>
+        /// Callback that is called when ticks off
+        /// </summary>
         protected void OnTimeline()
         {
             _timelineCallback();
index 6bd1fb6..b01bc9f 100644 (file)
@@ -206,6 +206,14 @@ namespace ElmSharp
                 Action = action;
             }
 
+            /// <summary>
+            /// Indicates whether this instance and a specified object are equal.
+            /// </summary>
+            /// <param name="obj">The object to compare with the current instance.</param>
+            /// <returns>
+            /// true if obj and this instance are the same type and represent the same value.
+            /// otherwise, false.
+            /// </returns>
             public override bool Equals(object obj)
             {
                 SignalData s = obj as SignalData;
index 95100c3..869a3b1 100755 (executable)
@@ -171,6 +171,14 @@ namespace ElmSharp
                 Action = action;
             }
 
+            /// <summary>
+            /// Indicates whether this instance and a specified object are equal.
+            /// </summary>
+            /// <param name="obj">The object to compare with the current instance.</param>
+            /// <returns>
+            /// true if obj and this instance are the same type and represent the same value.
+            /// otherwise, false.
+            /// </returns>
             public override bool Equals(object obj)
             {
                 EventData e = obj as EventData;
index 405f494..03f5ea3 100755 (executable)
@@ -43,7 +43,7 @@ namespace ElmSharp
         }
 
         /// <summary>
-        /// Destroy the EvasMap object.
+        /// Destructor for the EvasMap class.
         /// </summary>
         ~EvasMap()
         {
index 2c356ec..b4616a4 100755 (executable)
@@ -328,6 +328,14 @@ namespace ElmSharp
                 Func = func;
             }
 
+            /// <summary>
+            /// Indicates whether this instance and a specified object are equal.
+            /// </summary>
+            /// <param name="obj">The object to compare with the current instance.</param>
+            /// <returns>
+            /// true if obj and this instance are the same type and represent the same value.
+            /// otherwise, false.
+            /// </returns>
             public override bool Equals(object obj)
             {
                 SignalData s = obj as SignalData;
index bd033c3..6c7ddd1 100755 (executable)
@@ -54,6 +54,14 @@ namespace ElmSharp
             }
         }
 
+        /// <summary>
+        /// Indicates whether this instance and a specified object are equal.
+        /// </summary>
+        /// <param name="obj">The object to compare with the current instance.</param>
+        /// <returns>
+        /// true if obj and this instance are the same type and represent the same value.
+        /// otherwise, false.
+        /// </returns>
         public override bool Equals(object obj)
         {
             if (!(obj is Point))
@@ -62,6 +70,14 @@ namespace ElmSharp
             return Equals((Point)obj);
         }
 
+        /// <summary>
+        /// Indicates whether this instance and a <see cref="Point"/> object are equal.
+        /// </summary>
+        /// <param name="other">The <see cref="Point"/> to compare with the current instance.</param>
+        /// <returns>
+        /// true if obj and this instance are the same type and represent the same value.
+        /// otherwise, false.
+        /// </returns>
         public bool Equals(Point other)
         {
             return X.Equals(other.X) && Y.Equals(other.Y);
index 62a2007..d7f1bfe 100755 (executable)
@@ -59,6 +59,14 @@ namespace ElmSharp
             }
         }
 
+        /// <summary>
+        /// Indicates whether this instance and a specified object are equal.
+        /// </summary>
+        /// <param name="obj">The object to compare with the current instance.</param>
+        /// <returns>
+        /// true if obj and this instance are the same type and represent the same value.
+        /// otherwise, false.
+        /// </returns>
         public override bool Equals(object obj)
         {
             if (!(obj is Point3D))
@@ -67,6 +75,14 @@ namespace ElmSharp
             return Equals((Point3D)obj);
         }
 
+        /// <summary>
+        /// Indicates whether this instance and a <see cref="Point3D"/> object are equal.
+        /// </summary>
+        /// <param name="other">The <see cref="Point3D"/> to compare with the current instance.</param>
+        /// <returns>
+        /// true if obj and this instance are the same type and represent the same value.
+        /// otherwise, false.
+        /// </returns>
         public bool Equals(Point3D other)
         {
             return X.Equals(other.X) && Y.Equals(other.Y) && Z.Equals(other.Z);
index 6076e4a..91da397 100755 (executable)
@@ -162,7 +162,7 @@ namespace ElmSharp
         /// 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.
-        /// Set a value <= 0.0 to disable a running timer.If the value > 0.0 and the popup is previously visible,
+        /// <![CDATA[Set a value <= 0.0 to disable a running timer.If the value > 0.0 and the popup is previously visible,]]>
         /// the timer will be started with this value, canceling any running timer.
         /// </remarks>
         public double Timeout
index acce92f..ed3d41f 100755 (executable)
@@ -115,6 +115,14 @@ namespace ElmSharp
             }
         }
 
+        /// <summary>
+        /// Indicates whether this instance and a specified object are equal.
+        /// </summary>
+        /// <param name="obj">The object to compare with the current instance.</param>
+        /// <returns>
+        /// true if obj and this instance are the same type and represent the same value.
+        /// otherwise, false.
+        /// </returns>
         public override bool Equals(object obj)
         {
             if (!(obj is Rect))
@@ -123,6 +131,14 @@ namespace ElmSharp
             return Equals((Rect)obj);
         }
 
+        /// <summary>
+        /// Indicates whether this instance and a <see cref="Rect"/> object are equal.
+        /// </summary>
+        /// <param name="other">The <see cref="Rect"/> to compare with the current instance.</param>
+        /// <returns>
+        /// true if obj and this instance are the same type and represent the same value.
+        /// otherwise, false.
+        /// </returns>
         public bool Equals(Rect other)
         {
             return X.Equals(other.X) && Y.Equals(other.Y) && Width.Equals(other.Width) && Height.Equals(other.Height);
index 97aeeef..c7c5a80 100755 (executable)
@@ -65,6 +65,14 @@ namespace ElmSharp
             }
         }
 
+        /// <summary>
+        /// Indicates whether this instance and a specified object are equal.
+        /// </summary>
+        /// <param name="obj">The object to compare with the current instance.</param>
+        /// <returns>
+        /// true if obj and this instance are the same type and represent the same value.
+        /// otherwise, false.
+        /// </returns>
         public override bool Equals(object obj)
         {
             if (!(obj is Size))
@@ -73,6 +81,14 @@ namespace ElmSharp
             return Equals((Size)obj);
         }
 
+        /// <summary>
+        /// Indicates whether this instance and a <see cref="Size"/> object are equal.
+        /// </summary>
+        /// <param name="other">The <see cref="Size"/> to compare with the current instance.</param>
+        /// <returns>
+        /// true if obj and this instance are the same type and represent the same value.
+        /// otherwise, false.
+        /// </returns>
         public bool Equals(Size other)
         {
             return Width.Equals(other.Width) && Height.Equals(other.Height);