Skip to content

Commit

Permalink
[Tizen.System.Feedback] Enhance API description
Browse files Browse the repository at this point in the history
Add more detailed APIs description.

Signed-off-by: Yunhee Seo <[email protected]>
  • Loading branch information
Yunhee Seo committed Oct 10, 2024
1 parent 3824f05 commit a74abfd
Showing 1 changed file with 17 additions and 7 deletions.
24 changes: 17 additions & 7 deletions src/Tizen.System.Feedback/Feedback/Feedback.cs
Original file line number Diff line number Diff line change
Expand Up @@ -413,6 +413,7 @@ public Feedback()
/// bool res = feedback.IsSupportedPattern(FeedbackType.Vibration, "Tap");
/// </code>
/// </example>
/// <seealso cref="FeedbackType"/>
public bool IsSupportedPattern(FeedbackType type, String pattern)
{
bool supported = false;
Expand Down Expand Up @@ -446,7 +447,7 @@ public bool IsSupportedPattern(FeedbackType type, String pattern)
}

/// <summary>
/// Plays a specific feedback pattern.
/// Plays specific type of reactions that are pre-defined feedback pattern.
/// </summary>
/// <remarks>
/// To play Vibration type, app should have http://tizen.org/privilege/haptic privilege.
Expand All @@ -469,6 +470,8 @@ public bool IsSupportedPattern(FeedbackType type, String pattern)
/// feedback.Play(FeedbackType.All, "Tap");
/// </code>
/// </example>
/// <seealso cref="FeedbackType"/>
/// <seealso cref="Feedback.Stop()"/>
public void Play(FeedbackType type, String pattern)
{
int number;
Expand Down Expand Up @@ -503,7 +506,7 @@ public void Play(FeedbackType type, String pattern)
}

/// <summary>
/// Stops to play the feedback.
/// Stops various types of reactions from the feedback module.
/// </summary>
/// <remarks>
/// To stop vibration, the application should have http://tizen.org/privilege/haptic privilege.
Expand All @@ -524,6 +527,7 @@ public void Play(FeedbackType type, String pattern)
/// Feedback1.Stop();
/// </code>
/// </example>
/// <seealso cref="Feedback.Play(FeedbackType,String)"/>
public void Stop()
{
Interop.Feedback.FeedbackError res = (Interop.Feedback.FeedbackError)Interop.Feedback.Stop();
Expand All @@ -549,7 +553,7 @@ public void Stop()
}

/// <summary>
/// Gets the count of theme can be used according to feedback type.
/// Gets the number of themes supported as described in the configuration.
/// </summary>
/// <remarks>
/// Now this internal API works for FeedbackType.Sound only, FeedbackType.Vibration is not supported.
Expand All @@ -568,6 +572,7 @@ public void Stop()
/// uint coundOfTheme = feedback.GetCountOfThemeInternal(FeedbackType.Sound);
/// </code>
/// </example>
/// <seealso cref="FeedbackType"/>
[EditorBrowsable(EditorBrowsableState.Never)]
public uint GetCountOfThemeInternal(FeedbackType type)
{
Expand Down Expand Up @@ -596,7 +601,7 @@ public uint GetCountOfThemeInternal(FeedbackType type)
}

/// <summary>
/// Gets the id of theme selected.
/// Gets the current ID of the theme selected from available themes described in the conf file.
/// </summary>
/// <remarks>
/// Now this internal API works for FeedbackType.Sound only, FeedbackType.Vibration is not supported.
Expand All @@ -614,6 +619,7 @@ public uint GetCountOfThemeInternal(FeedbackType type)
/// uint idOfTheme = feedback.GetThemeIdInternal(FeedbackType.Sound);
/// </code>
/// </example>
/// <seealso cref="FeedbackType"/>
[EditorBrowsable(EditorBrowsableState.Never)]
public uint GetThemeIdInternal(FeedbackType type)
{
Expand All @@ -640,7 +646,7 @@ public uint GetThemeIdInternal(FeedbackType type)
}

/// <summary>
/// Sets the id of theme according to feedback type.
/// Sets the current ID of the theme from available themes described in the conf file.
/// </summary>
/// <remarks>
/// Now this internal API works for FeedbackType.Sound only, FeedbackType.Vibration is not supported.
Expand All @@ -661,6 +667,7 @@ public uint GetThemeIdInternal(FeedbackType type)
/// feedback.SetThemeIdInternal(FeedbackType.Sound, idOfTheme);
/// </code>
/// </example>
/// <seealso cref="FeedbackType"/>
[EditorBrowsable(EditorBrowsableState.Never)]
public void SetThemeIdInternal(FeedbackType type, uint idOfTheme)
{
Expand All @@ -687,7 +694,7 @@ public void SetThemeIdInternal(FeedbackType type, uint idOfTheme)
}

/// <summary>
/// Stops the current feedback playing by feedback type
/// Stops reactions of various types according to the feedback type.
/// </summary>
/// <remarks>
/// To stop vibration, the application should have http://tizen.org/privilege/haptic privilege.
Expand All @@ -706,6 +713,7 @@ public void SetThemeIdInternal(FeedbackType type, uint idOfTheme)
/// feedback.StopTypeInternal(FeedbackType.Vibration);
/// </code>
/// </example>
/// <seealso cref="FeedbackType"/>
[EditorBrowsable(EditorBrowsableState.Never)]
public void StopTypeInternal(FeedbackType type)
{
Expand Down Expand Up @@ -734,11 +742,12 @@ public void StopTypeInternal(FeedbackType type)
}

/// <summary>
/// Gets the id array of theme supported.
/// Gets the array of theme ids supported described in the conf file.
/// </summary>
/// <remarks>
/// Now this internal API works for FeedbackType.Sound only, FeedbackType.Vibration is not supported.
/// The theme id is positive value as defined in the conf file.
/// Gets all theme ids as defined in the conf file.
/// </remarks>
/// <since_tizen> 10 </since_tizen>
/// <param name="type">The feedback type.</param>
Expand All @@ -752,6 +761,7 @@ public void StopTypeInternal(FeedbackType type)
/// uint[] getThemeIds = feedback.GetThemeIdsInternal(FeedbackType.Sound);
/// </code>
/// </example>
/// <seealso cref="FeedbackType"/>
[EditorBrowsable(EditorBrowsableState.Never)]
public uint[] GetThemeIdsInternal(FeedbackType type)
{
Expand Down

0 comments on commit a74abfd

Please sign in to comment.