X-Git-Url: http://git.meshlink.io/?a=blobdiff_plain;f=avahi-client%2Fclient.h;h=87c275b54e4f471095bc755930b9210c38504566;hb=7b915095afe17e549132c1e28628b4cb26683f5e;hp=098d568b5c6c9034120270f9def61743ff672f37;hpb=e614891d38cae63957d0bfc00d34ecdbad4f8322;p=catta

diff --git a/avahi-client/client.h b/avahi-client/client.h
index 098d568..87c275b 100644
--- a/avahi-client/client.h
+++ b/avahi-client/client.h
@@ -38,7 +38,7 @@
 
 AVAHI_C_DECL_BEGIN
 
-/** A connection context */
+/** \struct AvahiClient A connection context */
 typedef struct AvahiClient AvahiClient;
 
 /** States of a client object, a superset of AvahiServerState */
@@ -56,12 +56,22 @@ typedef enum {
 } AvahiClientFlags;
 
 /** The function prototype for the callback of an AvahiClient */
-typedef void (*AvahiClientCallback) (AvahiClient *s, AvahiClientState state, void* userdata);
+typedef void (*AvahiClientCallback) (
+    AvahiClient *s,
+    AvahiClientState state /**< The new state of the client */,
+    void* userdata /**< The user data that was passed to avahi_client_new() */);
 
 /** Creates a new client instance */
-AvahiClient* avahi_client_new (const AvahiPoll *poll_api, AvahiClientFlags flags, AvahiClientCallback callback, void *userdata, int *error);
-
-/** Free a client instance */
+AvahiClient* avahi_client_new (
+    const AvahiPoll *poll_api /**< The abstract event loop API to use */,
+    AvahiClientFlags flags /**< Some flags to modify the behaviour of  the client library */,
+    AvahiClientCallback callback /**< A callback that is called whenever the state of the client changes. This may be NULL */,
+    void *userdata /**< Some arbitrary user data pointer that will be passed to the callback function */,
+    int *error /**< If creation of the client fails, this integer will contain the error cause. May be NULL if you aren't interested in the reason why avahi_client_new() failed. */);
+
+/** Free a client instance. This will automatically free all
+ * associated browser, resolve and entry group objects. All pointers
+ * to such objects become invalid! */
 void avahi_client_free(AvahiClient *client);
 
 /** Get the version of the server */
@@ -85,7 +95,7 @@ int avahi_client_errno (AvahiClient*);
 /** Return the local service cookie. returns AVAHI_SERVICE_COOKIE_INVALID on failure. */
 uint32_t avahi_client_get_local_service_cookie(AvahiClient *client);
 
-/** Return 1 if gethostbyname() supports mDNS lookups, 0 otherwise */
+/** Return 1 if gethostbyname() supports mDNS lookups, 0 otherwise. \since 0.6.5 */
 int avahi_nss_support(void);
 
 AVAHI_C_DECL_END