alexey.zholtikov/upm
1
0
Fork 0
mirror of https://github.com/eclipse/upm.git synced 2025-07-02 01:41:12 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: more header files edited

Browse Source 
Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
This commit is contained in:
VadimPopov
2015-08-09 22:51:25 +03:00
committed by Mihai Tudor Panu
parent 55e8076988
commit 04edb9be04
68 changed files with 1172 additions and 1172 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
src/buzzer/buzzer.h
View File

@ -51,7 +51,7 @@ namespace upm {
* @con pwm
* @kit gsk
*
* @brief API for Buzzer component
* @brief API for the Buzzer component
*
* This file defines the Buzzer interface for libbuzzer.
* This sensor can make different tones when connected to
@ -77,42 +77,42 @@ class Buzzer {
~Buzzer ();
/**
* Play a tone for a certain amount of time or indefinitely. When delay
* Plays a tone for a certain amount of time or indefinitely. When delay
* is not used, the sound can be stopped by calling stopSound().
*
* @param note the note to be played (DO, RE, MI, etc...) or frequency
* @param delay time in microseconds for playing the sound, a value of
* 0 plays the sound indefinitely
* @param note Note to play (C, D, E, etc.) or frequency
* @param delay Time in microseconds for which to play the sound; if the value is
* 0, the sound is played indefinitely
*
* @return the note played
* @return Note played
*/
int playSound (int note, int delay);
/**
* Stops the sound currently playing. Has to be called when playSound()
* does not set a delay value.
* Stops the sound currently playing. Should be called when playSound()
* does not have a delay value.
*/
void stopSound();
/**
* Sets the volume for the buzzer, but may affect the sound timbre.
* Works best with halved values, e.g. 1.0, 0.5, 0.25, ...
* Works best with halved values; e.g., 1.0, 0.5, 0.25, etc.
*
* @param vol the value to set the volume to from 0.0 to 1.0
* @param vol Value to set the volume to, from 0.0 to 1.0
*/
void setVolume(float vol);
/**
* Gets the buzzer volume.
*
* @return the value the volume was set to
* @return Value the volume was set to
*/
float getVolume();
/**
* Return name of the component.
* Returns the name of the sensor.
*
* @return name of the sensor
* @return Name of the sensor
*/
std::string name()
{