2
1
Fork 0
mirror of https://github.com/yuzu-emu/yuzu.git synced 2024-07-04 23:31:19 +01:00

Merge pull request #499 from lioncash/docs

core: Fix a few docstrings
This commit is contained in:
bunnei 2015-01-20 14:33:34 -05:00
commit 7c21b80236
4 changed files with 4 additions and 4 deletions

View file

@ -134,7 +134,7 @@ void WaitCurrentThread(WaitType wait_type, Object* wait_object = GetCurrentThrea
/** /**
* Schedules an event to wake up the specified thread after the specified delay. * Schedules an event to wake up the specified thread after the specified delay.
* @param handle The thread handle. * @param thread The thread to wake after the delay.
* @param nanoseconds The time this thread will be allowed to sleep for. * @param nanoseconds The time this thread will be allowed to sleep for.
*/ */
void WakeThreadAfterDelay(Thread* thread, s64 nanoseconds); void WakeThreadAfterDelay(Thread* thread, s64 nanoseconds);

View file

@ -33,7 +33,7 @@ ResultCode ClearTimer(Handle handle);
/** /**
* Creates a timer * Creates a timer
* @param Handle to newly created Timer object * @param handle Handle to the newly created Timer object
* @param reset_type ResetType describing how to create the timer * @param reset_type ResetType describing how to create the timer
* @param name Optional name of timer * @param name Optional name of timer
* @return ResultCode of the error * @return ResultCode of the error

View file

@ -110,7 +110,7 @@ ResultCode GetConfigInfoBlock(u32 block_id, u32 size, u32 flag, u8* output);
* The config savegame file in the filesystem is not updated. * The config savegame file in the filesystem is not updated.
* @param block_id The id of the block we want to create * @param block_id The id of the block we want to create
* @param size The size of the block we want to create * @param size The size of the block we want to create
* @param flag The flags of the new block * @param flags The flags of the new block
* @param data A pointer containing the data we will write to the new block * @param data A pointer containing the data we will write to the new block
* @returns ResultCode indicating the result of the operation, 0 on success * @returns ResultCode indicating the result of the operation, 0 on success
*/ */

View file

@ -42,7 +42,7 @@ ResultVal<ArchiveHandle> OpenArchive(ArchiveIdCode id_code, FileSys::Path& archi
/** /**
* Closes an archive * Closes an archive
* @param id_code IdCode of the archive to open * @param handle Handle to the archive to close
*/ */
ResultCode CloseArchive(ArchiveHandle handle); ResultCode CloseArchive(ArchiveHandle handle);