private/hsb
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fixed comments

Browse Source 
git-svn-id: https://svn.vbchaos.nl/svn/hsb/trunk@409 05563f52-14a8-4384-a975-3d1654cca0fa
This commit is contained in:
mmi
2017-12-18 14:32:51 +00:00
parent e92304755c
commit 0fb4fa7deb
11 changed files with 451 additions and 62 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/Buzzer.h
View File

@@ -83,14 +83,16 @@ struct Buzzer
/** ----------------------------------------------------------------------------
* Buzzer_construct
* Description of function
* Constructor for a new buzzer instance
*
* @param self
* @param gpio
* @param taskPriority
* @param stackSize
* @param self The buzzer object that gets created
* @param gpio The GPIO to use
* @param taskPriority FreeRTOS task priority
* @param stackSize FreeRTOS stack size
*
* @return ErrorStatus
* @return ErrorStatus SUCCESS if constructor was successful,
* including generation/start of task
* ERROR otherwise
*
* @todo
* -----------------------------------------------------------------------------
@@ -100,9 +102,9 @@ extern ErrorStatus Buzzer_construct(struct Buzzer* self, struct Gpio* gpio, int
/** ----------------------------------------------------------------------------
* Buzzer_destruct
* Description of function
* Destructor for buzzer instance. Also removes the buzzer task
*
* @param self
* @param self The buzzer instance to destruct
*
* @return void
*
@@ -114,10 +116,13 @@ extern void Buzzer_destruct(struct Buzzer* self);
/** ----------------------------------------------------------------------------
* Buzzer_start
* Description of function
* Starts the buzzer with a repeating tone.
* Tone length is given with argument pulseWidth
*
* @param self
* @param pulseWidth
* @param self The buzzer instance to use
* @param pulseWidth The length of the tone in ms. Also defines
* the length of the pause between two
* tones
*
* @return void
*
@@ -129,10 +134,10 @@ extern void Buzzer_start(struct Buzzer* self, unsigned int pulseWidth);
/** ----------------------------------------------------------------------------
* Buzzer_stop
* Description of function
* Stops the repeating buzzer tone
*
* @param self THe buzzer instance to stop
*
* @param self
* @param
* @return void
*
* @todo
@@ -143,10 +148,11 @@ extern void Buzzer_stop(struct Buzzer* self);
/** ----------------------------------------------------------------------------
* Buzzer_singleTone
* Description of function
* Creates a single tone with the length given in pulseWidth
*
* @param self The buzzer instance to use
* @param pulseWidth The length of the tone in ms
*
* @param self
* @param pulseWidth
* @return void
*
* @todo