From 196c7a44b2c17a16671ecbc37dd98a5e238d0dbf Mon Sep 17 00:00:00 2001
From: Lee Salzman <lsalzman@gmail.com>
Date: Sat, 22 May 2010 19:41:19 +0000
Subject: [PATCH] doc cleanups

git-svn-id: svn://svn.code.sf.net/p/actiongame/code/trunk/ac@4998 e016b1c5-ed68-44aa-a2f7-31cac88cffde
---
 source/enet/compress.c          | 6 +++---
 source/enet/include/enet/enet.h | 5 +++--
 2 files changed, 6 insertions(+), 5 deletions(-)

diff --git a/source/enet/compress.c b/source/enet/compress.c
index f21dddd2..07f159e0 100644
--- a/source/enet/compress.c
+++ b/source/enet/compress.c
@@ -298,7 +298,7 @@ enet_range_coder_compress (void * context, const ENetBuffer * inBuffers, size_t
       return 0; \
     else \
     { \
-        ENetSymbol * symbol = (predictor).symbols, * child; \
+        ENetSymbol * symbol = (predictor).symbols; \
         for (;;) \
         { \
             if (code >= under_ + symbol -> total) \
@@ -451,8 +451,8 @@ enet_range_coder_decompress (void * context, const enet_uint8 * inData, size_t i
     return (size_t) (outData - outStart);
 }
 
-/** Sets the packet compressor the host should use to the default range compressor.
-    @param host host to enable or disable compression for
+/** 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
 */
 int
diff --git a/source/enet/include/enet/enet.h b/source/enet/include/enet/enet.h
index 3c3ef948..9f40793a 100755
--- a/source/enet/include/enet/enet.h
+++ b/source/enet/include/enet/enet.h
@@ -305,7 +305,7 @@ typedef enet_uint32 (ENET_CALLBACK * ENetChecksumCallback) (const ENetBuffer * b
  
 /** An ENet host for communicating with peers.
   *
-  * No fields should be modified.
+  * No fields should be modified unless otherwise stated.
 
     @sa enet_host_create()
     @sa enet_host_destroy()
@@ -314,6 +314,7 @@ typedef enet_uint32 (ENET_CALLBACK * ENetChecksumCallback) (const ENetBuffer * b
     @sa enet_host_flush()
     @sa enet_host_broadcast()
     @sa enet_host_compress()
+    @sa enet_host_compress_with_range_coder()
     @sa enet_host_channel_limit()
     @sa enet_host_bandwidth_limit()
     @sa enet_host_bandwidth_throttle()
@@ -340,7 +341,7 @@ typedef struct _ENetHost
    size_t               commandCount;
    ENetBuffer           buffers [ENET_BUFFER_MAXIMUM];
    size_t               bufferCount;
-   ENetChecksumCallback checksum;
+   ENetChecksumCallback checksum;                    /**< callback the user can set to enable packet checksums for this host */
    ENetCompressor       compressor;
    enet_uint8           packetData [2][ENET_PROTOCOL_MAXIMUM_MTU];
    ENetAddress          receivedAddress;