summaryrefslogtreecommitdiffstats
path: root/avahi-common
diff options
context:
space:
mode:
authorLennart Poettering <lennart@poettering.net>2005-06-28 23:25:50 +0000
committerLennart Poettering <lennart@poettering.net>2005-06-28 23:25:50 +0000
commit54d7450ef8b085110c380d4263794deffa5edda4 (patch)
tree2f9727716e1c1742f790931c3314036b00ecbf86 /avahi-common
parent14f8d9beb7ef14b0aab5512345e09109bdd8cb0c (diff)
improve documentation
git-svn-id: file:///home/lennart/svn/public/avahi/trunk@152 941a03a8-eaeb-0310-b9a0-b1bbd8fe43fe
Diffstat (limited to 'avahi-common')
-rw-r--r--avahi-common/address.h2
-rw-r--r--avahi-common/alternative.h2
-rw-r--r--avahi-common/cdecl.h2
-rw-r--r--avahi-common/rr.h2
-rw-r--r--avahi-common/strlst.h2
5 files changed, 10 insertions, 0 deletions
diff --git a/avahi-common/address.h b/avahi-common/address.h
index b22b720..3b34551 100644
--- a/avahi-common/address.h
+++ b/avahi-common/address.h
@@ -26,6 +26,8 @@
#include <glib.h>
#include <avahi-common/cdecl.h>
+/** \file address.h Defintions and functions to manipulate IP addresses. */
+
AVAHI_C_DECL_BEGIN
/** Protocol family specification, takes the values AVAHI_INET, AVAHI_INET6, AVAHI_UNSPEC */
diff --git a/avahi-common/alternative.h b/avahi-common/alternative.h
index 13620ff..7a2a455 100644
--- a/avahi-common/alternative.h
+++ b/avahi-common/alternative.h
@@ -26,6 +26,8 @@
#include <avahi-common/cdecl.h>
+/** \file alternative.h Functions to find alternative names for hosts and services in the case of name collision */
+
AVAHI_C_DECL_BEGIN
/** Find an alternative for the specified host name. If called with an
diff --git a/avahi-common/cdecl.h b/avahi-common/cdecl.h
index 82c687d..a40126d 100644
--- a/avahi-common/cdecl.h
+++ b/avahi-common/cdecl.h
@@ -23,6 +23,8 @@
***/
+/** \file cdecl.h C++ compatibility */
+
#ifdef __cplusplus
/** If using C++ this macro enables C mode, otherwise does nothing */
#define AVAHI_C_DECL_BEGIN extern "C" {
diff --git a/avahi-common/rr.h b/avahi-common/rr.h
index 1f6a4c6..25d6eee 100644
--- a/avahi-common/rr.h
+++ b/avahi-common/rr.h
@@ -28,6 +28,8 @@
#include <avahi-common/address.h>
#include <avahi-common/cdecl.h>
+/** \file rr.h Functions and definitions for manipulating DNS resource record (RR) data. */
+
AVAHI_C_DECL_BEGIN
/** DNS record types, see RFC 1035 */
diff --git a/avahi-common/strlst.h b/avahi-common/strlst.h
index 1d9ef34..01a2c41 100644
--- a/avahi-common/strlst.h
+++ b/avahi-common/strlst.h
@@ -25,6 +25,8 @@
#include <glib.h>
#include <avahi-common/cdecl.h>
+/** \file strlst.h Implementation of a data type to store lists of strings */
+
AVAHI_C_DECL_BEGIN
/** Linked list of strings that can contain any number of binary