elduko/Arduino-Volume-Controller
1
0
Fork 0
Code Pull Requests Actions Activity

Added javadoc comments to staff functions

Browse Source
This commit is contained in:
ElDuko
2025-10-23 13:47:42 +02:00
parent 632dc68ea0
commit 71080e2ddf
3 changed files with 39 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
include/staffFunctions.h
View File

@@ -1,4 +1,17 @@
#pragma once
/**
* @brief Used to increase the maximum staff volume
*
* @param maxVolume Pointer to the variable used to keep track of staff volume
*/
void staffVolumeUp(int *maxVolume);
/**
* @brief Used to decrease the maximum staff volume. If the max volume is set lower than what the current user volume is, then the user volume will also be lowered.
*
* @param maxVolume Variable used to keep track of the max volume
* @param userVolume Pointer to the variable used to keep track of the user volume
* @param oldUserVolume Pointer to the variable used to keep track of the user volume when in mute or lowered
*/
void staffVolumeDown(int maxVolume, int *userVolume, int *oldUserVolume);