From 0ff59bbc188cc906c8c2f7cb28ef87e618f54d1e Mon Sep 17 00:00:00 2001 From: Liam Minopulos Date: Thu, 28 Feb 2019 09:00:12 +0100 Subject: [PATCH] Fix documentation --- nx/include/switch/applets/error.h | 17 ++++++++--------- 1 file changed, 8 insertions(+), 9 deletions(-) diff --git a/nx/include/switch/applets/error.h b/nx/include/switch/applets/error.h index c3b9022c..6828de01 100644 --- a/nx/include/switch/applets/error.h +++ b/nx/include/switch/applets/error.h @@ -8,7 +8,6 @@ #include "../types.h" #include "../services/applet.h" -/// Error configuration struct. typedef struct { u8 custom_text; ///< Whether to show a custom error message. If this is false, a default message will be shown. u8 unk[7]; @@ -35,41 +34,41 @@ void errorClose(ErrorConfig* c); /** * @brief Launches with the specified config. - * @param c ErrorConfig struct + * @param c ErrorConfig struct. */ void errorShow(ErrorConfig* c); /** - * @brief Sets the first part of the error code. - * @param c ErrorConfig struct + * @brief Sets the error module. + * @param c ErrorConfig struct. * @param code Code. */ void errorConfigSetModule(ErrorConfig* c, u32 code); /** - * @brief Sets the second part of the error code. - * @param c ErrorConfig struct + * @brief Sets the error description. + * @param c ErrorConfig struct. * @param code Code. */ void errorConfigSetDescription(ErrorConfig* c, u32 code); /** * @brief Sets whether to use a custom error message. - * @param c ErrorConfig struct + * @param c ErrorConfig struct. * @param custom_text Whether to use a custom message. */ void errorConfigSetCustomText(ErrorConfig* c, bool custom_text); /** * @brief Sets the short description. - * @param c ErrorConfig struct + * @param c ErrorConfig struct. * @param str Description. */ void errorConfigSetShortDescription(ErrorConfig* c, const char* str); /** * @brief Sets the detailed description. - * @param c ErrorConfig struct + * @param c ErrorConfig struct. * @param str Description. * * This gets displayed when the user clicks on "Details".