Browse Source

documentation update

eihrul 19 years ago
parent
commit
102f1e22cf
1 changed files with 7 additions and 0 deletions
  1. 7 0
      include/enet/enet.h

+ 7 - 0
include/enet/enet.h

@@ -334,6 +334,13 @@ typedef struct _ENetEvent
 */
 ENET_API int enet_initialize (void);
 
+/**
+  Initializes ENet and sets the callbacks provided in the ENetCallbacks structure.
+  Callbacks that are set to NULL will simply use the default ENet functions.
+  ENET_VERSION should be passed in as the first argument so that ENet may verify the
+  callbacks available. 
+  @returns 0 on success, < 0 on failure
+*/
 ENET_API int enet_initialize_with_callbacks (ENetVersion version, const ENetCallbacks * inits);
 
 /**