yuzu/enet
1
0
Fork 0
mirror of https://github.com/lsalzman/enet synced 2024-11-21 06:25:59 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions

doxygen fixes

Browse source
This commit is contained in:
eihrul 2010-06-09 21:48:46 +00:00
parent c3b24ac486
commit fc56be2eba
2 changed files with 10 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
compress.c
View file

@ -626,6 +626,10 @@ enet_range_coder_decompress (void * context, const enet_uint8 * inData, size_t i
return (size_t) (outData - outStart); return (size_t) (outData - outStart);
} }
/** @defgroup host ENet host functions
@{
*/
/** Sets the packet compressor the host should use to the default range coder. /** Sets the packet compressor the host should use to the default range coder.
@param host host to enable the range coder for @param host host to enable the range coder for
@returns 0 on success, < 0 on failure @returns 0 on success, < 0 on failure
@ -645,5 +649,6 @@ enet_host_compress_with_range_coder (ENetHost * host)
return 0; return 0;
} }
/** @} */

10
include/enet/enet.h
View file

@ -290,17 +290,17 @@ typedef struct _ENetPeer
*/ */
typedef struct _ENetCompressor typedef struct _ENetCompressor
{ {
/**< Context data for the compressor. Must be non-NULL. */ /** Context data for the compressor. Must be non-NULL. */
void * context; 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); 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); 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); void (ENET_CALLBACK * destroy) (void * context);
} ENetCompressor; } 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); typedef enet_uint32 (ENET_CALLBACK * ENetChecksumCallback) (const ENetBuffer * buffers, size_t bufferCount);
/** An ENet host for communicating with peers. /** An ENet host for communicating with peers.