Doxygen documentation cleanups:

[catta] / avahi-client / client.h

diff --git a/avahi-client/client.h b/avahi-client/client.h
index 16fde9109b494482c79496a95e8539ffcfc0a90d..2f86d020678c3b361dfa9df9c257d0e57889b0a4 100644 (file)
--- a/avahi-client/client.h
+++ b/avahi-client/client.h
@@ -33,9 +33,6 @@
 
 /** \file client.h Definitions and functions for the client API over D-Bus */
 
-/** \example glib-integration.c Example of how to integrate
- * avahi use with GLIB/GTK applications */
-
 AVAHI_C_DECL_BEGIN
 
 /** A connection context */
@@ -61,11 +58,13 @@ typedef void (*AvahiClientCallback) (
     AvahiClientState state /**< The new state of the client */,
     void* userdata /**< The user data that was passed to avahi_client_new() */);
 
+/** @{ \name Construction and destruction */
+
 /** Creates a new 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 */,
+    AvahiClientCallback callback /**< A callback that is called whenever the state of the client changes. This may be NULL. Please note that this function is called for the first time from within the avahi_client_new() context! Thus, in the callback you should not make use of global variables that are initialized only after your call to avahi_client_new(). A common mistake is to store the AvahiClient pointer returned by avahi_client_new() in a global variable and assume that this global variable already contains the valid pointer when the callback is called for the first time. A work-around for this is to always use the AvahiClient pointer passed to the callback function instead of the global pointer.  */,
     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. */);
 
@@ -74,12 +73,19 @@ AvahiClient* avahi_client_new (
  * to such objects become invalid! */
 void avahi_client_free(AvahiClient *client);
 
+/** @} */
+
+/** @{ \name Properties */
+
 /** Get the version of the server */
 const char* avahi_client_get_version_string (AvahiClient*);
 
 /** Get host name */
 const char* avahi_client_get_host_name (AvahiClient*);
 
+/** Set host name. \since 0.6.13 */
+int avahi_client_set_host_name(AvahiClient*, const char *name);
+
 /** Get domain name */
 const char* avahi_client_get_domain_name (AvahiClient*);
 
@@ -89,15 +95,25 @@ const char* avahi_client_get_host_name_fqdn (AvahiClient*);
 /** Get state */
 AvahiClientState avahi_client_get_state(AvahiClient *client); 
 
-/** Get the last error number */
+/** @{ \name Error Handling */
+
+/** Get the last error number. See avahi_strerror() for converting this error code into a human readable string. */
 int avahi_client_errno (AvahiClient*);
 
+/** @} */
+
+/** \cond fulldocs */
 /** Return the local service cookie. returns AVAHI_SERVICE_COOKIE_INVALID on failure. */
 uint32_t avahi_client_get_local_service_cookie(AvahiClient *client);
+/** \endcond */
+
+/** @{ \name Libc NSS Support */
 
 /** Return 1 if gethostbyname() supports mDNS lookups, 0 otherwise. \since 0.6.5 */
 int avahi_nss_support(void);
 
+/** @} */
+
 AVAHI_C_DECL_END
 
 #endif