epics/pvData
0
0
Fork 0
Code Issues Pull Requests Projects Wiki Activity

Doxgen fixes and enhancements

Browse Source 
Change &param to @param. Add missing parameter.
Add more doxygen comments in SerializeHelper.
This commit is contained in:
Dave Hickin
2015-10-15 07:12:42 +01:00
parent f5df29cf34
commit 9d877d764f
2 changed files with 10 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
src/misc/serialize.h
View File

@@ -165,7 +165,7 @@ namespace epics { namespace pvData {
* Serialize field into given buffer.
* @param buffer serialization buffer.
* @param flusher flush interface.
* &param 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.
* &param bitSet The bitSet to deserialize.
* @param bitSet The bitSet to deserialize.
*/
virtual void deserialize(ByteBuffer *buffer,
DeserializableControl *flusher,BitSet *bitSet) = 0;

10
src/misc/serializeHelper.h
View File

@@ -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,