Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add doxygen for Tizen.System.SystemSettings #6388

Merged
merged 1 commit into from
Sep 30, 2024
Merged

Add doxygen for Tizen.System.SystemSettings #6388

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
68 changes: 34 additions & 34 deletions src/Tizen.System.SystemSettings/Tizen.System.SystemSettings/SystemSettings.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ namespace Tizen.System
public static class SystemSettings
{
/// <summary>
/// The file path of the current ringtone.
/// This static member variable indicates file path of the current ringtone.
/// </summary>
/// <privilege>http://tizen.org/privilege/systemsettings.admin</privilege>
/// <privlevel>platform</privlevel>
Expand Down Expand Up @@ -63,7 +63,7 @@ public static string IncomingCallRingtone
}

/// <summary>
/// The file path of the current home-screen wallpaper.
/// This static member variable indicates file path of the current home-screen wallpaper.
/// </summary>
/// <privilege>http://tizen.org/privilege/systemsettings.admin</privilege>
/// <privlevel>platform</privlevel>
Expand Down Expand Up @@ -97,7 +97,7 @@ public static string WallpaperHomeScreen
}

/// <summary>
/// The file path of the current lock-screen wallpaper.
/// This static member variable indicates file path of the current lock-screen wallpaper.
/// </summary>
/// <privilege>http://tizen.org/privilege/systemsettings.admin</privilege>
/// <privlevel>platform</privlevel>
Expand Down Expand Up @@ -131,7 +131,7 @@ public static string WallpaperLockScreen
}

/// <summary>
/// The current system font size.
/// This static member variable indicates current system font size.
/// </summary>
/// <privilege>http://tizen.org/privilege/systemsettings.admin</privilege>
/// <privlevel>platform</privlevel>
Expand Down Expand Up @@ -165,7 +165,7 @@ public static SystemSettingsFontSize FontSize
}

/// <summary>
/// The current system font type.
/// This static member variable indicates current system font type.
/// </summary>
/// <privilege>http://tizen.org/privilege/systemsettings.admin</privilege>
/// <privlevel>platform</privlevel>
Expand Down Expand Up @@ -199,7 +199,7 @@ public static string FontType
}

/// <summary>
/// Indicates whether the motion service is activated.
/// This static member variable indicates whether the motion service is activated.
/// </summary>
/// <privilege>http://tizen.org/privilege/systemsettings.admin</privilege>
/// <privlevel>platform</privlevel>
Expand Down Expand Up @@ -232,7 +232,7 @@ public static bool MotionActivationEnabled
}

/// <summary>
/// The file path of the current email alert ringtone.
/// This static member variable indicates file path of the current email alert ringtone.
/// </summary>
/// <privilege>http://tizen.org/privilege/systemsettings.admin</privilege>
/// <privlevel>platform</privlevel>
Expand Down Expand Up @@ -265,7 +265,7 @@ public static string EmailAlertRingtone
}
}
/// <summary>
/// Indicates whether the USB debugging is enabled.
/// This static member variable indicates whether the USB debugging is enabled.
/// </summary>
/// <privilege>http://tizen.org/privilege/systemsettings.admin</privilege>
/// <privlevel>platform</privlevel>
Expand Down Expand Up @@ -298,7 +298,7 @@ public static bool UsbDebuggingEnabled
}

/// <summary>
/// Indicates whether the 3G data network is enabled.
/// This static member variable indicates whether the 3G data network is enabled.
/// </summary>
/// <privilege>http://tizen.org/privilege/systemsettings.admin</privilege>
/// <privlevel>platform</privlevel>
Expand Down Expand Up @@ -331,7 +331,7 @@ public static bool Data3GNetworkEnabled
}

/// <summary>
/// Indicates the lock-screen application package name.
/// This static member variable indicates the lock-screen application package name.
/// </summary>
/// <privilege>http://tizen.org/privilege/systemsettings.admin</privilege>
/// <privlevel>platform</privlevel>
Expand Down Expand Up @@ -391,7 +391,7 @@ public static string DefaultFontType
}

/// <summary>
/// Indicates the current country setting in the &lt;LANGUAGE&gt;_&lt;REGION&gt; syntax.
/// This static member variable indicates the current country setting in the &lt;LANGUAGE&gt;_&lt;REGION&gt; syntax.
/// The country setting is in the ISO 639-2 format,
/// and the region setting is in the ISO 3166-1 alpha-2 format.
/// </summary>
Expand Down Expand Up @@ -426,7 +426,7 @@ public static string LocaleCountry
}

/// <summary>
/// Indicates the current language setting in the &lt;LANGUAGE&gt;_&lt;REGION&gt; syntax.
/// This static member variable indicates the current language setting in the &lt;LANGUAGE&gt;_&lt;REGION&gt; syntax.
/// The language setting is in the ISO 639-2 format,
/// and the region setting is in the ISO 3166-1 alpha-2 format.
/// </summary>
Expand Down Expand Up @@ -461,7 +461,7 @@ public static string LocaleLanguage
}

