diff options
| -rw-r--r-- | compress.c | 5 | ||||
| -rw-r--r-- | include/enet/enet.h | 10 |
2 files changed, 10 insertions, 5 deletions
@@ -626,6 +626,10 @@ enet_range_coder_decompress (void * context, const enet_uint8 * inData, size_t i return (size_t) (outData - outStart); } +/** @defgroup host ENet host functions + @{ +*/ + /** Sets the packet compressor the host should use to the default range coder. @param host host to enable the range coder for @returns 0 on success, < 0 on failure @@ -645,5 +649,6 @@ enet_host_compress_with_range_coder (ENetHost * host) return 0; } +/** @} */ diff --git a/include/enet/enet.h b/include/enet/enet.h index 425e753..2f656d6 100644 --- a/include/enet/enet.h +++ b/include/enet/enet.h @@ -290,17 +290,17 @@ typedef struct _ENetPeer */ typedef struct _ENetCompressor { - /**< Context data for the compressor. Must be non-NULL. */ + /** Context data for the compressor. Must be non-NULL. */ void * context; - /**< Compresses from inBuffers[0..inBufferCount-1], containing inLimit bytes, to outData, outputting at most outLimit bytes. Should return 0 on failure. */ + /** Compresses from inBuffers[0:inBufferCount-1], containing inLimit bytes, to outData, outputting at most outLimit bytes. Should return 0 on failure. */ size_t (ENET_CALLBACK * compress) (void * context, const ENetBuffer * inBuffers, size_t inBufferCount, size_t inLimit, enet_uint8 * outData, size_t outLimit); - /**< Decompresses from inData, containing inLimit bytes, to outData, outputting at most outLimit bytes. Should return 0 on failure. */ + /** Decompresses from inData, containing inLimit bytes, to outData, outputting at most outLimit bytes. Should return 0 on failure. */ size_t (ENET_CALLBACK * decompress) (void * context, const enet_uint8 * inData, size_t inLimit, enet_uint8 * outData, size_t outLimit); - /**< Destroys the context when compression is disabled or the host is destroyed. May be NULL. */ + /** Destroys the context when compression is disabled or the host is destroyed. May be NULL. */ void (ENET_CALLBACK * destroy) (void * context); } ENetCompressor; -/** Callback that computes the checksum of the data held in buffers [0..bufferCount-1] */ +/** Callback that computes the checksum of the data held in buffers[0:bufferCount-1] */ typedef enet_uint32 (ENET_CALLBACK * ENetChecksumCallback) (const ENetBuffer * buffers, size_t bufferCount); /** An ENet host for communicating with peers. |