mika/libnx
1
0
Fork 0
mirror of https://github.com/switchbrew/libnx.git synced 2025-07-04 10:32:15 +02:00
Code Issues Packages Projects Releases Wiki Activity

set: Fix docs and typos

Browse Source
This commit is contained in:
shchmue 2020-03-09 20:07:49 -06:00
parent adae78c3d4
commit 025993c201
2 changed files with 33 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
nx/include/switch/services/fs.h
View File

@ -123,7 +123,7 @@ typedef struct {
u8 padding[7]; u8 padding[7];
} FsTimeStampRaw; } FsTimeStampRaw;
/// This is nn::fssystem::ArchiveMacKey. Returned by setsysGetThemeKey. Does not appear to be in use elsewhere. /// This is nn::fssystem::ArchiveMacKey. Returned by \ref setsysGetThemeKey. Does not appear to be in use elsewhere.
typedef struct { typedef struct {
u8 key[0x10]; u8 key[0x10];
} FsArchiveMacKey; } FsArchiveMacKey;

59
nx/include/switch/services/set.h
View File

@ -115,6 +115,7 @@ typedef enum {
SetSysFriendPresenceOverlayPermission_Friends = 3, SetSysFriendPresenceOverlayPermission_Friends = 3,
} SetSysFriendPresenceOverlayPermission; } SetSysFriendPresenceOverlayPermission;
/// AudioDevice
typedef enum { typedef enum {
SetSysAudioDevice_Console = 0, SetSysAudioDevice_Console = 0,
SetSysAudioDevice_Headphone = 1, SetSysAudioDevice_Headphone = 1,
@ -215,6 +216,7 @@ typedef enum {
SetSysTouchScreenMode_Standard = 1, ///< Standard, the default. SetSysTouchScreenMode_Standard = 1, ///< Standard, the default.
} SetSysTouchScreenMode; } SetSysTouchScreenMode;
/// BlockType
typedef enum { typedef enum {
SetSysBlockType_Audio = 1, SetSysBlockType_Audio = 1,
SetSysBlockType_Video = 2, SetSysBlockType_Video = 2,
@ -222,6 +224,7 @@ typedef enum {
SetSysBlockType_Speaker = 4, SetSysBlockType_Speaker = 4,
} SetSysBlockType; } SetSysBlockType;
/// ControllerType
typedef enum { typedef enum {
SetSysControllerType_JoyConR = 1, SetSysControllerType_JoyConR = 1,
SetSysControllerType_JoyConL = 2, SetSysControllerType_JoyConL = 2,
@ -244,8 +247,8 @@ typedef struct {
u32 access_point_ssid_len; u32 access_point_ssid_len;
u32 access_point_security_type; ///< Bitmask with \ref SetSysAccessPointSecurityType. u32 access_point_security_type; ///< Bitmask with \ref SetSysAccessPointSecurityType.
u32 access_point_security_standard; ///< Bitmask with \ref SetSysAccessPointSecurityStandard. u32 access_point_security_standard; ///< Bitmask with \ref SetSysAccessPointSecurityStandard.
char access_point_password[0x40]; char access_point_passphrase[0x40];
u32 access_point_password_len; u32 access_point_passphrase_len;
u32 auto_settings; ///< Bitmask with \ref SetSysAutoSettings. u32 auto_settings; ///< Bitmask with \ref SetSysAutoSettings.
u32 manual_ip_address; u32 manual_ip_address;
u32 manual_subnet_mask; u32 manual_subnet_mask;
@ -266,7 +269,7 @@ typedef struct {
typedef struct { typedef struct {
float brightness_applied_to_backlight; float brightness_applied_to_backlight;
float ambient_light_sensor_value; float ambient_light_sensor_value;
float float8; float unk_x8;
} SetSysLcdBacklightBrightnessMapping; } SetSysLcdBacklightBrightnessMapping;
/// BacklightSettings /// BacklightSettings
@ -274,11 +277,11 @@ typedef struct {
u32 auto_brightness_flags; u32 auto_brightness_flags;
float screen_brightness; float screen_brightness;
SetSysLcdBacklightBrightnessMapping brightness_mapping; SetSysLcdBacklightBrightnessMapping brightness_mapping;
float float14; float unk_x14;
float float18; float unk_x18;
float float1C; float unk_x1C;
float float20; float unk_x20;
float float24; float unk_x24;
} SetSysBacklightSettings; } SetSysBacklightSettings;
/// BacklightSettingsEx /// BacklightSettingsEx
@ -287,11 +290,11 @@ typedef struct {
float screen_brightness; float screen_brightness;
float current_brightness_for_vr_mode; float current_brightness_for_vr_mode;
SetSysLcdBacklightBrightnessMapping brightness_mapping; SetSysLcdBacklightBrightnessMapping brightness_mapping;
float float18; float unk_x18;
float float1C; float unk_x1C;
float float20; float unk_x20;
float float24; float unk_x24;
float float28; float unk_x28;
} SetSysBacklightSettingsEx; } SetSysBacklightSettingsEx;
/// BluetoothDevicesSettings /// BluetoothDevicesSettings
@ -944,7 +947,7 @@ Result setsysSetBacklightSettings(const SetSysBacklightSettings *settings);
/** /**
* @brief SetBluetoothDevicesSettings * @brief SetBluetoothDevicesSettings
* @param[in] settings Input array of \ref SetSysBluetoothDevicesSettings. * @param[in] settings Input array of \ref SetSysBluetoothDevicesSettings.
* @param[in] count Size of the versions array in entries. * @param[in] count Size of the settings array in entries.
*/ */
Result setsysSetBluetoothDevicesSettings(const SetSysBluetoothDevicesSettings *settings, s32 count); Result setsysSetBluetoothDevicesSettings(const SetSysBluetoothDevicesSettings *settings, s32 count);
@ -952,7 +955,7 @@ Result setsysSetBluetoothDevicesSettings(const SetSysBluetoothDevicesSettings *s
* @brief GetBluetoothDevicesSettings * @brief GetBluetoothDevicesSettings
* @param[out] total_out Total output entries. * @param[out] total_out Total output entries.
* @param[out] settings Output array of \ref SetSysBluetoothDevicesSettings. * @param[out] settings Output array of \ref SetSysBluetoothDevicesSettings.
* @param[in] count Size of the versions array in entries. * @param[in] count Size of the settings array in entries.
*/ */
Result setsysGetBluetoothDevicesSettings(s32 *total_out, SetSysBluetoothDevicesSettings *settings, s32 count); Result setsysGetBluetoothDevicesSettings(s32 *total_out, SetSysBluetoothDevicesSettings *settings, s32 count);
@ -964,7 +967,7 @@ Result setsysGetExternalSteadyClockSourceId(Uuid *out);
/** /**
* @brief SetExternalSteadyClockSourceId * @brief SetExternalSteadyClockSourceId
* @param[in] settings \ref Uuid * @param[in] uuid \ref Uuid
*/ */
Result setsysSetExternalSteadyClockSourceId(const Uuid *uuid); Result setsysSetExternalSteadyClockSourceId(const Uuid *uuid);
@ -976,7 +979,7 @@ Result setsysGetUserSystemClockContext(TimeSystemClockContext *out);
/** /**
* @brief SetUserSystemClockContext * @brief SetUserSystemClockContext
* @param[in] settings \ref TimeSystemClockContext * @param[in] context \ref TimeSystemClockContext
*/ */
Result setsysSetUserSystemClockContext(const TimeSystemClockContext *context); Result setsysSetUserSystemClockContext(const TimeSystemClockContext *context);
@ -994,7 +997,7 @@ Result setsysSetAccountSettings(SetSysAccountSettings settings);
/** /**
* @brief GetAudioVolume * @brief GetAudioVolume
* @param[out] device \ref SetSysAudioDevice * @param[in] device \ref SetSysAudioDevice
* @param[out] out \ref SetSysAudioVolume * @param[out] out \ref SetSysAudioVolume
*/ */
Result setsysGetAudioVolume(SetSysAudioDevice device, SetSysAudioVolume *out); Result setsysGetAudioVolume(SetSysAudioDevice device, SetSysAudioVolume *out);
@ -1002,7 +1005,7 @@ Result setsysGetAudioVolume(SetSysAudioDevice device, SetSysAudioVolume *out);
/** /**
* @brief SetAudioVolume * @brief SetAudioVolume
* @param[in] device \ref SetSysAudioDevice * @param[in] device \ref SetSysAudioDevice
* @param[in] settings \ref SetSysAudioVolume * @param[in] volume \ref SetSysAudioVolume
*/ */
Result setsysSetAudioVolume(SetSysAudioDevice device, const SetSysAudioVolume *volume); Result setsysSetAudioVolume(SetSysAudioDevice device, const SetSysAudioVolume *volume);
@ -1234,7 +1237,7 @@ Result setsysGetNetworkSystemClockContext(TimeSystemClockContext *out);
/** /**
* @brief SetNetworkSystemClockContext * @brief SetNetworkSystemClockContext
* @param[in] settings \ref TimeSystemClockContext * @param[in] context \ref TimeSystemClockContext
*/ */
Result setsysSetNetworkSystemClockContext(const TimeSystemClockContext *context); Result setsysSetNetworkSystemClockContext(const TimeSystemClockContext *context);
@ -1387,7 +1390,7 @@ Result setsysGetTelemetryDirtyFlags(u64 *flags_0, u64 *flags_1);
* @brief GetPtmBatteryLot * @brief GetPtmBatteryLot
* @param[out] out \ref SetBatteryLot * @param[out] out \ref SetBatteryLot
*/ */
Result setsysGetPtmBatteryLot(SetBatteryLot *out) ; Result setsysGetPtmBatteryLot(SetBatteryLot *out);
/** /**
* @brief SetPtmBatteryLot * @brief SetPtmBatteryLot
@ -1630,7 +1633,7 @@ Result setsysSetHeadphoneVolumeUpdateFlag(bool flag);
Result setsysNeedsToUpdateHeadphoneVolume(u8 *a0, u8 *a1, u8 *a2, bool flag); Result setsysNeedsToUpdateHeadphoneVolume(u8 *a0, u8 *a1, u8 *a2, bool flag);
/** /**
* @brief HetPushNotificationActivityModeOnSleep * @brief GetPushNotificationActivityModeOnSleep
* @note Only available on [3.0.0+]. * @note Only available on [3.0.0+].
* @param[out] out Output mode. * @param[out] out Output mode.
*/ */
@ -1879,7 +1882,7 @@ Result setsysSetUserSystemClockAutomaticCorrectionUpdatedTime(const TimeSteadyCl
* @param[out] settings Output array of \ref SetSysAccountOnlineStorageSettings. * @param[out] settings Output array of \ref SetSysAccountOnlineStorageSettings.
* @param[in] count Size of the settings array in entries. * @param[in] count Size of the settings array in entries.
*/ */
Result setsysGetAccountOnlineStorageSettings(s32 *total_out, SetSysAccountOnlineStorageSettings *out, s32 count); Result setsysGetAccountOnlineStorageSettings(s32 *total_out, SetSysAccountOnlineStorageSettings *settings, s32 count);
/** /**
* @brief SetAccountOnlineStorageSettings * @brief SetAccountOnlineStorageSettings
@ -1929,7 +1932,7 @@ Result setsysGetAnalogStickUserCalibrationR(SetSysAnalogStickUserCalibration *ou
* @note Only available on [8.1.1+]. * @note Only available on [8.1.1+].
* @param[in] calibration \ref SetSysAnalogStickUserCalibration * @param[in] calibration \ref SetSysAnalogStickUserCalibration
*/ */
Result setsysSetAnalogStickUserCalibrationR(const SetSysAnalogStickUserCalibration *calibration) ; Result setsysSetAnalogStickUserCalibrationR(const SetSysAnalogStickUserCalibration *calibration);
/** /**
* @brief GetPtmBatteryVersion * @brief GetPtmBatteryVersion
@ -1987,7 +1990,7 @@ Result setsysGetThemeId(s32 type, SetSysThemeId *out);
* @param[in] type Input theme id type. * @param[in] type Input theme id type.
* @param[in] theme_id \ref SetSysThemeId * @param[in] theme_id \ref SetSysThemeId
*/ */
Result setsysSetThemeId(s32 type, const SetSysThemeId *theme_id) ; Result setsysSetThemeId(s32 type, const SetSysThemeId *theme_id);
/** /**
* @brief GetChineseTraditionalInputMethod * @brief GetChineseTraditionalInputMethod
@ -2067,14 +2070,16 @@ Result setsysGetZoomFlag(bool *out);
Result setsysSetZoomFlag(bool flag); Result setsysSetZoomFlag(bool flag);
/** /**
* @brief On 9.0.0, this is a wrapper for \ref setsysGetPlatFormRegion() == 2. * @brief Returns Terra platform type flag.
* @note On [9.0.0+], this is a wrapper for \ref setsysGetPlatFormRegion() == 2.
* @note Only available on [8.0.0+]. * @note Only available on [8.0.0+].
* @param[out] out Output flag. * @param[out] out Output flag.
*/ */
Result setsysGetT(bool *out); Result setsysGetT(bool *out);
/** /**
* @brief On 9.0.0, this is a wrapper for \ref setsysSetPlatFormRegion(1 + (IsT & 1)). * @brief Sets Terra platform type flag.
* @note On [9.0.0+], this is a wrapper for \ref setsysSetPlatFormRegion(1 + (IsT & 1)).
* @note Only available on [8.0.0+]. * @note Only available on [8.0.0+].
* @param[in] flag Input flag. * @param[in] flag Input flag.
*/ */