diff options
| -rw-r--r-- | docs/FAQ.dox | 4 | ||||
| -rw-r--r-- | docs/design.dox | 2 | ||||
| -rw-r--r-- | docs/tutorial.dox | 4 | ||||
| -rw-r--r-- | include/enet/enet.h | 4 | ||||
| -rw-r--r-- | peer.c | 4 |
5 files changed, 9 insertions, 9 deletions
diff --git a/docs/FAQ.dox b/docs/FAQ.dox index 484b818..c3f45fb 100644 --- a/docs/FAQ.dox +++ b/docs/FAQ.dox @@ -1,12 +1,12 @@ /** @page FAQ Frequently Answered Questions -@section Q1 Is ENet thread safe? +@section Q1 Is ENet thread-safe? ENet does not use any significant global variables, the vast majority of state is encapsulated in the ENetHost structure. As such, as long as the application guards access to this structure, then ENet should -operate fine in a multithreaded environment. +operate fine in a multi-threaded environment. @section Q2 Isn't ENet just re-inventing TCP?! What's the point? diff --git a/docs/design.dox b/docs/design.dox index daed221..28d9f3a 100644 --- a/docs/design.dox +++ b/docs/design.dox @@ -3,7 +3,7 @@ ENet evolved specifically as a UDP networking layer for the multiplayer first person shooter Cube. Cube necessitated low latency -communcation with data sent out very frequently, so TCP was an +communication with data sent out very frequently, so TCP was an unsuitable choice due to its high latency and stream orientation. UDP, however, lacks many sometimes necessary features from TCP such as reliability, sequencing, unrestricted packet sizes, and connection diff --git a/docs/tutorial.dox b/docs/tutorial.dox index dd911d3..5dbd0c2 100644 --- a/docs/tutorial.dox +++ b/docs/tutorial.dox @@ -182,7 +182,7 @@ disconnect event and must be explicitly reset. break; case ENET_EVENT_TYPE_DISCONNECT: - printf ("%s disconected.\n", event.peer -> data); + printf ("%s disconnected.\n", event.peer -> data); /* Reset the peer's client information. */ @@ -204,7 +204,7 @@ Certain flags may also be supplied to enet_packet_create() to control various packet features: ENET_PACKET_FLAG_RELIABLE specifies that the packet must use reliable -delivery. A reliable packet is guarenteed to be delivered, and a +delivery. A reliable packet is guaranteed to be delivered, and a number of retry attempts will be made until an acknowledgement is received from the foreign host the packet is sent to. If a certain number of retry attempts is reached without any acknowledgement, ENet diff --git a/include/enet/enet.h b/include/enet/enet.h index d5d5b8f..948f44e 100644 --- a/include/enet/enet.h +++ b/include/enet/enet.h @@ -446,7 +446,7 @@ ENET_API int enet_initialize (void); Initializes ENet globally and supplies user-overridden callbacks. Must be called prior to using any functions in ENet. Do not use enet_initialize() if you use this variant. Make sure the ENetCallbacks structure is zeroed out so that any additional callbacks added in future versions will be properly ignored. @param version the constant ENET_VERSION should be supplied so ENet knows which version of ENetCallbacks struct to use - @param inits user-overriden callbacks where any NULL callbacks will use ENet's defaults + @param inits user-overridden callbacks where any NULL callbacks will use ENet's defaults @returns 0 on success, < 0 on failure */ ENET_API int enet_initialize_with_callbacks (ENetVersion version, const ENetCallbacks * inits); @@ -510,7 +510,7 @@ ENET_API int enet_socketset_select (ENetSocket, ENetSocketSet *, ENetSock */ ENET_API int enet_address_set_host (ENetAddress * address, const char * hostName); -/** Gives the printable form of the ip address specified in the address parameter. +/** Gives the printable form of the IP address specified in the address parameter. @param address address printed @param hostName destination for name, must not be NULL @param nameLength maximum length of hostName. @@ -424,7 +424,7 @@ enet_peer_reset (ENetPeer * peer) /** Sends a ping request to a peer. @param peer destination for the ping request @remarks ping requests factor into the mean round trip time as designated by the - roundTripTime field in the ENetPeer structure. Enet automatically pings all connected + roundTripTime field in the ENetPeer structure. ENet automatically pings all connected peers at regular intervals, however, this function may be called to ensure more frequent ping requests. */ @@ -486,7 +486,7 @@ enet_peer_timeout (ENetPeer * peer, enet_uint32 timeoutLimit, enet_uint32 timeou @param peer peer to disconnect @param data data describing the disconnection @remarks No ENET_EVENT_DISCONNECT event will be generated. The foreign peer is not - guarenteed to receive the disconnect notification, and is reset immediately upon + guaranteed to receive the disconnect notification, and is reset immediately upon return from this function. */ void |