modocs

diff --git a/ldns/parse.h b/ldns/parse.h
index a3969e91cda04d7625b3bd552f5f7270f914a19d..4332858ed110d67db72ef0c6e1f0aaf8e5d5824c 100644 (file)
--- a/ldns/parse.h
+++ b/ldns/parse.h
@@ -19,6 +19,14 @@
 #define LDNS_MAX_LINELEN               4096
 #define LDNS_MAX_KEYWORDLEN            32
 
+
+/**
+ * \file
+ *
+ * Contains some low-level parsing functions, mostly used in the _frm_str
+ * family of functions.
+ */
+ 
 /**
  * different type of directives in zone files
  * We now deal with $TTL, $ORIGIN and $INCLUDE.

diff --git a/ldns/rdata.h b/ldns/rdata.h
index 162438b6a49dae40c1ba41d2e9df90aecd9b9849..42882fb790cbf045e623ee1c2bb00f38230ebf75 100644 (file)
--- a/ldns/rdata.h
+++ b/ldns/rdata.h
@@ -10,6 +10,14 @@
  * See the file LICENSE for the license
  */
 
+
+/**
+ * \file
+ *
+ * Defines \ref ldns_rdf and functions to manipulate those.
+ */
+
+
 #ifndef LDNS_RDATA_H
 #define LDNS_RDATA_H
 

diff --git a/ldns/resolver.h b/ldns/resolver.h
index ec8fa19831122c0cd947ef8a927775dafa22b84b..c50b3b6135cf69ef1f876d2d9f3ed7b491103136 100644 (file)
--- a/ldns/resolver.h
+++ b/ldns/resolver.h
@@ -10,6 +10,13 @@
  * See the file LICENSE for the license
  */
 
+/**
+ * \file
+ *
+ * Defines the \ref ldns_resolver structure, a stub resolver that can send queries and parse answers.
+ * 
+ */
+
 #ifndef LDNS_RESOLVER_H
 #define LDNS_RESOLVER_H
 

diff --git a/ldns/rr.h b/ldns/rr.h
index 55f838d2f41e0e7594b5e25043c2ff445741e535..5daa16dcb86eec7902906f5052c7dc05c7a521c6 100644 (file)
--- a/ldns/rr.h
+++ b/ldns/rr.h
@@ -8,6 +8,13 @@
  * See the file LICENSE for the license
  */
 
+/**
+ * \file
+ *
+ * Contains the definition of \ref ldns_rr and functions to manipulate those.
+ */
+
+
 #ifndef LDNS_RR_H
 #define LDNS_RR_H
 

diff --git a/ldns/rr_functions.h b/ldns/rr_functions.h
index 79c1c66405b624591ca0fa2cb7975c22c3058b0b..cec79e79bb7b9a3ccaed71d34003b98695b0b66a 100644 (file)
--- a/ldns/rr_functions.h
+++ b/ldns/rr_functions.h
@@ -13,14 +13,13 @@
 #ifndef LDNS_RR_FUNCTIONS_H
 #define LDNS_RR_FUNCTIONS_H
 
-
-/* set rdf's at a specific offset
- * The RR need to be created with ldns_rr_new_frm_type which
- * allocated enough space for all rdf's and sets them to NULL
+/**
+ * \file
+ *
+ * Defines some extra convenience functions for \ref ldns_rr structures
  */
 
-/* A/AAAA */
-
+/* A / AAAA */
 /**
  * returns the address of a LDNS_RR_TYPE_A rr
  * \param[in] r the resource record

diff --git a/ldns/str2host.h b/ldns/str2host.h
index 7cf9ce4c5c47de5ca77479796cba7a2e34914ef9..d970c69330aea50f650e6caf301e3203e8660aa8 100644 (file)
--- a/ldns/str2host.h
+++ b/ldns/str2host.h
@@ -19,6 +19,13 @@
 #include <ldns/buffer.h>
 #include <ctype.h>
 
+/**
+ * \file
+ *
+ * Defines functions to convert dns data in presentation format or text files
+ * to internal structures.
+ */
+
 /**
  * convert a byte into wireformat
  * \param[in] rd the rdf where to put the data

diff --git a/ldns/tsig.h b/ldns/tsig.h
index 2d0e358c54becdd4adaef3fad7ad51141a09fc83..b1ea35bf15952f71b69b1dc3b338b9f59a8e7b5a 100644 (file)
--- a/ldns/tsig.h
+++ b/ldns/tsig.h
@@ -9,6 +9,13 @@
 #ifndef LDNS_TSIG_H
 #define LDNS_TSIG_H
 
+/**
+ * \file
+ *
+ * Defines functions for TSIG usage
+ */
+
+
 /**
  * Contains credentials for TSIG
 */

diff --git a/ldns/update.h b/ldns/update.h
index eba1c9ee74721630f9c316e6b913e0a7023e199c..a4c12ea4e7d31f288e0eb2a5889af244ee7f8186 100644 (file)
--- a/ldns/update.h
+++ b/ldns/update.h
@@ -8,6 +8,13 @@
  * See LICENSE for the license.
  */
 
+/**
+ * \file
+ *
+ * Defines functions to perform UPDATE queries
+ */
+
+
 #ifndef LDNS_UPDATE_H
 #define LDNS_UPDATE_H
 

diff --git a/ldns/wire2host.h b/ldns/wire2host.h
index e602eff8c826c5debd70d14916c5d5faa929d0bd..d67be3de2905419ed07eb0b8d168c0331ada2540 100644 (file)
--- a/ldns/wire2host.h
+++ b/ldns/wire2host.h
@@ -8,7 +8,13 @@
  * See the file LICENSE for the license
  */
 
-
+/**
+ * \file
+ *
+ * Contains functions that translate dns data from the wire format (as sent
+ * by servers and clients) to the internal structures.
+ */
+ 
 #ifndef LDNS_WIRE2HOST_H
 #define LDNS_WIRE2HOST_H
 

diff --git a/ldns/zone.h b/ldns/zone.h
index a1890549e5b770a6d57a8a6b84220c444cbf839a..0ef981d92cd9769f7a2815f16cf27840c0e4fc71 100644 (file)
--- a/ldns/zone.h
+++ b/ldns/zone.h
@@ -13,6 +13,13 @@
  * See the file LICENSE for the license
  */
 
+/**
+ * \file
+ *
+ * Defines the \ref ldns_zone structure and functions to manipulate it.
+ */
+ 
+
 #ifndef LDNS_ZONE_H
 #define LDNS_ZONE_H