jeena/telldus
1
0
Fork 0
Code Issues Pull requests Projects Packages Wiki Activity Actions

Group defines in documentation

Browse source
This commit is contained in:
Erik Johansson 2012-03-13 20:37:32 +01:00
parent cc6420920e
commit 7434351cf5
1 changed files with 21 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

25
telldus-core/client/telldus-core.cpp
View file

@ -15,6 +15,9 @@ using namespace TelldusCore;
/** /**
* @name Device method flags
* @{
*
* @def TELLSTICK_TURNON * @def TELLSTICK_TURNON
* Device-flag for devices supporting the tdTurnOn() call. * Device-flag for devices supporting the tdTurnOn() call.
* *
@ -44,6 +47,12 @@ using namespace TelldusCore;
* *
* @def TELLSTICK_LEARN * @def TELLSTICK_LEARN
* Device-flag for devices supporting the tdLearn() call. * Device-flag for devices supporting the tdLearn() call.
*/
/** @} */
/**
* @name Device types
* @{
* *
* @def TELLSTICK_TYPE_DEVICE * @def TELLSTICK_TYPE_DEVICE
* Device type of a single device. * Device type of a single device.
@ -52,14 +61,18 @@ using namespace TelldusCore;
* Device type of a device which contains other devices. * Device type of a device which contains other devices.
* *
* @def TELLSTICK_TYPE_SCENE * @def TELLSTICK_TYPE_SCENE
* Device type of a device which contains other devices that are sent different commands when executed (i.e. one device turns on, another turns off). * Device type of a device which contains other devices that are sent different
* commands when executed (i.e. one device turns on, another turns off).
*/
/** @} */
/**
* @name Error codes
* @{
* *
* @def TELLSTICK_SUCCESS * @def TELLSTICK_SUCCESS
* Error code. Returned when the command succeeded. * Error code. Returned when the command succeeded.
* *
* @def TELLSTICK_ERROR_BROKEN_PIPE
* Error code. Pipe broken during communication.
*
* @def TELLSTICK_ERROR_NOT_FOUND * @def TELLSTICK_ERROR_NOT_FOUND
* Error code. Returned if a TellStick was not found on the system. * Error code. Returned if a TellStick was not found on the system.
* *
@ -89,12 +102,16 @@ using namespace TelldusCore;
* Error code. Input/command could not be parsed or didn't follow * Error code. Input/command could not be parsed or didn't follow
* input rules. * input rules.
* *
* @def TELLSTICK_ERROR_BROKEN_PIPE
* Error code. Pipe broken during communication.
*
* @def TELLSTICK_ERROR_COMMUNICATING_SERVICE * @def TELLSTICK_ERROR_COMMUNICATING_SERVICE
* Error code. Timeout waiting for response from the Telldus Service. * Error code. Timeout waiting for response from the Telldus Service.
* *
* @def TELLSTICK_ERROR_UNKNOWN * @def TELLSTICK_ERROR_UNKNOWN
* Error code. An unkown error has occurred. * Error code. An unkown error has occurred.
*/ */
/** @} */
/** /**
* This function initiates the library. Call this function before any other * This function initiates the library. Call this function before any other