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

docs: final batch of header files reviewed

Browse Source 
Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
This commit is contained in:
VadimPopov
2015-08-10 18:53:31 +03:00
committed by Mihai Tudor Panu
parent 04edb9be04
commit 1fe9b9eb1d
53 changed files with 1182 additions and 1191 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
src/rfr359f/rfr359f.h
View File

@ -44,11 +44,11 @@ namespace upm {
* @con gpio
* @kit robok tsk
*
* @brief API for the RFR359F based Grove Distance Interrupter.
* @brief API for the RFR359F-based Grove Distance Interrupter.
*
* UPM module for the Grove Distance Interrupter. The sensitivity
* can be adjusted with the potentiometer on the sensor module. It
* has a range of approximately 4 inches and a fast response time.
* UPM module for the Grove distance interrupter. The sensitivity
* can be adjusted with the potentiometer on the sensor module. It
* has a range of approximately 4 inches and a quick response time.
*
* @image html rfr359f.jpg
* @snippet rfr359f.cxx Interesting
@ -56,21 +56,21 @@ namespace upm {
class RFR359F {
public:
/**
* Grove Distance Interrupter constructor
* RFR359F constructor
*
* @param pin digital pin to use
* @param pin Digital pin to use
*/
RFR359F(int pin);
/**
* RFR359F Destructor
* RFR359F destructor
*/
~RFR359F();
/**
* Get the status of the pin, true means object detected
* Gets the status of the pin; true means an object has been detected
*
* @return true if the sensor detected an object
* @return True if the sensor has detected an object
*/
bool objectDetected();