diff options
| author | 2017-02-26 20:58:51 -0500 | |
|---|---|---|
| committer | 2017-02-26 17:58:51 -0800 | |
| commit | 0cb52ee74a8255eb0320c882bc9e70700317d16a (patch) | |
| tree | 800920c60df4d183d20d94465e0886e5655216a0 /src/core/hle | |
| parent | Merge pull request #2587 from yuriks/status-bar (diff) | |
| download | yuzu-0cb52ee74a8255eb0320c882bc9e70700317d16a.tar.gz yuzu-0cb52ee74a8255eb0320c882bc9e70700317d16a.tar.xz yuzu-0cb52ee74a8255eb0320c882bc9e70700317d16a.zip | |
Doxygen: Amend minor issues (#2593)
Corrects a few issues with regards to Doxygen documentation, for example:
- Incorrect parameter referencing.
- Missing @param tags.
- Typos in @param tags.
and a few minor other issues.
Diffstat (limited to 'src/core/hle')
| -rw-r--r-- | src/core/hle/ipc.h | 4 | ||||
| -rw-r--r-- | src/core/hle/kernel/server_session.h | 3 | ||||
| -rw-r--r-- | src/core/hle/service/cam/cam.h | 2 | ||||
| -rw-r--r-- | src/core/hle/service/gsp_gpu.cpp | 6 | ||||
| -rw-r--r-- | src/core/hle/service/ldr_ro/cro_helper.h | 4 |
5 files changed, 10 insertions, 9 deletions
diff --git a/src/core/hle/ipc.h b/src/core/hle/ipc.h index bbaae8b79..cd9a5863d 100644 --- a/src/core/hle/ipc.h +++ b/src/core/hle/ipc.h | |||
| @@ -72,8 +72,8 @@ union Header { | |||
| 72 | * through modifications and checks by the kernel. | 72 | * through modifications and checks by the kernel. |
| 73 | * The translate parameters are described by headers generated with the IPC::*Desc functions. | 73 | * The translate parameters are described by headers generated with the IPC::*Desc functions. |
| 74 | * | 74 | * |
| 75 | * @note While #normal_params_size is equivalent to the number of normal parameters, | 75 | * @note While @p normal_params_size is equivalent to the number of normal parameters, |
| 76 | * #translate_params_size includes the size occupied by the translate parameters headers. | 76 | * @p translate_params_size includes the size occupied by the translate parameters headers. |
| 77 | */ | 77 | */ |
| 78 | inline u32 MakeHeader(u16 command_id, unsigned int normal_params_size, | 78 | inline u32 MakeHeader(u16 command_id, unsigned int normal_params_size, |
| 79 | unsigned int translate_params_size) { | 79 | unsigned int translate_params_size) { |
diff --git a/src/core/hle/kernel/server_session.h b/src/core/hle/kernel/server_session.h index 4ffe97b78..761fc4781 100644 --- a/src/core/hle/kernel/server_session.h +++ b/src/core/hle/kernel/server_session.h | |||
| @@ -45,7 +45,8 @@ public: | |||
| 45 | 45 | ||
| 46 | /** | 46 | /** |
| 47 | * Creates a pair of ServerSession and an associated ClientSession. | 47 | * Creates a pair of ServerSession and an associated ClientSession. |
| 48 | * @param name Optional name of the ports | 48 | * @param name Optional name of the ports. |
| 49 | * @param hle_handler Optional HLE handler for this server session. | ||
| 49 | * @return The created session tuple | 50 | * @return The created session tuple |
| 50 | */ | 51 | */ |
| 51 | static SessionPair CreateSessionPair( | 52 | static SessionPair CreateSessionPair( |
diff --git a/src/core/hle/service/cam/cam.h b/src/core/hle/service/cam/cam.h index f6bff8bc6..34a9c8479 100644 --- a/src/core/hle/service/cam/cam.h +++ b/src/core/hle/service/cam/cam.h | |||
| @@ -518,7 +518,7 @@ void FlipImage(Service::Interface* self); | |||
| 518 | void SetDetailSize(Service::Interface* self); | 518 | void SetDetailSize(Service::Interface* self); |
| 519 | 519 | ||
| 520 | /** | 520 | /** |
| 521 | * Sets camera resolution from preset resolution parameters. . | 521 | * Sets camera resolution from preset resolution parameters. |
| 522 | * Inputs: | 522 | * Inputs: |
| 523 | * 0: 0x001F00C0 | 523 | * 0: 0x001F00C0 |
| 524 | * 1: u8 selected camera | 524 | * 1: u8 selected camera |
diff --git a/src/core/hle/service/gsp_gpu.cpp b/src/core/hle/service/gsp_gpu.cpp index 097ed87e4..a960778a7 100644 --- a/src/core/hle/service/gsp_gpu.cpp +++ b/src/core/hle/service/gsp_gpu.cpp | |||
| @@ -119,10 +119,10 @@ static ResultCode WriteHWRegs(u32 base_address, u32 size_in_bytes, VAddr data_va | |||
| 119 | * Updates sequential GSP GPU hardware registers using parallel arrays of source data and masks. | 119 | * Updates sequential GSP GPU hardware registers using parallel arrays of source data and masks. |
| 120 | * For each register, the value is updated only where the mask is high | 120 | * For each register, the value is updated only where the mask is high |
| 121 | * | 121 | * |
| 122 | * @param base_address The address of the first register in the sequence | 122 | * @param base_address The address of the first register in the sequence |
| 123 | * @param size_in_bytes The number of registers to update (size of data) | 123 | * @param size_in_bytes The number of registers to update (size of data) |
| 124 | * @param data A pointer to the source data to use for updates | 124 | * @param data_vaddr A virtual address to the source data to use for updates |
| 125 | * @param masks A pointer to the masks | 125 | * @param masks_vaddr A virtual address to the masks |
| 126 | * @return RESULT_SUCCESS if the parameters are valid, error code otherwise | 126 | * @return RESULT_SUCCESS if the parameters are valid, error code otherwise |
| 127 | */ | 127 | */ |
| 128 | static ResultCode WriteHWRegsWithMask(u32 base_address, u32 size_in_bytes, VAddr data_vaddr, | 128 | static ResultCode WriteHWRegsWithMask(u32 base_address, u32 size_in_bytes, VAddr data_vaddr, |
diff --git a/src/core/hle/service/ldr_ro/cro_helper.h b/src/core/hle/service/ldr_ro/cro_helper.h index 060d5a55f..3bc10dbdc 100644 --- a/src/core/hle/service/ldr_ro/cro_helper.h +++ b/src/core/hle/service/ldr_ro/cro_helper.h | |||
| @@ -57,7 +57,7 @@ public: | |||
| 57 | * @param is_crs true if the module itself is the static module | 57 | * @param is_crs true if the module itself is the static module |
| 58 | * @returns ResultCode RESULT_SUCCESS on success, otherwise error code. | 58 | * @returns ResultCode RESULT_SUCCESS on success, otherwise error code. |
| 59 | */ | 59 | */ |
| 60 | ResultCode Rebase(VAddr crs_address, u32 cro_size, VAddr data_segment_addresss, | 60 | ResultCode Rebase(VAddr crs_address, u32 cro_size, VAddr data_segment_address, |
| 61 | u32 data_segment_size, VAddr bss_segment_address, u32 bss_segment_size, | 61 | u32 data_segment_size, VAddr bss_segment_address, u32 bss_segment_size, |
| 62 | bool is_crs); | 62 | bool is_crs); |
| 63 | 63 | ||
| @@ -102,7 +102,7 @@ public: | |||
| 102 | /** | 102 | /** |
| 103 | * Registers this module and adds it to the module list. | 103 | * Registers this module and adds it to the module list. |
| 104 | * @param crs_address the virtual address of the static module | 104 | * @param crs_address the virtual address of the static module |
| 105 | * @auto_link whether to register as an auto link module | 105 | * @param auto_link whether to register as an auto link module |
| 106 | */ | 106 | */ |
| 107 | void Register(VAddr crs_address, bool auto_link); | 107 | void Register(VAddr crs_address, bool auto_link); |
| 108 | 108 | ||