From cdf72748bd1e60e2a0713b835665b6ea6f3ab887 Mon Sep 17 00:00:00 2001 From: Bill Dieter Date: Tue, 5 Apr 2016 18:22:22 +0000 Subject: [PATCH] Added/updated Doxygen comments for OCPayload and OCPayloadType Change-Id: I6db12adfea55bfddeb77da399260ad10b2520974 Signed-off-by: Bill Dieter Reviewed-on: https://gerrit.iotivity.org/gerrit/7639 Reviewed-by: Uze Choi Tested-by: Uze Choi Tested-by: jenkins-iotivity --- resource/csdk/stack/include/octypes.h | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/resource/csdk/stack/include/octypes.h b/resource/csdk/stack/include/octypes.h index f64cc9b..2814e81 100644 --- a/resource/csdk/stack/include/octypes.h +++ b/resource/csdk/stack/include/octypes.h @@ -960,19 +960,33 @@ typedef struct /** Enum to describe the type of object held by the OCPayload object.*/ typedef enum { + /** Contents of the payload are invalid */ PAYLOAD_TYPE_INVALID, + /** The payload is an OCDiscoveryPayload */ PAYLOAD_TYPE_DISCOVERY, + /** The payload is an OCDevicePayload */ PAYLOAD_TYPE_DEVICE, + /** The payload is an OCPlatformPayload */ PAYLOAD_TYPE_PLATFORM, + /** The payload is an OCRepPayload */ PAYLOAD_TYPE_REPRESENTATION, + /** The payload is an OCSecurityPayload */ PAYLOAD_TYPE_SECURITY, + /** The payload is an OCPresencePayload */ PAYLOAD_TYPE_PRESENCE, + /** The payload is an OCRDPayload */ PAYLOAD_TYPE_RD } OCPayloadType; +/** + * A generic struct representing a payload returned from a resource operation + * + * A pointer to OCPayLoad can be cast to a more specific struct to access members + * for the its type. + */ typedef struct { - // The type of message that was received + /** The type of message that was received */ OCPayloadType type; } OCPayload; -- 2.7.4