From: sooyeon.kim <sooyeon.kim@samsung.com>
Date: Thu, 11 May 2017 07:50:22 +0000 (+0900)
Subject: Add descriptions for privilege and features
X-Git-Tag: submit/trunk/20170823.075128~68^2~11
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=b10c8b896252122f80440e6912c979368d7722a4;p=platform%2Fcore%2Fcsapi%2Ftizenfx.git

Add descriptions for privilege and features

Change-Id: I09ec819f1b2897e5757bf7bc0a6419906458fdb8
Signed-off-by: sooyeon.kim <sooyeon.kim@samsung.com>
---

diff --git a/src/Tizen.Uix.VoiceControl/Tizen.Uix.VoiceControl/VoiceCommandList.cs b/src/Tizen.Uix.VoiceControl/Tizen.Uix.VoiceControl/VoiceCommandList.cs
index bb1da4f..a6635ed 100755
--- a/src/Tizen.Uix.VoiceControl/Tizen.Uix.VoiceControl/VoiceCommandList.cs
+++ b/src/Tizen.Uix.VoiceControl/Tizen.Uix.VoiceControl/VoiceCommandList.cs
@@ -33,6 +33,16 @@ namespace Tizen.Uix.VoiceControl
         /// <summary>
         /// Public Constructor
         /// </summary>
+        /// <privilege>
+        /// http://tizen.org/privilege/recorder
+        /// </privilege>
+        /// <privlevel>
+        /// public
+        /// </privlevel>
+        /// <feature>
+        /// http://tizen.org/feature/speech.control
+        /// http://tizen.org/feature/microphone
+        /// </feature>
         /// <exception cref="InvalidOperationException">
         /// This Exception can be due to the following reaons
         /// 1. Invalid parameter
@@ -61,6 +71,15 @@ namespace Tizen.Uix.VoiceControl
         /// Gets command count of list.
         /// -1 is returned in case of internal failure.
         /// </summary>
