![](/media/cache/profiles/LinkedIn_0NghoZJ.jpeg.50x50_q85.jpg)
Snake vs Block Game to be run upon K64F.
Diff: MenuClasses/Settings/Settings.h
- Revision:
- 91:ca8cff78f2fe
- Parent:
- 89:8fbb0405a916
--- a/MenuClasses/Settings/Settings.h Wed May 08 21:01:20 2019 +0000 +++ b/MenuClasses/Settings/Settings.h Wed May 08 21:29:06 2019 +0000 @@ -19,40 +19,54 @@ /** Destructor */ ~Settings(); - /** Gets pointers of lcd and pad from int main() and initialises variables used in the class. - * @param pointer to the N5110 object in main, address of this pointer is saved to make availability to the entire class, without passing address to each function. - * @param pointer to the gamepad object in main, address of this pointer is saved to make availability to the entire class, without passing address to each function. + /** + * @brief Gets pointers of lcd and pad from int main() and initialises variables used in the class. + * @param N5110 *lcd @details pointer to the N5110 object in main, address of this pointer is saved to make availability to the entire class, without passing address to each function. + * @param Gamepad *pad @details pointer to the gamepad object in main, address of this pointer is saved to make availability to the entire class, without passing address to each function. */ void init(N5110 *lcd, Gamepad *pad); /** * @brief Used to select between various settings functions using user input. - * @param controlSensitivity is the value that determines the wait time between performing menu tasks. - * @return values of controlSensitivity and showCredits are saved in an array called cs_sc which is returned to the StartScreen class as a pointer. + * @param controlSensitivity @details is the value that determines the wait time between performing menu tasks. + * @returns cs_sc @details values of controlSensitivity and showCredits are saved in an array called cs_sc which is returned to the StartScreen class as a pointer. */ float * Implement(float controlSensitivity); - /** Shows the information for using settings.*/ + /** + * @brief Shows the information for using settings. + */ void info(); - /** Calls the respective settings menu as per the joystick entry by the user. - * @param settingsIndex is the value that is used to select the relevant settings page. + /** + * @brief Calls the respective settings menu as per the joystick entry by the user. + * @param settingsIndex @details is the value that is used to select the relevant settings page. */ void CallFunctions(int settingsIndex); - /** Enables the user to select the sensitivity of the game controls and saves it in cs_sc[0]*/ + /** + * @brief Enables the user to select the sensitivity of the game controls and saves it in cs_sc[0] + */ void controlSensitivity(); - /** Allows the user to set the screen brightness.*/ + /** + * @brief Allows the user to set the screen brightness. + */ void brigntness(); - /** Allows the user to set the contrast of the screen.*/ + /** + * @brief Allows the user to set the contrast of the screen. + */ void contrast(); - /** Allows the user to set the volume of the speaker.*/ + /** + * @brief Allows the user to set the volume of the speaker. + */ void volume(); - /** Allows the user to hide/show credits.*/ + /** + * @brief Allows the user to hide/show credits. + */ void showCredits(); private: