Add NamespaceDoc.cs

Change-Id: Icdf3b1f308c206830c79884e0fa1df6db272b1c1
Signed-off-by: Jongkyu Koo <jk.koo@samsung.com>

diff --git a/Tizen.PhonenumberUtils/Tizen.PhonenumberUtils.csproj b/Tizen.PhonenumberUtils/Tizen.PhonenumberUtils.csproj
index 7545d86..c11f53c 100644 (file)
--- a/Tizen.PhonenumberUtils/Tizen.PhonenumberUtils.csproj
+++ b/Tizen.PhonenumberUtils/Tizen.PhonenumberUtils.csproj
@@ -54,6 +54,7 @@
     <Compile Include="Interop\Interop.Libraries.cs" />\r
     <Compile Include="Interop\Interop.PhonenumberUtils.cs" />\r
     <Compile Include="Properties\AssemblyInfo.cs" />\r
+    <Compile Include="Tizen.PhonenumberUtils\NamespaceDoc.cs" />\r
     <Compile Include="Tizen.PhonenumberUtils\PhonenumberUtilsEnumerations.cs" />\r
     <Compile Include="Tizen.PhonenumberUtils\PhonenumberUtilsErrorFactory.cs" />\r
     <Compile Include="Tizen.PhonenumberUtils\PhonenumberUtils.cs" />\r
@@ -78,4 +79,4 @@
     <_FullFrameworkReferenceAssemblyPaths>$(MSBuildThisFileDirectory)</_FullFrameworkReferenceAssemblyPaths>\r
     <AutoUnifyAssemblyReferences>true</AutoUnifyAssemblyReferences>\r
   </PropertyGroup>\r
-</Project>
+</Project>
\ No newline at end of file

diff --git a/Tizen.PhonenumberUtils/Tizen.PhonenumberUtils/NamespaceDoc.cs b/Tizen.PhonenumberUtils/Tizen.PhonenumberUtils/NamespaceDoc.cs
new file mode 100644 (file)
index 0000000..42e91c1
--- /dev/null
+++ b/Tizen.PhonenumberUtils/Tizen.PhonenumberUtils/NamespaceDoc.cs
@@ -0,0 +1,7 @@
+/// <summary>
+/// The Tizen.PhonenumberUtils namespace provides a class for parsing, formatting and normalizing phone numbers.
+/// </summary>
+/// <remarks>
+/// The Tizen.PhonenumberUtils namespace provides a class for parsing, formatting and normalizing phone numbers.
+/// </remarks>
+namespace Tizen.PhonenumberUtils {}

diff --git a/Tizen.PhonenumberUtils/Tizen.PhonenumberUtils/PhonenumberUtils.cs b/Tizen.PhonenumberUtils/Tizen.PhonenumberUtils/PhonenumberUtils.cs
index 6bf00fb..ae56f52 100644 (file)
--- a/Tizen.PhonenumberUtils/Tizen.PhonenumberUtils/PhonenumberUtils.cs
+++ b/Tizen.PhonenumberUtils/Tizen.PhonenumberUtils/PhonenumberUtils.cs
@@ -19,7 +19,7 @@ using System;
 namespace Tizen.PhonenumberUtils
 {
     /// <summary>
-    /// This class makes applications can use phonenumber utils.
+    /// The PhonenumberUtils class provides methods for parsing, formatting and normalizing phone numbers.
     /// </summary>
     public class PhonenumberUtils : IDisposable
     {
@@ -42,6 +42,10 @@ namespace Tizen.PhonenumberUtils
             Dispose(false);
         }
 
+        /// <summary>
+        /// Releases all resources used by the PhonenumberUtils.
+        /// It should be called after finished using of the object.
+        /// </summary>
         public void Dispose()
         {
             Dispose(true);
@@ -53,11 +57,6 @@ namespace Tizen.PhonenumberUtils
             if (disposed)
                 return;
 
-            if (disposing)
-            {
-                // Free managed objects
-            }
-
             // Free unmanaged objects
             int ret;
 
@@ -124,15 +123,20 @@ namespace Tizen.PhonenumberUtils
 
         /// <summary>
         /// Gets the normalized number.
-        /// </summary>
-        /// <privilege>http://tizen.org/privilege/telephony</privilege>
+        /// </summary>        
         /// <param name="number">The number</param>
         /// <returns>The normalized number</returns>
+        /// <privilege>http://tizen.org/privilege/telephony</privilege>
+        /// <feature>http://tizen.org/feature/network.telephony</feature>
         /// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation</exception>
         /// <exception cref="NotSupportedException">Thrown when phonenumber-utils is not supported</exception>
         /// <exception cref="ArgumentException">Thrown when input coordinates are invalid</exception>
         /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
         /// <exception cref="UnauthorizedAccessException">Thrown when application does not have proper privileges</exception>
+        /// <remarks>
+        /// Normalized number starts with plus('+') and country code, and excludes the separators such as dash or space. 
+        /// It is a format of E.164 standard including the country code based on current network.
+        /// </remarks>
         public string GetNormalizedNumber(string number)
         {
             int ret;