/// <summary>
/// Indicates whether the 24-hour clock is used.
/// This static member variable indicates whether the 24-hour clock is used.
/// If the value is false, the 12-hour clock is used.
/// </summary>
/// <privilege>http://tizen.org/privilege/systemsettings.admin</privilege>
Expand Down Expand Up @@ -495,7 +495,7 @@ public static bool LocaleTimeFormat24HourEnabled
}

/// <summary>
/// Indicates the current time zone, for example, Pacific/Tahiti.
/// This static member variable indicates the current time zone, for example, Pacific/Tahiti.
/// </summary>
/// <privilege>http://tizen.org/privilege/systemsettings.admin</privilege>
/// <privlevel>platform</privlevel>
Expand Down Expand Up @@ -552,7 +552,7 @@ public static int Time
}
}
/// <summary>
/// Indicates whether the screen lock sound is enabled on the device, for example, the LCD on or off sound.
/// This static member variable indicates whether the screen lock sound is enabled on the device, for example, the LCD on or off sound.
/// </summary>
/// <privilege>http://tizen.org/privilege/systemsettings.admin</privilege>
/// <privlevel>platform</privlevel>
Expand All @@ -577,7 +577,7 @@ public static bool SoundLockEnabled
}

/// <summary>
/// Indicates whether the device is in the silent mode.
/// This static member variable indicates whether the device is in the silent mode.
/// </summary>
/// <privilege>http://tizen.org/privilege/systemsettings.admin</privilege>
/// <privlevel>platform</privlevel>
Expand All @@ -602,7 +602,7 @@ public static bool SoundSilentModeEnabled
}

/// <summary>
/// Indicates whether the screen touch sound is enabled on the device.
/// This static member variable indicates whether the screen touch sound is enabled on the device.
/// </summary>
/// <privilege>http://tizen.org/privilege/systemsettings.admin</privilege>
/// <privlevel>platform</privlevel>
Expand All @@ -627,7 +627,7 @@ public static bool SoundTouchEnabled
}

/// <summary>
/// Indicates whether the rotation control is automatic.
/// This static member variable indicates whether the rotation control is automatic.
/// </summary>
/// <privilege>http://tizen.org/privilege/systemsettings.admin</privilege>
/// <privlevel>platform</privlevel>
Expand All @@ -652,7 +652,7 @@ public static bool DisplayScreenRotationAutoEnabled
}

/// <summary>
/// Indicates the device name.
/// This static member variable indicates the device name.
/// </summary>
/// <privilege>http://tizen.org/privilege/systemsettings.admin</privilege>
/// <privlevel>platform</privlevel>
Expand All @@ -676,7 +676,7 @@ public static string DeviceName
}
}
/// <summary>
/// Indicates whether the device user has enabled the motion feature.
/// This static member variable indicates whether the device user has enabled the motion feature.
/// </summary>
/// <privilege>http://tizen.org/privilege/systemsettings.admin</privilege>
/// <privlevel>platform</privlevel>
Expand All @@ -701,7 +701,7 @@ public static bool MotionEnabled
}

/// <summary>
/// Indicates whether Wi-Fi related notifications are enabled on the device.
/// This static member variable indicates whether Wi-Fi related notifications are enabled on the device.
/// </summary>
/// <privilege>http://tizen.org/privilege/systemsettings.admin</privilege>
/// <privlevel>platform</privlevel>
Expand All @@ -727,7 +727,7 @@ public static bool NetworkWifiNotificationEnabled
}

/// <summary>
/// Indicates whether the device is in the flight mode.
/// This static member variable indicates whether the device is in the flight mode.
/// </summary>
/// <privilege>http://tizen.org/privilege/systemsettings.admin</privilege>
/// <privlevel>platform</privlevel>
Expand All @@ -752,7 +752,7 @@ public static bool NetworkFlightModeEnabled
}

/// <summary>
/// Indicates the backlight time (in seconds). The following values can be used: 15, 30, 60, 120, 300, and 600.
/// This static member variable indicates the backlight time (in seconds). The following values can be used: 15, 30, 60, 120, 300, and 600.
/// </summary>
/// <privilege>http://tizen.org/privilege/systemsettings.admin</privilege>
/// <privlevel>platform</privlevel>
Expand Down Expand Up @@ -785,7 +785,7 @@ public static int ScreenBacklightTime
}

/// <summary>
/// Indicates the file path of the current notification tone set by the user.
/// This static member variable indicates the file path of the current notification tone set by the user.
/// </summary>
/// <privilege>http://tizen.org/privilege/systemsettings.admin</privilege>
/// <privlevel>platform</privlevel>
Expand Down Expand Up @@ -819,7 +819,7 @@ public static string SoundNotification
}

/// <summary>
/// Indicates the time period for notification repetitions.
/// This static member variable indicates the time period for notification repetitions.
/// </summary>
/// <privilege>http://tizen.org/privilege/systemsettings.admin</privilege>
/// <privlevel>platform</privlevel>
Expand Down Expand Up @@ -852,7 +852,7 @@ public static int SoundNotificationRepetitionPeriod
}