+        /// <value>
+        /// Command counts of the list.
+        /// </value>
+        /// <privilege>
+        /// http://tizen.org/privilege/recorder
+        /// </privilege>
+        /// <privlevel>
+        /// public
+        /// </privlevel>
         public int GetCount
         {
             get
@@ -81,6 +100,15 @@ namespace Tizen.Uix.VoiceControl
         /// Get current command from command list by index.
         /// null will be returned in case of Empty List
         /// </summary>
+        /// <value>
+        /// Current command from the command list.
+        /// </value>
+        /// <privilege>
+        /// http://tizen.org/privilege/recorder
+        /// </privilege>
+        /// <privlevel>
+        /// public
+        /// </privlevel>
         public VoiceCommand GetCurrent
         {
             get
@@ -100,6 +128,16 @@ namespace Tizen.Uix.VoiceControl
         /// <summary>
         /// Adds command to command list.
         /// </summary>
+        /// <privilege>
+        /// http://tizen.org/privilege/recorder
+        /// </privilege>
+        /// <privlevel>
+        /// public
+        /// </privlevel>
+        /// <feature>
+        /// http://tizen.org/feature/speech.control
+        /// http://tizen.org/feature/microphone
+        /// </feature>
         /// <param name="command">The command</param>
         /// <exception cref="InvalidOperationException">
         /// This Exception can be due to the following reaons
@@ -121,6 +159,16 @@ namespace Tizen.Uix.VoiceControl
         /// <summary>
         /// Removes command from command list.
         /// </summary>
+        /// <privilege>
+        /// http://tizen.org/privilege/recorder
+        /// </privilege>
+        /// <privlevel>
+        /// public
+        /// </privlevel>
+        /// <feature>
+        /// http://tizen.org/feature/speech.control
+        /// http://tizen.org/feature/microphone
+        /// </feature>
         /// <param name="command">The command</param>
         /// <exception cref="InvalidOperationException">
         /// This Exception can be due to the following reaons
@@ -142,6 +190,16 @@ namespace Tizen.Uix.VoiceControl
         /// <summary>
         /// Retrieves all commands of command list.
         /// </summary>
+        /// <privilege>
+        /// http://tizen.org/privilege/recorder
+        /// </privilege>
+        /// <privlevel>
+        /// public
+        /// </privlevel>
+        /// <feature>
+        /// http://tizen.org/feature/speech.control
+        /// http://tizen.org/feature/microphone
+        /// </feature>
         /// <exception cref="InvalidOperationException">
         /// This Exception can be due to the following reaons
         /// 1. Permission Denied
@@ -170,6 +228,16 @@ namespace Tizen.Uix.VoiceControl
         /// <summary>
         /// Moves index to first command.
         /// </summary>
+        /// <privilege>
+        /// http://tizen.org/privilege/recorder
+        /// </privilege>
+        /// <privlevel>
+        /// public
+        /// </privlevel>
+        /// <feature>
+        /// http://tizen.org/feature/speech.control
+        /// http://tizen.org/feature/microphone
+        /// </feature>
         /// <exception cref="InvalidOperationException">
         /// This Exception can be due to the following reaons
         /// 1. List Empty
@@ -189,6 +257,16 @@ namespace Tizen.Uix.VoiceControl
         /// <summary>
         /// Moves index to last command.
         /// </summary>
+        /// <privilege>
+        /// http://tizen.org/privilege/recorder
+        /// </privilege>
+        /// <privlevel>
+        /// public
+        /// </privlevel>
+        /// <feature>
+        /// http://tizen.org/feature/speech.control
+        /// http://tizen.org/feature/microphone
+        /// </feature>
         /// <exception cref="InvalidOperationException">
         /// This Exception can be due to the following reaons
         /// 1. List Empty
@@ -208,6 +286,16 @@ namespace Tizen.Uix.VoiceControl
         /// <summary>
         /// Moves index to next command.
         /// </summary>
+        /// <privilege>
+        /// http://tizen.org/privilege/recorder
+        /// </privilege>
+        /// <privlevel>
+        /// public
+        /// </privlevel>
+        /// <feature>
+        /// http://tizen.org/feature/speech.control
+        /// http://tizen.org/feature/microphone
+        /// </feature>
         /// <exception cref="InvalidOperationException">
         /// This Exception can be due to the following reaons
         /// 1. List Empty
@@ -228,6 +316,16 @@ namespace Tizen.Uix.VoiceControl
         /// <summary>
         /// Moves index to previous command.
         /// </summary>
+        /// <privilege>
+        /// http://tizen.org/privilege/recorder
+        /// </privilege>
+        /// <privlevel>
+        /// public
+        /// </privlevel>
+        /// <feature>
+        /// http://tizen.org/feature/speech.control
+        /// http://tizen.org/feature/microphone
+        /// </feature>
         /// <exception cref="InvalidOperationException">
         /// This Exception can be due to the following reaons
         /// 1. List Empty
diff --git a/src/Tizen.Uix.VoiceControl/Tizen.Uix.VoiceControl/VoiceControlClient.cs b/src/Tizen.Uix.VoiceControl/Tizen.Uix.VoiceControl/VoiceControlClient.cs
index 78ea25d..137df48 100755
--- a/src/Tizen.Uix.VoiceControl/Tizen.Uix.VoiceControl/VoiceControlClient.cs
+++ b/src/Tizen.Uix.VoiceControl/Tizen.Uix.VoiceControl/VoiceControlClient.cs
@@ -228,6 +228,9 @@ namespace Tizen.Uix.VoiceControl
         /// For example, "ko_KR" for Korean, "en_US" for American English.
         /// Empty string is returned incase of some internal error
         /// </summary>
+        /// <value>
+        /// Current language in voice control.
+        /// </value>
         /// <privilege>
         /// http://tizen.org/privilege/recorder
         /// </privilege>
@@ -252,8 +255,11 @@ namespace Tizen.Uix.VoiceControl
         }
 
         /// <summary>
-        /// Gets current state of voice control client. 
+        /// Gets current state of voice control client.
         /// </summary>
+        /// <value>
+        /// Current state of voice control client.
+        /// </value>
         /// <privilege>
         /// http://tizen.org/privilege/recorder
         /// </privilege>
@@ -280,6 +286,9 @@ namespace Tizen.Uix.VoiceControl
         /// <summary>
         /// Gets current state of voice control service.
         /// </summary>
+        /// <value>
+        /// Current state of voice control service.
+        /// </value>
         /// <privilege>
         /// http://tizen.org/privilege/recorder
         /// </privilege>
@@ -309,6 +318,13 @@ namespace Tizen.Uix.VoiceControl
         /// <privilege>
         /// http://tizen.org/privilege/recorder
         /// </privilege>
+        /// <privlevel>
+        /// public
+        /// </privlevel>
+        /// <feature>
+        /// http://tizen.org/feature/speech.control
+        /// http://tizen.org/feature/microphone
+        /// </feature>
         /// <remarks>
         /// Invocation name is used to activate background commands. The invocation name can be the same as the application name or any other phrase.
         /// For example, an application "Tizen Sample" has a background command, "Play music", and the invocation name of the application is set to "Tizen Sample".
@@ -344,6 +360,13 @@ namespace Tizen.Uix.VoiceControl
         /// <privilege>
         /// http://tizen.org/privilege/recorder
         /// </privilege>
+        /// <privlevel>
+        /// public
+        /// </privlevel>
+        /// <feature>
+        /// http://tizen.org/feature/speech.control
+        /// http://tizen.org/feature/microphone
+        /// </feature>
         /// <exception cref="InvalidOperationException">
         /// This Exception can be due to the following reaons
         /// 1. Out Of Memory
@@ -370,6 +393,13 @@ namespace Tizen.Uix.VoiceControl
         /// <privilege>
         /// http://tizen.org/privilege/recorder
         /// </privilege>
+        /// <privlevel>
+        /// public
+        /// </privlevel>
+        /// <feature>
+        /// http://tizen.org/feature/speech.control
+        /// http://tizen.org/feature/microphone
+        /// </feature>
         /// <exception cref="InvalidOperationException">
         /// This Exception can be due to the following reaons
         /// 1. Operation Failed
@@ -393,6 +423,13 @@ namespace Tizen.Uix.VoiceControl
         /// <privilege>
         /// http://tizen.org/privilege/recorder
         /// </privilege>
+        /// <privlevel>
+        /// public
+        /// </privlevel>
+        /// <feature>
+        /// http://tizen.org/feature/speech.control
+        /// http://tizen.org/feature/microphone
+        /// </feature>
         /// <exception cref="InvalidOperationException">
         /// This Exception can be due to the following reaons
         /// 1. Operation Failed
@@ -422,6 +459,13 @@ namespace Tizen.Uix.VoiceControl
         /// <privilege>
         /// http://tizen.org/privilege/recorder
         /// </privilege>
+        /// <privlevel>
+        /// public
+        /// </privlevel>
+        /// <feature>
+        /// http://tizen.org/feature/speech.control
+        /// http://tizen.org/feature/microphone
+        /// </feature>
         /// <exception cref="InvalidOperationException">
         /// This Exception can be due to the following reaons
         /// 1. Not Supported
@@ -453,6 +497,13 @@ namespace Tizen.Uix.VoiceControl
         /// <privilege>
         /// http://tizen.org/privilege/recorder
         /// </privilege>
+        /// <privlevel>
+        /// public
+        /// </privlevel>
+        /// <feature>
+        /// http://tizen.org/feature/speech.control
+        /// http://tizen.org/feature/microphone
+        /// </feature>
         /// <exception cref="InvalidOperationException">
         /// This Exception can be due to the following reaons
         /// 1. Operation Failed
@@ -491,6 +542,13 @@ namespace Tizen.Uix.VoiceControl
         /// <privilege>
         /// http://tizen.org/privilege/recorder
         /// </privilege>
+        /// <privlevel>
+        /// public
+        /// </privlevel>
+        /// <feature>
+        /// http://tizen.org/feature/speech.control
+        /// http://tizen.org/feature/microphone
+        /// </feature>
         /// <remarks>
         /// In the system command list, there are system commands predefined by product manufacturers.
         /// Those commands have the highest priority. Therefore, the user can not set any commands same with the system commands.
@@ -535,6 +593,13 @@ namespace Tizen.Uix.VoiceControl
         /// <privilege>
         /// http://tizen.org/privilege/recorder
         /// </privilege>
+        /// <privlevel>
+        /// public
+        /// </privlevel>
+        /// <feature>
+        /// http://tizen.org/feature/speech.control
+        /// http://tizen.org/feature/microphone
+        /// </feature>
         /// <remarks>
         /// If autoStart is true, the recognition will start again. In this case, it can be restarted up to 4 times.
         /// </remarks>
@@ -567,6 +632,13 @@ namespace Tizen.Uix.VoiceControl
         /// <privilege>
         /// http://tizen.org/privilege/recorder
         /// </privilege>
+        /// <privlevel>
+        /// public
+        /// </privlevel>
+        /// <feature>
+        /// http://tizen.org/feature/speech.control
+        /// http://tizen.org/feature/microphone
+        /// </feature>
         /// <remarks>
         /// The command type is valid for CommandType 'Foreground' or 'Background'.
         /// The matched commands of command list should be set and they should include type and command text at least.
@@ -607,6 +679,13 @@ namespace Tizen.Uix.VoiceControl
         /// <privilege>
         /// http://tizen.org/privilege/recorder
         /// </privilege>
+        /// <privlevel>
+        /// public
+        /// </privlevel>
+        /// <feature>
+        /// http://tizen.org/feature/speech.control
+        /// http://tizen.org/feature/microphone
+        /// </feature>
         /// <param name="type">Command type</param>
         /// <exception cref="InvalidOperationException">
         /// This Exception can be due to the following reaons
@@ -645,6 +724,13 @@ namespace Tizen.Uix.VoiceControl
         /// <privilege>
         /// http://tizen.org/privilege/recorder
         /// </privilege>
+        /// <privlevel>
+        /// public
+        /// </privlevel>
+        /// <feature>
+        /// http://tizen.org/feature/speech.control
+        /// http://tizen.org/feature/microphone
+        /// </feature>
         /// <param name="resultDelegate">
         /// Callback function to get recognition result
         /// </param>