[System.Feedback] Add feedback theme index range description
authorYunhee Seo <yuni.seo@samsung.com>
Thu, 19 Oct 2023 04:37:28 +0000 (13:37 +0900)
committerChanwoo Choi <chanwoo@kernel.org>
Thu, 19 Oct 2023 12:31:55 +0000 (21:31 +0900)
The index of sound theme range is 1 ~ N according to conf file.
This index range should be considered when using feedback theme index getter/setter.

Signed-off-by: Yunhee Seo <yuni.seo@samsung.com>
src/Tizen.System.Feedback/Feedback/Feedback.cs

index 1ada672..daaf66b 100755 (executable)
@@ -552,6 +552,7 @@ namespace Tizen.System
         /// </summary>
         /// <remarks>
         /// Now this internal API works for FeedbackType.Sound only, FeedbackType.Vibration is not supported.
+        /// Counts of theme range will be 1 ~ N according to conf file.
         /// </remarks>
         /// <since_tizen> 10 </since_tizen>
         /// <param name="type">The feedback type.</param>
@@ -598,6 +599,7 @@ namespace Tizen.System
         /// </summary>
         /// <remarks>
         /// Now this internal API works for FeedbackType.Sound only, FeedbackType.Vibration is not supported.
+        /// Index of theme range will be 1 ~ N according to conf file.
         /// </remarks>
         /// <since_tizen> 10 </since_tizen>
         /// <param name="type">The feedback type.</param>
@@ -642,6 +644,7 @@ namespace Tizen.System
         /// <remarks>
         /// Now this internal API works for FeedbackType.Sound only, FeedbackType.Vibration is not supported.
         /// To set the index of theme for Sound type, the application should have http://tizen.org/privilege/systemsettings.admin privilege.
+        /// Index of theme range is 1 ~ N according to conf file. If you put the wrong index, operation cannot be guaranteed.
         /// </remarks>
         /// <since_tizen> 10 </since_tizen>
         /// <param name="type">The feedback type.</param>
@@ -653,7 +656,7 @@ namespace Tizen.System
         /// <example>
         /// <code>
         /// Feedback feedback = new Feedback();
-        /// uint indexOfTheme = 0;
+        /// uint indexOfTheme = 1;
         /// feedback.SetThemeIndexInternal(FeedbackType.Sound, indexOfTheme);
         /// </code>
         /// </example>