OpenPunk/citra
1
0
Fork 0
mirror of https://github.com/citra-emu/citra.git synced 2024-12-18 17:30:05 +00:00
Code Issues Projects Releases Wiki Activity

apt: fix doc format

Browse Source
This commit is contained in:
wwylele 2018-02-09 18:10:46 +02:00
parent 8970e28031
commit 66141ed004
1 changed files with 21 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

56
src/core/hle/service/apt/apt.h
View File

@ -181,12 +181,10 @@ public:
/** /**
* APT::IsRegistered service function. This returns whether the specified AppID is * APT::IsRegistered service function. This returns whether the specified AppID is
* registered with * registered with NS yet. An AppID is "registered" once the process associated with the
* NS yet. An AppID is "registered" once the process associated with the AppID uses * AppID uses APT:Enable. Home Menu uses this command to determine when the launched process
* APT:Enable. Home * is running and to determine when to stop using GSP, etc., while displaying the "Nintendo
* Menu uses this command to determine when the launched process is running and to determine * 3DS" loading screen.
* when to
* stop using GSP, etc., while displaying the "Nintendo 3DS" loading screen.
* *
* Inputs: * Inputs:
* 1 : AppID * 1 : AppID
@ -219,14 +217,10 @@ public:
/** /**
* APT::ReceiveParameter service function. This returns the current parameter data from NS * APT::ReceiveParameter service function. This returns the current parameter data from NS
* state, * state, from the source process which set the parameters. Once finished, NS will clear a
* from the source process which set the parameters. Once finished, NS will clear a flag in * flag in the NS state so that this command will return an error if this command is used
* the NS * again if parameters were not set again. This is called when the second Initialize event
* state so that this command will return an error if this command is used again if * is triggered. It returns a signal type indicating why it was triggered.
* parameters were
* not set again. This is called when the second Initialize event is triggered. It returns a
* signal
* type indicating why it was triggered.
* Inputs: * Inputs:
* 1 : AppID * 1 : AppID
* 2 : Parameter buffer size, max size is 0x1000 * 2 : Parameter buffer size, max size is 0x1000
@ -245,10 +239,9 @@ public:
/** /**
* APT::GlanceParameter service function. This is exactly the same as * APT::GlanceParameter service function. This is exactly the same as
* APT_U::ReceiveParameter * APT_U::ReceiveParameter (except for the word value prior to the output handle), except
* (except for the word value prior to the output handle), except this will not clear the * this will not clear the flag (except when responseword[3]==8 || responseword[3]==9) in NS
* flag * state.
* (except when responseword[3]==8 || responseword[3]==9) in NS state.
* Inputs: * Inputs:
* 1 : AppID * 1 : AppID
* 2 : Parameter buffer size, max size is 0x1000 * 2 : Parameter buffer size, max size is 0x1000
@ -267,11 +260,9 @@ public:
/** /**
* APT::CancelParameter service function. When the parameter data is available, and when the * APT::CancelParameter service function. When the parameter data is available, and when the
* above * above specified fields match the ones in NS state(for the ones where the checks are
* specified fields match the ones in NS state(for the ones where the checks are enabled), * enabled), this clears the flag which indicates that parameter data is available (same
* this * flag cleared by APT:ReceiveParameter).
* clears the flag which indicates that parameter data is available
* (same flag cleared by APT:ReceiveParameter).
* Inputs: * Inputs:
* 1 : Flag, when non-zero NS will compare the word after this one with a field in the * 1 : Flag, when non-zero NS will compare the word after this one with a field in the
* NS * NS
@ -293,16 +284,12 @@ public:
/** /**
* APT::PrepareToStartApplication service function. When the input title-info programID is * APT::PrepareToStartApplication service function. When the input title-info programID is
* zero, * zero, NS will load the actual program ID via AMNet:GetTitleIDList. After doing some
* NS will load the actual program ID via AMNet:GetTitleIDList. After doing some checks with * checks with the programID, NS will then set a NS state flag to value 1, then set the
* the * programID for AppID 0x300(application) to the input program ID(or the one from
* programID, NS will then set a NS state flag to value 1, then set the programID for AppID * GetTitleIDList). A media-type field in the NS state is also set to the input media-type
* 0x300(application) to the input program ID(or the one from GetTitleIDList). A media-type * value (other state fields are set at this point as well). With 8.0.0-18, NS will set an
* field * u8 NS state field to value 1 when input flags bit8 is set.
* in the NS state is also set to the input media-type value
* (other state fields are set at this point as well). With 8.0.0-18, NS will set an u8 NS
* state
* field to value 1 when input flags bit8 is set
* Inputs: * Inputs:
* 1-4 : 0x10-byte title-info struct * 1-4 : 0x10-byte title-info struct
* 4 : Flags * 4 : Flags
@ -314,8 +301,7 @@ public:
/** /**
* APT::StartApplication service function. Buf0 is copied to NS FIRMparams+0x0, then Buf1 is * APT::StartApplication service function. Buf0 is copied to NS FIRMparams+0x0, then Buf1 is
* copied * copied to the NS FIRMparams+0x480. Then the application is launched.
* to the NS FIRMparams+0x480. Then the application is launched.
* Inputs: * Inputs:
* 1 : Buffer 0 size, max size is 0x300 * 1 : Buffer 0 size, max size is 0x300
* 2 : Buffer 1 size, max size is 0x20 (this can be zero) * 2 : Buffer 1 size, max size is 0x20 (this can be zero)