Merge "[Nsd] Fix XML documentation warnings" preview1-00266
authorchleun.moon <chleun.moon@samsung.com>
Thu, 28 Sep 2017 09:03:06 +0000 (09:03 +0000)
committerGerrit Code Review <gerrit@review.ap-northeast-2.compute.internal>
Thu, 28 Sep 2017 09:03:06 +0000 (09:03 +0000)
13 files changed:
src/ElmSharp/ElmSharp/EcoreEvent.cs
src/ElmSharp/ElmSharp/EvasObjectEvent.cs
src/ElmSharp/ElmSharp/GenItemClass.cs
src/ElmSharp/ElmSharp/IAccessibleObject.cs
src/ElmSharp/ElmSharp/SmartEvent.cs
src/ElmSharp/ElmSharp/Transit.cs
src/Tizen.Multimedia.Camera/Camera/Camera.cs [changed mode: 0755->0644]
src/Tizen.Multimedia.Camera/Camera/CameraException.cs [changed mode: 0755->0644]
src/Tizen.Multimedia.Camera/Camera/IPreviewPlane.cs [changed mode: 0755->0644]
src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod.csproj
src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/DisplayLanguageChangedEventArgs.cs [moved from src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/DisplayLanaguageChangedEventArgs.cs with 87% similarity, mode: 0644]
src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/InputMethodDeviceInformation.cs
src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/InputMethodEditor.cs

index 35def22..577ec71 100755 (executable)
@@ -204,7 +204,7 @@ namespace ElmSharp
         }
 
         /// <summary>
-        /// Destroy Current Obj
+        /// Destroy current object
         /// </summary>
         public void Dispose()
         {
index ac70309..eb08d77 100755 (executable)
@@ -328,6 +328,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)
@@ -348,6 +355,9 @@ namespace ElmSharp
             }
         }
 
+        /// <summary>
+        /// Destroy current object
+        /// </summary>
         public void Dispose()
         {
             Dispose(true);
@@ -433,6 +443,13 @@ namespace ElmSharp
             _handlers?.Invoke(sender, e);
         }
 
+        /// <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)
@@ -445,6 +462,9 @@ namespace ElmSharp
             }
         }
 
+        /// <summary>
+        /// Destroy current object
+        /// </summary>
         public void Dispose()
         {
             Dispose(true);
index f334edf..9f1186e 100755 (executable)
@@ -133,6 +133,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 (_unmanagedPtr != IntPtr.Zero)
@@ -142,6 +149,9 @@ namespace ElmSharp
             }
         }
 
+        /// <summary>
+        /// Destroy current object
+        /// </summary>
         public void Dispose()
         {
             Dispose(true);
index f1488ff..c00e036 100755 (executable)
@@ -21,17 +21,71 @@ namespace ElmSharp.Accessible
     /// </summary>
     public interface IAccessibleObject
     {
+        /// <summary>
+        /// Gets or sets the reading information types of an accessible object.
+        /// </summary>
         ReadingInfoType ReadingInfoType { get; set; }
+
+        /// <summary>
+        /// Gets or sets the role of the object in accessibility domain.
+        /// </summary>
         AccessRole Role { get; set; }
+
+        /// <summary>
+        /// Gets or sets highlightable of given widget.
+        /// </summary>
         bool CanHighlight { get; set; }
+
+        /// <summary>
+        /// 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.
+        /// </summary>
         string TranslationDomain { get; set; }
+
+        /// <summary>
+        /// Gets or sets an accessible name of the object.
+        /// </summary>
         string Name { get; set; }
+
+        /// <summary>
+        /// Gets or sets contextual information about object.
+        /// </summary>
         string Description { get; set; }
+
+        /// <summary>
+        /// Gets or sets the delegate for <see cref="IAccessibleObject.Name"/>.
+        /// </summary>
         AccessibleInfoProvider NameProvider { get; set; }
+
+        /// <summary>
+        /// Gets or sets the delegate for <see cref = "IAccessibleObject.Description" />.
+        /// </summary>
         AccessibleInfoProvider DescriptionProvider { get; set; }
+
+        /// <summary>
+        /// 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 <see cref="FlowsTo"/> from object A to B, do not append relation <see cref="FlowsFrom"/> from object B to object A.
+        /// </summary>
+        /// <param name="relation">The relationship between source object and target object of a given type.</param>
         void AppendRelation(IAccessibleRelation relation);
+
+        /// <summary>
+        /// Removes the relationship between two accessible objects.
+        /// </summary>
+        /// <param name="relation">The relationship between source object and target object of a given type.</param>
         void RemoveRelation(IAccessibleRelation relation);
+
+        /// <summary>
+        /// Highlights accessible widget.
+        /// </summary>
         void Highlight();
+
+        /// <summary>
+        /// Clears highlight of accessible widget.
+        /// </summary>
         void Unhighlight();
     }
 }
index 22aeb2e..0742d0f 100755 (executable)
@@ -133,6 +133,9 @@ namespace ElmSharp
             }
         }
 
+        /// <summary>
+        /// Destroy current object
+        /// </summary>
         public void Dispose()
         {
             Dispose(true);
@@ -148,6 +151,13 @@ namespace ElmSharp
             _handle = IntPtr.Zero;
         }
 
