diff --git a/src/misc/serialize.h b/src/misc/serialize.h index db70a0d..0e30ba6 100644 --- a/src/misc/serialize.h +++ b/src/misc/serialize.h @@ -165,7 +165,7 @@ namespace epics { namespace pvData { * Serialize field into given buffer. * @param buffer serialization buffer. * @param flusher flush interface. - * ¶m bitSet The bitSet to serialize. + * @param bitSet The bitSet to serialize. */ virtual void serialize(ByteBuffer *buffer, SerializableControl *flusher,BitSet *bitSet) const = 0; @@ -173,7 +173,7 @@ namespace epics { namespace pvData { * Deserialize buffer. * @param buffer serialization buffer. * @param flusher deserialization control. - * ¶m bitSet The bitSet to deserialize. + * @param bitSet The bitSet to deserialize. */ virtual void deserialize(ByteBuffer *buffer, DeserializableControl *flusher,BitSet *bitSet) = 0; diff --git a/src/misc/serializeHelper.h b/src/misc/serializeHelper.h index d741fb0..39f0799 100644 --- a/src/misc/serializeHelper.h +++ b/src/misc/serializeHelper.h @@ -31,19 +31,25 @@ namespace epics { public: /** - * Serialize array size. + * Serialize the specified array size into the specified + * buffer, flushing when necessary. + * The specified SerializableControl manages any flushing + * required. * * @param[in] s size to encode * @param[in] buffer serialization buffer - * @param[in] flusher flusher + * @param[in] flusher SerializableControl to manage the flushing */ static void writeSize(std::size_t s, ByteBuffer* buffer, SerializableControl* flusher); /** * Deserialize array size. + * The specified DeserializableControl ensures + * sufficient bytes are available. * * @param[in] buffer deserialization buffer. + * @param[in] control the DeserializableControl. * @returns array size. */ static std::size_t readSize(ByteBuffer* buffer,