docs: updated @param tags, added missing function descriptions, other minor changes

Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
This commit is contained in:
Mihai Tudor Panu
2017-04-10 16:59:39 -07:00
parent 39df7fd10f
commit 3aef2ea70e
94 changed files with 327 additions and 222 deletions

View File

@ -50,10 +50,28 @@ typedef struct _mic_context {
uint16_t analog_pin;
} *mic_context;
/**
* Microphone sensor initialization function
*
* @param pin analog pin to use
* @return sensor context
*/
mic_context mic_init(int pin);
/**
* Microphone sensor destructor
*
* @param dev sensor context pointer
*/
void mic_close(mic_context dev);
/**
* Gets a sample from the microphone
*
* @param dev sensor context pointer
* @param micval microphone value in ADC counts
* @return result of the operation
*/
upm_result_t mic_get_value(mic_context dev, float* micval);
#endif /* MIC_H_ */