diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/FAQ.dox | 4 | ||||
| -rw-r--r-- | docs/design.dox | 2 | ||||
| -rw-r--r-- | docs/tutorial.dox | 4 |
3 files changed, 5 insertions, 5 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 |