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

Small typos and fixes in the documentation

Browse source
This commit is contained in:
Micke Prag 2008-09-16 19:05:04 +00:00
parent f9d5a302a3
commit b163e8a9fa
2 changed files with 14 additions and 14 deletions
Download patch file Download diff file Expand all files Collapse all files

20
docs/telldus-core.txt
View file

@ -68,43 +68,43 @@
* *
* TellStick can control many different types of devices and they * TellStick can control many different types of devices and they
* all support different features. For example, a bell doesn't support turning * all support different features. For example, a bell doesn't support turning
* on and not all lamp switches supports dimming. * on and not all lamp switches support dimming.
* To find out what a specific device supports call devMethods(): * To find out what a specific device support call devMethods():
* \code * \code
* function checkFeatures( int id ) { * function checkFeatures( int id ) {
* int methods = devMethods( id ); * int methods = devMethods( id );
* if ( methods & TELLSTICK_TURNON ) { * if ( methods & TELLSTICK_TURNON ) {
* printf( "The device %d supports devTurnOn()\n", id ); * printf( "The device %d support devTurnOn()\n", id );
* } * }
* if ( methods & TELLSTICK_TURNOFF ) { * if ( methods & TELLSTICK_TURNOFF ) {
* printf( "The device %d supports devTurnOff()\n", id ); * printf( "The device %d support devTurnOff()\n", id );
* } * }
* if ( methods & TELLSTICK_BELL ) { * if ( methods & TELLSTICK_BELL ) {
* printf( "The device %d supports devBell()\n", id ); * printf( "The device %d support devBell()\n", id );
* } * }
* } * }
* \endcode * \endcode
* *
* When you know which fetures a device supports it is safe to call the * When you know which fetures a device support it is safe to call the
* controlling functions described in \ref sec_bu_controlling_functions. * controlling functions described in \ref sec_bu_controlling_functions.
* *
* \subsubsection sec_bu_controlling_functions Controlling functions * \subsubsection sec_bu_controlling_functions Controlling functions
* *
* TellStick has a couple of functions for controlling the devices. Each of * TellStick has a couple of functions for controlling the devices. Each of
* them should only be called if the device supports the feature. * them should only be called if the device support the feature.
* *
* These functions all returns zero if the call was successfull and non-zero * These functions all returns zero if the call was successfull and non-zero
* otherwise. * otherwise.
* *
* \paragraph devTurnOn devTurnOn() * \paragraph devTurnOn devTurnOn()
* Devices supporting \c TELLSTICK_TURNON. Most of the normal switches (for lamp * Devices supporting \c TELLSTICK_TURNON. Most of the normal switches (for lamp
* etc.) supports this. * etc.) support this.
* \paragraph devTurnOff devTurnOff() * \paragraph devTurnOff devTurnOff()
* Devices supporting \c TELLSTICK_TURNOFF. Almost all of the devices supporting * Devices supporting \c TELLSTICK_TURNOFF. Almost all of the devices supporting
* \c TELLSTICK_TURNON also supports this. * \c TELLSTICK_TURNON also support this.
* \paragraph devDim devDim() * \paragraph devDim devDim()
* Devices supporting \c TELLSTICK_DIM. This is a quite unusual feature for * Devices supporting \c TELLSTICK_DIM. This is a quite unusual feature for
* dimmers. Many dimmers on the market that is dimmable has no way for sending * dimmers. Many dimmers on the market that are dimmable have no way for sending
* a specific level which means it doesn't support this feature. * a specific level which means it doesn't support this feature.
* \paragraph devBell devBell() * \paragraph devBell devBell()
* Devices supporting \c TELLSTICK_BELL. This is mostly wireless doorbells. * Devices supporting \c TELLSTICK_BELL. This is mostly wireless doorbells.

8
telldus-core/driver/TellUsbD101/TellUsbD101.cpp
View file

@ -31,23 +31,23 @@ using namespace std;
* Device-flag for devices supporting the devBell() call. * Device-flag for devices supporting the devBell() call.
* *
* @def TELLSTICK_TOGGLE * @def TELLSTICK_TOGGLE
* This method is currently unimplemented * This method is currently unimplemented.
* *
* @def TELLSTICK_DIM * @def TELLSTICK_DIM
* Device-flag for devices supporting the devDim() call. * Device-flag for devices supporting the devDim() call.
* *
* @def TELLSTICK_SUCCESS * @def TELLSTICK_SUCCESS
* Error code. Returned when the command succeeded * Error code. Returned when the command succeeded.
* *
* @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.
* *
* @def TELLSTICK_ERROR_PERMISSION_DENIED * @def TELLSTICK_ERROR_PERMISSION_DENIED
* Error code. Returned if the user doesn't have privileges to open * Error code. Returned if the user doesn't have privileges to open
* the TellStick device * the TellStick device.
* *
* @def TELLSTICK_ERROR_DEVICE_NOT_FOUND * @def TELLSTICK_ERROR_DEVICE_NOT_FOUND
* Error code. The supplied device id was not found * Error code. The supplied device id was not found.
* *
* @def TELLSTICK_ERROR_METHOD_NOT_SUPPORTED * @def TELLSTICK_ERROR_METHOD_NOT_SUPPORTED
* Error code. The requested method is not supported device. * Error code. The requested method is not supported device.