diff options
author | Lennart Poettering <lennart@poettering.net> | 2007-05-09 19:45:54 +0000 |
---|---|---|
committer | Lennart Poettering <lennart@poettering.net> | 2007-05-09 19:45:54 +0000 |
commit | 8c4483baa593205c3eaecebe0738d1455025777c (patch) | |
tree | 27bf97150091d6aa17c1c7fac9fe11bec34115fe /avahi-client/publish.h | |
parent | 2d33502402a44a5eed21d633e03e65a0511d5ff2 (diff) |
Doxygen documentation cleanups:
* Hide a few irrelevant header files and definitions from doxygen to make the docs shorter
* Update some texts
* Put functions into categories
git-svn-id: file:///home/lennart/svn/public/avahi/trunk@1477 941a03a8-eaeb-0310-b9a0-b1bbd8fe43fe
Diffstat (limited to 'avahi-client/publish.h')
-rw-r--r-- | avahi-client/publish.h | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/avahi-client/publish.h b/avahi-client/publish.h index 98f4f98..1e40b18 100644 --- a/avahi-client/publish.h +++ b/avahi-client/publish.h @@ -50,6 +50,8 @@ typedef void (*AvahiEntryGroupCallback) ( AvahiEntryGroupState state /**< The new state of the entry group */, void* userdata /* The arbitrary user data pointer originally passed to avahi_entry_group_new()*/); +/** @{ \name Construction and destruction */ + /** Create a new AvahiEntryGroup object */ AvahiEntryGroup* avahi_entry_group_new( AvahiClient* c, @@ -59,6 +61,10 @@ AvahiEntryGroup* avahi_entry_group_new( /** Clean up and free an AvahiEntryGroup object */ int avahi_entry_group_free (AvahiEntryGroup *); +/** @} */ + +/** @{ \name State */ + /** Commit an AvahiEntryGroup. The entries in the entry group are now registered on the network. Commiting empty entry groups is considered an error. */ int avahi_entry_group_commit (AvahiEntryGroup*); @@ -74,6 +80,10 @@ int avahi_entry_group_is_empty (AvahiEntryGroup*); /** Get an AvahiEntryGroup's owning client instance */ AvahiClient* avahi_entry_group_get_client (AvahiEntryGroup*); +/** @} */ + +/** @{ \name Adding and updating entries */ + /** Add a service. Takes a variable NULL terminated list of TXT record strings as last arguments. Please note that this service is not announced on the network before avahi_entry_group_commit() is called. */ int avahi_entry_group_add_service( AvahiEntryGroup *group, @@ -133,6 +143,7 @@ int avahi_entry_group_update_service_txt_strlst( const char *domain, AvahiStringList *strlst); +/** \cond fulldocs */ /** Add a host/address pair */ int avahi_entry_group_add_address( AvahiEntryGroup *group, @@ -141,6 +152,7 @@ int avahi_entry_group_add_address( AvahiPublishFlags flags, const char *name /**< The FDQN of the new hostname to register */, const AvahiAddress *a /**< The address this host name shall map to */); +/** \endcond */ /** Add an arbitrary record. I hope you know what you do. */ int avahi_entry_group_add_record( @@ -155,6 +167,8 @@ int avahi_entry_group_add_record( const void *rdata, size_t size); +/** @} */ + AVAHI_C_DECL_END #endif |