/// <summary>
/// Indicates the current lock state.
/// This static member variable indicates the current lock state.
/// </summary>
/// <privilege>http://tizen.org/privilege/systemsettings.admin</privilege>
/// <privlevel>platform</privlevel>
Expand Down Expand Up @@ -919,7 +919,7 @@ public static string AdsId


/// <summary>
/// Indicates the time period for notification repetitions.
/// This static member variable indicates the time period for notification repetitions.
/// </summary>
/// <privilege>http://tizen.org/privilege/systemsettings.admin</privilege>
/// <privlevel>platform</privlevel>
Expand All @@ -945,7 +945,7 @@ public static SystemSettingsUdsState UltraDataSave
}

/// <summary>
/// Indicates whether the accessibility TTS is enabled on the device.
/// This static member variable indicates whether the accessibility TTS is enabled on the device.
/// </summary>
/// <privilege>http://tizen.org/privilege/systemsettings.admin</privilege>
/// <privlevel>platform</privlevel>
Expand Down Expand Up @@ -978,7 +978,7 @@ public static bool AccessibilityTtsEnabled
}

/// <summary>
/// Indicates whether the vibration is enabled on the device or not.
/// This static member variable indicates whether the vibration is enabled on the device or not.
/// </summary>
/// <privilege>http://tizen.org/privilege/systemsettings.admin</privilege>
/// <privlevel>platform</privlevel>
Expand Down Expand Up @@ -1011,7 +1011,7 @@ public static bool Vibration
}

/// <summary>
/// Indicates whether the automatic time update is enabled on the device or not.
/// This static member variable indicates whether the automatic time update is enabled on the device or not.
/// </summary>
/// <privilege>http://tizen.org/privilege/systemsettings.admin</privilege>
/// <privlevel>platform</privlevel>
Expand Down Expand Up @@ -1045,7 +1045,7 @@ public static bool AutomaticTimeUpdate
}

/// <summary>
/// Indicates whether the developer option state is enabled on the device or not.
/// This static member variable indicates whether the developer option state is enabled on the device or not.
/// </summary>
/// <privilege>http://tizen.org/privilege/systemsettings.admin</privilege>
/// <privlevel>platform</privlevel>
Expand Down Expand Up @@ -1078,7 +1078,7 @@ public static bool DeveloperOptionState
}

/// <summary>
/// Indicates whether accessibility grayscale is enabled on the device or not.
/// This static member variable indicates whether accessibility grayscale is enabled on the device or not.
/// </summary>
/// <privilege>http://tizen.org/privilege/systemsettings.admin</privilege>
/// <privlevel>platform</privlevel>
Expand Down Expand Up @@ -1112,7 +1112,7 @@ public static bool AccessibilityGrayscale
}

/// <summary>
/// Indicates whether accessibility negative color is enabled on the device or not.
/// This static member variable indicates whether accessibility negative color is enabled on the device or not.
/// </summary>
/// <privilege>http://tizen.org/privilege/systemsettings.admin</privilege>
/// <privlevel>platform</privlevel>
Expand Down Expand Up @@ -1146,7 +1146,7 @@ public static bool AccessibilityNegativeColor
}

/// <summary>
/// Indicates whether rotary event is enabled on the device.
/// This static member variable indicates whether rotary event is enabled on the device.
/// </summary>
/// <privilege>http://tizen.org/privilege/systemsettings.admin</privilege>
/// <privlevel>platform</privlevel>
Expand Down
12 changes: 6 additions & 6 deletions src/Tizen.System.SystemSettings/Tizen.System.SystemSettings/SystemSettingsEnums.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
namespace Tizen.System
{
/// <summary>
/// Enumeration for all the available system settings.
/// This is enumeration for all the available system settings.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum SystemSettingsKeys : int
Expand Down Expand Up @@ -189,7 +189,7 @@ public enum SystemSettingsKeys : int
RotaryEventEnabled
}
/// <summary>
/// Enumeration for the Idle Lock State.
/// This is enumeration for the Idle Lock State.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum SystemSettingsIdleLockState : int
Expand All @@ -208,7 +208,7 @@ public enum SystemSettingsIdleLockState : int
LaunchingLock
}
/// <summary>
/// Enumeration for the font size.
/// This is enumeration for the font size.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum SystemSettingsFontSize : int
Expand Down Expand Up @@ -241,15 +241,15 @@ public enum SystemSettingsFontSize : int
public enum SystemSettingsUdsState : int
{
/// <summary>
/// UDS Off.
/// UDS(Ultra Data Save) Off.
/// </summary>
UdsOff = 0,
/// <summary>
/// UDS On.
/// UDS(Ultra Data Save) On.
/// </summary>
UdsOn,
/// <summary>
/// UDS On and the application is whitelisted.
/// UDS(Ultra Data Save) On and the application is whitelisted.
/// </summary>
UdsOnWhitelisted,
}
Expand Down
Loading