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

Fixed doxygen not working

Browse Source
This commit is contained in:
ElDuko
2025-10-23 13:40:23 +02:00
parent f6452e5009
commit 632dc68ea0
4 changed files with 3006 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
.gitignore vendored
View File

@@ -3,3 +3,4 @@
.vscode/c_cpp_properties.json .vscode/c_cpp_properties.json
.vscode/launch.json .vscode/launch.json
.vscode/ipch .vscode/ipch
docs/

2987
Doxyfile Normal file
View File

File diff suppressed because it is too large Load Diff

18
include/userFunctions.h
View File

@@ -1,40 +1,40 @@
#pragma once #pragma once
/** /**
* This function is used to increase the volume * @brief This function is used to increase the volume
* *
* @param userVolume Pointer to the variable used to keep track of the current user volume. It is being passed in so the function can increment it with the potentiometer steps. * @param userVolume Pointer to the variable used to keep track of the current user volume. It is being passed in so the function can increment it with the potentiometer steps.
* @param oldUserVolume Pointer to the variable used to keep track of the user volume while muted or lowered. It is being passed in so the function can increment it with the potentiometer steps. * @param oldUserVolume Pointer to the variable used to keep track of the user volume while muted or lowered. It is being passed in so the function can increment it with the potentiometer steps.
* @param maxVolume The highest point that the volume can be set to. * @param maxVolume The highest point that the volume can be set to.
* *
*/ */
void volumeUp(int *userVolume, int *oldUserVolume, int maxVolume); void volumeUp(int *userVolume, int *oldUserVolume, int maxVolume);
/** /**
* This function is used to decrease the volume * This function is used to decrease the volume
* *
* @param userVolume Pointer to the variable used to keep track of the current user volume. It is being passed in so the function can increment it with the potentiometer steps. * @param userVolume Pointer to the variable used to keep track of the current user volume. It is being passed in so the function can increment it with the potentiometer steps.
* @param oldUserVolume Pointer to the variable used to keep track of the user volume while muted or lowered. It is being passed in so the function can increment it with the potentiometer steps. * @param oldUserVolume Pointer to the variable used to keep track of the user volume while muted or lowered. It is being passed in so the function can increment it with the potentiometer steps.
* *
*/ */
void volumeDown(int *userVolume, int *oldUserVolume); void volumeDown(int *userVolume, int *oldUserVolume);
/** /**
* This function is used to significantly lower the volume. If the function is called while in a lowered state it will revert the volume to what it previously was. * This function is used to significantly lower the volume. If the function is called while in a lowered state it will revert the volume to what it previously was.
* *
* @param userVolume Pointer to the variable used to keep track of the current user volume. It is being passed in so the function can increment it with the potentiometer steps. * @param userVolume Pointer to the variable used to keep track of the current user volume. It is being passed in so the function can increment it with the potentiometer steps.
* @param oldUserVolume Pointer to the variable used to keep track of the user volume while muted or lowered. It is being passed in so the function can increment it with the potentiometer steps. * @param oldUserVolume Pointer to the variable used to keep track of the user volume while muted or lowered. It is being passed in so the function can increment it with the potentiometer steps.
* @param maxVolume The highest point that the volume can be set to. * @param maxVolume The highest point that the volume can be set to.
* *
*/ */
void lowerVolume(int *userVolume, int *oldUserVolume, int maxVolume); void lowerVolume(int *userVolume, int *oldUserVolume, int maxVolume);
/** /**
* This function is used to mute the volume. If the function is called while in a muted state it will revert the volume to what it previously was. * This function is used to mute the volume. If the function is called while in a muted state it will revert the volume to what it previously was.
* *
* @param userVolume Pointer to the variable used to keep track of the current user volume. It is being passed in so the function can increment it with the potentiometer steps. * @param userVolume Pointer to the variable used to keep track of the current user volume. It is being passed in so the function can increment it with the potentiometer steps.
* @param oldUserVolume Pointer to the variable used to keep track of the user volume while muted or lowered. It is being passed in so the function can increment it with the potentiometer steps. * @param oldUserVolume Pointer to the variable used to keep track of the user volume while muted or lowered. It is being passed in so the function can increment it with the potentiometer steps.
* @param maxVolume The highest point that the volume can be set to. * @param maxVolume The highest point that the volume can be set to.
* *
*/ */
void mute(int *userVolume, int *oldUserVolume, int maxVolume); void mute(int *userVolume, int *oldUserVolume, int maxVolume);

9
src/userFunctions.cpp
View File

@@ -1,3 +1,12 @@
/**
* @file userFunctions.cpp
* @author Lyubomir Penev
* @brief Here are all the implementations for the user functions.
* @version 1.0
* @date 2025-10-23
*
*/
#include <userFunctions.h> #include <userFunctions.h>
#include <constants.h> #include <constants.h>
#include <potControlls.h> #include <potControlls.h>