alexey.zholtikov/upm
1
0
Fork 0
mirror of https://github.com/eclipse/upm.git synced 2025-07-04 02:41: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

24
src/sm130/sm130.h
View File

@ -41,7 +41,7 @@
namespace upm {
/**
* @brief SM130 RFID reader module sensor library
* @brief SM130 RFID Reader Module library
* @defgroup sm130 libupm-sm130
* @ingroup sparkfun gpio rfid
*/
@ -54,12 +54,12 @@ namespace upm {
* @web https://www.sparkfun.com/products/10126
* @con gpio
*
* @brief API for SM130 RFID reader module
* @brief API for the SM130 RFID Reader Module
*
* This file defines the interface for sm130 RFID library
* This file defines the SM130 interface for the sm130 RFID library
*
* @image html sm130.jpg
* <br><em>SM130 RFID Reader image provided by SparkFun under
* <br><em>SM130 RFID Reader image provided by SparkFun* under
* <a href=https://creativecommons.org/licenses/by-nc-sa/3.0/>
* CC BY-NC-SA-3.0</a>.</em>
*
@ -103,10 +103,10 @@ class SM130 {
static const uint8_t CMD_SLEEP = 0x96;
/**
* Instanciates a SM130 object
* Instantiates an SM130 object
*
* @param di data pin
* @param dcki clock pin
* @param di Data pin
* @param dcki Clock pin
*/
SM130 (int bus, int devAddr, int rst, int dready);
@ -116,22 +116,22 @@ class SM130 {
~SM130 ();
/**
* Get the firmware version string.
* Gets the firmware version string.
*/
const char* getFirmwareVersion ();
/**
* Checks for availability of a valid response packet.
*
* This function should always be called and return true prior to using results
* This function should always be called and return true prior to using the results
* of a command.
*
* @returns true if a valid response packet is available
* @returns True if a valid response packet is available
*/
uint8_t available ();
/**
* Returns the packet length, excluding checksum
* Returns the packet length, excluding the checksum
*/
uint8_t getPacketLength () { return this->m_Data[0]; };
@ -141,7 +141,7 @@ class SM130 {
uint8_t getCommand () { return this->m_Data[1]; };
/**
* Return name of the component
* Returns the name of the component
*/
std::string name()
{