Changeset 0d84d5

Timestamp:

03/17/12 19:18:56 (14 months ago)

Author:

Erik Johansson <erik@…>

Branches:

('master', '033cf796174446f5fff5bbfad1cbf1e4af35c0d8')('controller-upgrade', '72b31cc86eeeef18f1371a3067b6e8a5ca21abfc')('windows_service_fixes', 'df6bd2788365991d36d5af2a75833b8de2a5860f')

Children:

5061c759f3ac7966696921c86e2020a6fcb37b0d

Parents:

ee4d821a7a727db5eda4b254618714e407afcd3d

git-author:

Erik Johansson <erik@ejohansson.se>2012-03-17 19:12:30+01:00

git-committer:

Erik Johansson <erik@ejohansson.se>2012-03-17 19:18:56+01:00

Message:

Document TDControllerEvent

File:

• telldus-core/client/telldus-core.cpp (modified) (1 diff)

telldus-core/client/telldus-core.cpp

@@ -267 +267 @@
  * @typedef TDControllerEvent
  * The callback type for controller events.
+ *
+ * @attention The callback will be called by another thread than the thread
+ * used by the application and some measures must be taken to synchronize it
+ * with the main thread.
+ *
+ * @param controllerId The id of the controller that was added, changed or
+ * removed.
+ * @param changeEvent One of the constants @ref TELLSTICK_DEVICE_ADDED, @ref
+ * TELLSTICK_DEVICE_STATE_CHANGED or @ref TELLSTICK_DEVICE_REMOVED.
+ * @param changeType If @a changeEvent is @ref TELLSTICK_DEVICE_ADDED this is
+ * the controller's type (e.g. @ref TELLSTICK_CONTROLLER_TELLSTICK or @ref
+ * TELLSTICK_CONTROLLER_TELLSTICK_DUO); if @a changeEvent is @ref
+ * TELLSTICK_DEVICE_CHANGED this indicates what has changed (e.g. @ref
+ * TELLSTICK_CHANGE_AVAILABLE, @ref TELLSTICK_CHANGE_NAME or @ref
+ * TELLSTICK_CHANGE_FIRMWARE).
+ * @param newValue If @a changeEvent is @ref TELLSTICK_DEVICE_CHANGED this is
+ * the property's new value. For @ref TELLSTICK_CHANGE_AVAILABLE this is either
+ * 0 or 1.
+ * @param callbackId The id of the callback.
+ * @param context The pointer passed when registering for the event.
+ *
  * @sa tdRegisterControllerEvent
  *