From: Lennart Poettering <lennart@poettering.net>
Date: Sun, 25 Sep 2005 20:24:45 +0000 (+0000)
Subject: documentation updates
X-Git-Url: https://git.meshlink.io/?a=commitdiff_plain;h=159f71aced253cde858c047976308431dd1514ba;p=catta

documentation updates


git-svn-id: file:///home/lennart/svn/public/avahi/trunk@615 941a03a8-eaeb-0310-b9a0-b1bbd8fe43fe
---

diff --git a/avahi-common/address.h b/avahi-common/address.h
index 5523a72..8f7f2ea 100644
--- a/avahi-common/address.h
+++ b/avahi-common/address.h
@@ -29,7 +29,9 @@
 
 #include <avahi-common/cdecl.h>
 
+#ifndef DOXYGEN_SHOULD_SKIP_THIS
 AVAHI_C_DECL_BEGIN
+#endif
 
 /** Protocol family specification, takes the values AVAHI_PROTO_INET, AVAHI_PROTO_INET6, AVAHI_PROTO_UNSPEC */
 typedef int AvahiProtocol;
@@ -119,6 +121,8 @@ AvahiProtocol avahi_af_to_proto(int af);
 /** Return a textual representation of the specified protocol number. i.e. "IPv4", "IPv6" or "UNSPEC" */
 const char* avahi_proto_to_string(AvahiProtocol proto);
 
+#ifndef DOXYGEN_SHOULD_SKIP_THIS
 AVAHI_C_DECL_END
+#endif
 
 #endif
diff --git a/avahi-common/domain.h b/avahi-common/domain.h
index 0464915..0f16e54 100644
--- a/avahi-common/domain.h
+++ b/avahi-common/domain.h
@@ -24,7 +24,6 @@
 
 /** \file domain.h Domain name handling functions */
 
-
 #include <inttypes.h>
 #include <sys/types.h>
 
diff --git a/avahi-common/llist.h b/avahi-common/llist.h
index 4f48b55..05a9d52 100644
--- a/avahi-common/llist.h
+++ b/avahi-common/llist.h
@@ -22,28 +22,32 @@
   USA.
 ***/
 
-/* Some macros for maintaining doubly linked lists */
+/** \file llist.h A simple macro based linked list implementation */
 
 #include <assert.h>
 
-/* The head of the linked list. Use this in the structure that shall
+#ifndef DOXYGEN_SHOULD_SKIP_THIS
+AVAHI_C_DECL_BEGIN
+#endif
+
+/** The head of the linked list. Use this in the structure that shall
  * contain the head of the linked list */
 #define AVAHI_LLIST_HEAD(t,name) t *name
 
-/* The pointers in the linked list's items. Use this in the item structure */
+/** The pointers in the linked list's items. Use this in the item structure */
 #define AVAHI_LLIST_FIELDS(t,name) t *name##_next, *name##_prev
 
-/* Initialize the list's head */
+/** Initialize the list's head */
 #define AVAHI_LLIST_HEAD_INIT(t,head) do { (head) = NULL; } while(0)
 
-/* Initialize a list item */
+/** Initialize a list item */
 #define AVAHI_LLIST_INIT(t,name,item) do { \
                                t *_item = (item); \
                                assert(_item); \
                                _item->name##_prev = _item->name##_next = NULL; \
                                } while(0)
 
-/* Prepend an item to the list */
+/** Prepend an item to the list */
 #define AVAHI_LLIST_PREPEND(t,name,head,item) do { \
                                         t **_head = &(head), *_item = (item); \
                                         assert(_item); \
@@ -53,7 +57,7 @@
                                         *_head = _item; \
                                         } while (0)
 
-/* Remove an item from the list */
+/** Remove an item from the list */
 #define AVAHI_LLIST_REMOVE(t,name,head,item) do { \
                                     t **_head = &(head), *_item = (item); \
                                     assert(_item); \
@@ -68,4 +72,9 @@
                                     _item->name##_next = _item->name##_prev = NULL; \
                                     } while(0)
 
+#ifndef DOXYGEN_SHOULD_SKIP_THIS
+AVAHI_C_DECL_END
+#endif
+
+
 #endif
diff --git a/avahi-common/rlist.h b/avahi-common/rlist.h
index 96c03f1..57b258c 100644
--- a/avahi-common/rlist.h
+++ b/avahi-common/rlist.h
@@ -22,17 +22,34 @@
   USA.
 ***/
 
+/** \file rlist.h A simple linked list implementation */
+
 #include "llist.h"
 
+#ifndef DOXYGEN_SHOULD_SKIP_THIS
+AVAHI_C_DECL_BEGIN
+#endif
+
+/** A doubly linked list type */
 typedef struct AvahiRList AvahiRList;
 
+/** A doubly linked list type */
 struct AvahiRList {
     AVAHI_LLIST_FIELDS(AvahiRList, rlist);
     void *data;
 };
 
+/** Prepend a new item to the beginning of the list and return the new beginning */
 AvahiRList* avahi_rlist_prepend(AvahiRList *r, void *data);
+
+/** Remove the first occurence of the specified item from the list and return the new beginning */
 AvahiRList* avahi_rlist_remove(AvahiRList *r, void *data);
+
+/** Remove the specified item from the list and return the new beginning */
 AvahiRList* avahi_rlist_remove_by_link(AvahiRList *r, AvahiRList *n);
 
+#ifndef DOXYGEN_SHOULD_SKIP_THIS
+AVAHI_C_DECL_END
+#endif
+
 #endif