From 9db62789153b61521d6e0c37671f02d8f986f587 Mon Sep 17 00:00:00 2001 From: Ash Date: Wed, 18 Jul 2018 21:33:50 +1000 Subject: [PATCH] include/coreinit/core.h: Add Doxygen docs for Core group. --- include/coreinit/core.h | 27 +++++++++++++++++++++++---- 1 file changed, 23 insertions(+), 4 deletions(-) diff --git a/include/coreinit/core.h b/include/coreinit/core.h index 2298a7e..a34e677 100644 --- a/include/coreinit/core.h +++ b/include/coreinit/core.h @@ -4,6 +4,9 @@ /** * \defgroup coreinit_core Core * \ingroup coreinit + * + * The coreinit Core group of functions provide information about each core of + * the system's processor. * @{ */ @@ -13,28 +16,44 @@ extern "C" { /** - * Returns the number of cores, should always be 3. + * Gets the number of cores in the system. On a retail Wii U, this is always 3. + * + * \returns + * The core count of the system. */ uint32_t OSGetCoreCount(); /** - * Returns the ID of the core currently executing this thread. + * Gets the core executing the current thread. + * + * \returns + * The ID of the current core. */ uint32_t OSGetCoreId(); /** - * Returns the ID of the main core. + * Gets the main core of the system. On a retail Wii U, this is always core 1. + * + * \returns + * The ID of the main core. */ uint32_t OSGetMainCoreId(); /** - * Returns true if the current core is the main core. + * Determines whether the current thread is running on the main core. + * On a retail Wii U, the main core is always core 1. + * + * \returns + * \c true if the current core is the main core. + * + * \sa + * */ BOOL OSIsMainCore();