[Tizen.System] Enhance API description #6399
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Public API ChangedPlease follow the ACR process for the changed API below. Added: 0, Removed: 0, Changed: 3Changed- /// <since_tizen>3</since_tizen
+ /// <since_tizen>none</since_tizen
Tizen.System.BatteryLevelStatus Tizen.System.Battery::Level()
+ /// <privilege>http://tizen.org/privilege/display.state</privilege
/// <since_tizen>5</since_tizen
static System.Void Tizen.System.Power::ReleaseLock(Tizen.System.PowerLock)
+ /// <privilege>http://tizen.org/privilege/display.state</privilege
/// <since_tizen>5</since_tizen
static System.Void Tizen.System.Power::RequestLock(Tizen.System.PowerLock,System.Int32)
Internal API ChangedAdded: 0, Removed: 0, Changed: 2Changed/// <privilege>http://tizen.org/privilege/reboot</privilege
- /// <since_tizen>none</since_tizen
+ /// <since_tizen>9</since_tizen
[EditorBrowsable(EditorBrowsableState.Never)]
static System.Void Tizen.System.Power::PowerOff()
/// <privilege>http://tizen.org/privilege/reboot</privilege
- /// <since_tizen>none</since_tizen
+ /// <since_tizen>9</since_tizen
[EditorBrowsable(EditorBrowsableState.Never)]
static System.Void Tizen.System.Power::Reboot(System.String)
|
ppdl
reviewed
Oct 10, 2024
| @@ -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. | |||
There was a problem hiding this comment.
Suggested change
| /// Gets the current ID of the theme selected from available themes described in the conf file. | |
| /// Gets the current id of the theme selected from available themes described in the conf file. |
Keep consistency, id or ID?
There was a problem hiding this comment.
I changed as "id" to keep consistency thanks.
src/Tizen.System/Device/Battery.cs
Outdated
| @@ -76,11 +76,20 @@ public static class Battery | |||
| { | |||
| private static readonly object s_lock = new object(); | |||
| /// <summary> | |||
| /// Gets the battery charge percentage. | |||
| /// Gets the current device'sinvalid battery charge percentage as an interger value. | |||
There was a problem hiding this comment.
Suggested change
| /// Gets the current device'sinvalid battery charge percentage as an interger value. | |
| /// Gets the current device's invalid battery charge percentage as an interger value. |
There was a problem hiding this comment.
I changed that description as you suggested.
chanwoochoi
approved these changes
Oct 10, 2024
added 2 commits
October 10, 2024 17:22
Add more detailed APIs description. Signed-off-by: Yunhee Seo <[email protected]>
Add more detailed APIs description. Signed-off-by: Yunhee Seo <[email protected]>
germonado
force-pushed
the
yunhee/dev12
branch
from
a74abfd
to
2d8ca16
Compare
ppdl
approved these changes
Oct 10, 2024
chanwoochoi
approved these changes
Oct 10, 2024
Public API ChangedPlease follow the ACR process for the changed API below. Added: 0, Removed: 0, Changed: 3Changed- /// <since_tizen>3</since_tizen
+ /// <since_tizen>none</since_tizen
Tizen.System.BatteryLevelStatus Tizen.System.Battery::Level()
+ /// <privilege>http://tizen.org/privilege/display.state</privilege
/// <since_tizen>5</since_tizen
static System.Void Tizen.System.Power::ReleaseLock(Tizen.System.PowerLock)
+ /// <privilege>http://tizen.org/privilege/display.state</privilege
/// <since_tizen>5</since_tizen
static System.Void Tizen.System.Power::RequestLock(Tizen.System.PowerLock,System.Int32)
Internal API ChangedAdded: 0, Removed: 0, Changed: 2Changed/// <privilege>http://tizen.org/privilege/reboot</privilege
- /// <since_tizen>none</since_tizen
+ /// <since_tizen>9</since_tizen
[EditorBrowsable(EditorBrowsableState.Never)]
static System.Void Tizen.System.Power::PowerOff()
/// <privilege>http://tizen.org/privilege/reboot</privilege
- /// <since_tizen>none</since_tizen
+ /// <since_tizen>9</since_tizen
[EditorBrowsable(EditorBrowsableState.Never)]
static System.Void Tizen.System.Power::Reboot(System.String)
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of Change
Add more detailed API descriptions to the modules below.
API Changes