+        /// <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 (disposing)
@@ -235,6 +245,9 @@ namespace ElmSharp
             _handlers?.Invoke(sender, e);
         }
 
+        /// <summary>
+        /// Destroy current object
+        /// </summary>
         public void Dispose()
         {
             Dispose(true);
@@ -249,6 +262,13 @@ namespace ElmSharp
             _smartEvent.MakeInvalidate();
         }
 
+        /// <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 (disposing)
index 018309b..7b79f32 100755 (executable)
@@ -283,18 +283,28 @@ namespace ElmSharp
             Interop.Elementary.elm_transit_effect_add(_handle, EffectTransitionCallback, _effect, EffectEndCallback);
         }
 
+        /// <summary>
+        /// Destroy current object
+        /// </summary>
         public void Dispose()
         {
             Dispose(true);
             GC.SuppressFinalize(this);
         }
 
-        protected virtual void Dispose(bool isDisposing)
+        /// <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 (_isDisposed)
                 return;
 
-            if (isDisposing)
+            if (disposing)
             {
                 ((INotifyCollectionChanged)_chains).CollectionChanged -= OnChaninCollectionChanged;
                 _chains.Clear();
old mode 100755 (executable)
new mode 100644 (file)
index 91f6c64..9ac9378
@@ -71,6 +71,9 @@ namespace Tizen.Multimedia
             Dispose(false);
         }
 
+        /// <summary>
+        /// Gets the native handle of the camera.
+        /// </summary>
         public IntPtr Handle => GetHandle();
 
         internal IntPtr GetHandle()
old mode 100755 (executable)
new mode 100644 (file)
index 40d2a70..e75d678
@@ -18,34 +18,61 @@ using System;
 
 namespace Tizen.Multimedia
 {
+    /// <summary>
+    /// The base exception class that is thrown when specific camera related error occurs.
+    /// </summary>
     public class CameraException : Exception
     {
+        /// <summary>
+        /// Initializes a new instance of the <see cref="CameraException"/> class.
+        /// </summary>
         public CameraException() : base()
         {
         }
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="CameraException"/> class with a specified error message.
+        /// </summary>
         public CameraException(string message) : base(message)
         {
         }
     }
 
+    /// <summary>
+    /// The exception that is thrown when a camera device-related error occurs.
+    /// </summary>
     public class CameraDeviceException : CameraException
     {
+        /// <summary>
+        /// Initializes a new instance of the <see cref="CameraDeviceException"/> class.
+        /// </summary>
         public CameraDeviceException() : base()
         {
         }
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="CameraDeviceException"/> class with a specified error message.
+        /// </summary>
         public CameraDeviceException(string message) : base(message)
         {
         }
     }
 
+    /// <summary>
+    /// The exception that is thrown when a camera device is not available.
+    /// </summary>
     public class CameraDeviceNotFoundException : CameraException
     {
+        /// <summary>
+        /// Initializes a new instance of the <see cref="CameraDeviceNotFoundException"/> class.
+        /// </summary>
         public CameraDeviceNotFoundException() : base()
         {
         }
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="CameraDeviceNotFoundException"/> class with a specified error message.
+        /// </summary>
         public CameraDeviceNotFoundException(string message) : base(message)
         {
         }
old mode 100755 (executable)
new mode 100644 (file)
index d84d07a..8a9dc83
@@ -16,6 +16,9 @@
 
 namespace Tizen.Multimedia
 {
+    /// <summary>
+    /// Provides interface for various preview plane types.
+    /// </summary>
     public interface IPreviewPlane
     {
     }
index 973f027..f47359d 100644 (file)
@@ -10,4 +10,4 @@
     <ProjectReference Include="..\ElmSharp\ElmSharp.csproj" />
   </ItemGroup>
 
-</Project>
\ No newline at end of file
+</Project>
@@ -21,15 +21,15 @@ namespace Tizen.Uix.InputMethod
     /// </summary>
     public class DisplayLanguageChangedEventArgs
     {
-        internal DisplayLanguageChangedEventArgs(string langauage)
+        internal DisplayLanguageChangedEventArgs(string language)
         {
-            Langauage = langauage;
+            Language = language;
         }
 
         /// <summary>
         /// The language code
         /// </summary>
-        public string Langauage
+        public string Language
         {
             get;
             internal set;
index 242e291..51464a8 100755 (executable)
@@ -90,9 +90,9 @@ namespace Tizen.Uix.InputMethod
         /// </summary>
         Palm,
         /// <summary>
-        /// HandSIze
+        /// HandSize
         /// </summary>
-        HandSIze,
+        HandSize,
         /// <summary>
         /// HandFlat
         /// </summary>
index e3e5534..532f3a4 100755 (executable)
@@ -320,7 +320,7 @@ namespace Tizen.Uix.InputMethod
         /// </summary>
         KP9 = 0xFFB9,
 
-        /* Auxilliary Functions */
+        /* Auxiliary Functions */
         /// <summary>
         /// The function 1 key
         /// </summary>
@@ -1647,7 +1647,7 @@ namespace Tizen.Uix.InputMethod
         /// <param name="terminate">This is called when IME application is terminated</param>
         /// <param name="show">
         /// This is called when IME application is shown
-        /// It provides the Context Inofrmation and the Context Id
+        /// It provides the Context Information and the Context Id
         /// </param>
         /// <param name="hide">
         /// This is called when IME application is hidden