Permalink
Browse files

updated documentation

  • Loading branch information...
1 parent cc83548 commit 25086f7ad8f55fa2574bc2514b66743f08557c5f @sappo sappo committed Jan 28, 2014
Showing with 16 additions and 16 deletions.
  1. +8 −8 include/zframe.h
  2. +8 −8 src/zframe.c
View
@@ -152,23 +152,23 @@ CZMQ_EXPORT int
CZMQ_EXPORT char *
zframe_get_string (zframe_t *self);
-// Get a 1-byte integer from the frame payload. If there was insufficient
-// data in the frame, returns zero.
+// Get a 1-byte integer from the frame payload by copying it to the 'data'
+// location. If there was insufficient data in the frame, returns -1.
CZMQ_EXPORT int
zframe_get_uint8 (zframe_t *self, uint8_t *data);
-// Get a 2-byte integer from the frame payload. If there was insufficient
-// data in the frame, returns zero.
+// Get a 2-byte integer from the frame payload by copying it to the 'data'
+// location. If there was insufficient data in the frame, returns -1.
CZMQ_EXPORT int
zframe_get_uint16 (zframe_t *self, uint16_t *data);
-// Get a 4-byte integer from the frame payload. If there was insufficient
-// data in the frame, returns zero.
+// Get a 4-byte integer from the frame payload by copying it to the 'data'
+// location. If there was insufficient data in the frame, returns -1.
CZMQ_EXPORT int
zframe_get_uint32 (zframe_t *self, uint32_t *data);
-// Get a 8-byte integer from the frame payload. If there was insufficient
-// data in the frame, returns zero.
+// Get a 8-byte integer from the frame payload by copying it to the 'data'
+// location. If there was insufficient data in the frame, returns -1.
CZMQ_EXPORT int
zframe_get_uint64 (zframe_t *self, uint64_t *data);
View
@@ -518,8 +518,8 @@ zframe_get_block (zframe_t *self, byte *data, size_t size)
}
// --------------------------------------------------------------------------
-// Get a 1-byte integer from the frame payload. If there was insufficient
-// data in the frame, returns zero.
+// Get a 1-byte integer from the frame payload by copying it to the 'data'
+// location. If there was insufficient data in the frame, returns -1.
int
zframe_get_uint8 (zframe_t *self, uint8_t *data)
@@ -536,8 +536,8 @@ zframe_get_uint8 (zframe_t *self, uint8_t *data)
// --------------------------------------------------------------------------
-// Get a 2-byte integer from the frame payload. If there was insufficient
-// data in the frame, returns zero.
+// Get a 2-byte integer from the frame payload by copying it to the 'data'
+// location. If there was insufficient data in the frame, returns -1.
int
zframe_get_uint16 (zframe_t *self, uint16_t *data)
@@ -555,8 +555,8 @@ zframe_get_uint16 (zframe_t *self, uint16_t *data)
// --------------------------------------------------------------------------
-// Get a 4-byte integer from the frame payload. If there was insufficient
-// data in the frame, returns zero.
+// Get a 4-byte integer from the frame payload by copying it to the 'data'
+// location. If there was insufficient data in the frame, returns -1.
int
zframe_get_uint32 (zframe_t *self, uint32_t *data)
@@ -576,8 +576,8 @@ zframe_get_uint32 (zframe_t *self, uint32_t *data)
// --------------------------------------------------------------------------
-// Get a 8-byte integer from the frame payload. If there was insufficient
-// data in the frame, returns zero.
+// Get a 8-byte integer from the frame payload by copying it to the 'data'
+// location. If there was insufficient data in the frame, returns -1.
int
zframe_get_uint64 (zframe_t *self, uint64_t *data)

0 comments on commit 25086f7

Please sign in to comment.