From: Lennart Poettering Date: Fri, 17 Feb 2006 00:29:23 +0000 (+0000) Subject: make anonymous structs appear properly in doxygen X-Git-Url: https://git.meshlink.io/?a=commitdiff_plain;h=b73aab83cbdaaac40c4bb80b82049dc4452b5f1c;p=catta make anonymous structs appear properly in doxygen git-svn-id: file:///home/lennart/svn/public/avahi/trunk@1144 941a03a8-eaeb-0310-b9a0-b1bbd8fe43fe --- diff --git a/avahi-client/client.h b/avahi-client/client.h index 16fde91..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 */ diff --git a/avahi-client/lookup.h b/avahi-client/lookup.h index 89d1fb2..0087bdc 100644 --- a/avahi-client/lookup.h +++ b/avahi-client/lookup.h @@ -40,25 +40,25 @@ AVAHI_C_DECL_BEGIN -/** A domain browser object */ +/** \struct AvahiDomainBrowser A domain browser object */ typedef struct AvahiDomainBrowser AvahiDomainBrowser; -/** A service browser object */ +/** \struct AvahiServiceBrowser A service browser object */ typedef struct AvahiServiceBrowser AvahiServiceBrowser; -/** A service type browser object */ +/** \struct AvahiServiceTypeBrowser A service type browser object */ typedef struct AvahiServiceTypeBrowser AvahiServiceTypeBrowser; -/** A service resolver object */ +/** \struct AvahiServiceResolver A service resolver object */ typedef struct AvahiServiceResolver AvahiServiceResolver; -/** A service resolver object */ +/** \struct AvahiHostNameResolver A service resolver object */ typedef struct AvahiHostNameResolver AvahiHostNameResolver; -/** An address resolver object */ +/** \struct AvahiAddressResolver An address resolver object */ typedef struct AvahiAddressResolver AvahiAddressResolver; -/** A record browser object */ +/** \struct AvahiRecordBrowser A record browser object */ typedef struct AvahiRecordBrowser AvahiRecordBrowser; /** The function prototype for the callback of an AvahiDomainBrowser */ diff --git a/avahi-client/publish.h b/avahi-client/publish.h index 053ea88..9deccf1 100644 --- a/avahi-client/publish.h +++ b/avahi-client/publish.h @@ -41,7 +41,7 @@ AVAHI_C_DECL_BEGIN -/** An entry group object */ +/** \struct AvahiEntryGroup An entry group object */ typedef struct AvahiEntryGroup AvahiEntryGroup; /** The function prototype for the callback of an AvahiEntryGroup */ diff --git a/avahi-common/simple-watch.h b/avahi-common/simple-watch.h index 7c83db3..c3d799d 100644 --- a/avahi-common/simple-watch.h +++ b/avahi-common/simple-watch.h @@ -30,7 +30,7 @@ AVAHI_C_DECL_BEGIN -/** A main loop object. Main loops of this type aren't very flexible +/** \struct AvahiSimplePoll A main loop object. Main loops of this type aren't very flexible * since they only support a single wakeup type. Nevertheless it * should suffice for small test and example applications. */ typedef struct AvahiSimplePoll AvahiSimplePoll; diff --git a/avahi-common/thread-watch.h b/avahi-common/thread-watch.h index 469ffe5..1d674ad 100644 --- a/avahi-common/thread-watch.h +++ b/avahi-common/thread-watch.h @@ -30,7 +30,7 @@ AVAHI_C_DECL_BEGIN -/** A main loop object that runs an AvahiSimplePoll in its own thread. \since 0.6.4 */ +/** \struct AvahiThreadedPoll A main loop object that runs an AvahiSimplePoll in its own thread. \since 0.6.4 */ typedef struct AvahiThreadedPoll AvahiThreadedPoll; /** Create a new event loop object. This will allocate the internal diff --git a/avahi-common/watch.h b/avahi-common/watch.h index 6d1a36e..c779a58 100644 --- a/avahi-common/watch.h +++ b/avahi-common/watch.h @@ -31,10 +31,10 @@ AVAHI_C_DECL_BEGIN -/** An I/O watch object */ +/** \struct AvahiWatch An I/O watch object */ typedef struct AvahiWatch AvahiWatch; -/** A timeout watch object */ +/** \struct AvahiTimeout A timeout watch object */ typedef struct AvahiTimeout AvahiTimeout; /** An event polling abstraction object */ diff --git a/avahi-core/core.h b/avahi-core/core.h index fc89eb3..62eeef6 100644 --- a/avahi-core/core.h +++ b/avahi-core/core.h @@ -24,7 +24,7 @@ /** \file core.h The Avahi Multicast DNS and DNS Service Discovery implementation. */ -/** An mDNS responder object */ +/** \struct AvahiServer An mDNS responder object */ typedef struct AvahiServer AvahiServer; #include diff --git a/avahi-core/lookup.h b/avahi-core/lookup.h index 0ce6fe8..8395b07 100644 --- a/avahi-core/lookup.h +++ b/avahi-core/lookup.h @@ -27,25 +27,25 @@ /** \example core-browse-services.c Example how to browse for DNS-SD * services using an embedded mDNS stack. */ -/** A browsing object for arbitrary RRs */ +/** \struct AvahiSRecordBrowser A browsing object for arbitrary RRs */ typedef struct AvahiSRecordBrowser AvahiSRecordBrowser; -/** A host name to IP adddress resolver object */ +/** \struct AvahiSHostNameResolve rA host name to IP adddress resolver object */ typedef struct AvahiSHostNameResolver AvahiSHostNameResolver; -/** An IP address to host name resolver object ("reverse lookup") */ +/** \struct AvahiSAddressResolver An IP address to host name resolver object ("reverse lookup") */ typedef struct AvahiSAddressResolver AvahiSAddressResolver; -/** A local domain browsing object. May be used to enumerate domains used on the local LAN */ +/** \struct AvahiSDomainBrowser A local domain browsing object. May be used to enumerate domains used on the local LAN */ typedef struct AvahiSDomainBrowser AvahiSDomainBrowser; -/** A DNS-SD service type browsing object. May be used to enumerate the service types of all available services on the local LAN */ +/** \struct AvahiSServiceTypeBrowser A DNS-SD service type browsing object. May be used to enumerate the service types of all available services on the local LAN */ typedef struct AvahiSServiceTypeBrowser AvahiSServiceTypeBrowser; -/** A DNS-SD service browser. Use this to enumerate available services of a certain kind on the local LAN. Use AvahiSServiceResolver to get specific service data like address and port for a service. */ +/** \struct AvahiSServiceBrowser A DNS-SD service browser. Use this to enumerate available services of a certain kind on the local LAN. Use AvahiSServiceResolver to get specific service data like address and port for a service. */ typedef struct AvahiSServiceBrowser AvahiSServiceBrowser; -/** A DNS-SD service resolver. Use this to retrieve addres, port and TXT data for a DNS-SD service */ +/** \struct AvahiSServiceResolver A DNS-SD service resolver. Use this to retrieve addres, port and TXT data for a DNS-SD service */ typedef struct AvahiSServiceResolver AvahiSServiceResolver; #include diff --git a/avahi-core/publish.h b/avahi-core/publish.h index 77c49af..9edd4cb 100644 --- a/avahi-core/publish.h +++ b/avahi-core/publish.h @@ -28,7 +28,7 @@ * service using an embedded mDNS stack. It behaves like a network * printer registering both an IPP and a BSD LPR service. */ -/** A group of locally registered DNS RRs */ +/** \struct AvahiSEntryGroup A group of locally registered DNS RRs */ typedef struct AvahiSEntryGroup AvahiSEntryGroup; #include diff --git a/avahi-glib/glib-watch.h b/avahi-glib/glib-watch.h index 895a686..f66be70 100644 --- a/avahi-glib/glib-watch.h +++ b/avahi-glib/glib-watch.h @@ -31,7 +31,8 @@ AVAHI_C_DECL_BEGIN -/** GLib main loop adapter. You can safely cast this into a GSource */ +/** \struct AvahiGLibPoll + * GLib main loop adapter. You can safely cast this into a GSource */ typedef struct AvahiGLibPoll AvahiGLibPoll; /** Create a new GLib main loop adapter attached to the specified diff --git a/doxygen.cfg b/doxygen.cfg index eee8b1d..39af374 100644 --- a/doxygen.cfg +++ b/doxygen.cfg @@ -112,7 +112,7 @@ GENERATE_CHI = $(GENERATE_CHI) BINARY_TOC = NO TOC_EXPAND = NO DISABLE_INDEX = NO -ENUM_VALUES_PER_LINE = 4 +ENUM_VALUES_PER_LINE = 1 GENERATE_TREEVIEW = YES TREEVIEW_WIDTH = 250 #---------------------------------------------------------------------------