Added Doxygen config and started formatting comments in sources

README.md

@@ -18,6 +18,8 @@ The goals of this implemtation of the getdns API are:
 * Leverage github as much as possible for project coordination
 * Coding style/standards follow the [BSD coding style](ftp://ftp.netbsd.org/pub/NetBSD/NetBSD-current/src/share/misc/style)
 * Follow the git flow branching model described at <http://nvie.com/posts/a-successful-git-branching-model/>
+** the master branch is always in a production ready state
+** the develop branch contains the latest development changes which are merged from develop into master once they are considered production ready
 * Both synchronous and asynchronous entry points with an early focus on the asynchronous model
  
 Contributors

src/src/example-simple-answers.c

@@ -1,8 +1,10 @@
-/* example-simple-answers.c
+/** 
+ * /brief demonstrate asynchronous use of the API for fetching DNS data
  *
  * Originally taken from the getdns API description pseudo implementation.
- *
+ */
- * The MIT License (MIT)
+
+/* The MIT License (MIT)
  * Copyright (c) 2013 Verisign, Inc.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -124,4 +126,5 @@ main()
 	/* Assuming we get here, leave gracefully */
 	exit(EXIT_SUCCESS);
 } /* main */
+
 /* example-simple-answers.c */

src/src/getdns_core_only.c

@@ -1,4 +1,31 @@
-/* getdns_core_only.c
+/**
+ *
+ * /brief getdns core functions
+ * 
+ * This is the meat of the API
+ * Originally taken from the getdns API description pseudo implementation.
+ *
+ */
+/* The MIT License (MIT)
+ * Copyright (c) 2013 Verisign, Inc.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ * 
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ * 
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
  */
 
 #include <getdns_libevent.h>
@@ -6,9 +33,9 @@
 /* stuff to make it compile pedantically */
 #define UNUSED_PARAM(x) ((void)(x))
 
-int main(){ return(0); }
+/*
-
+ * getdns_general
-/* Function definitions */
+ */
 
 getdns_return_t
 getdns_general(
@@ -21,7 +48,7 @@ getdns_general(
   getdns_callback_t          callback
 )
 { UNUSED_PARAM(context); UNUSED_PARAM(name); UNUSED_PARAM(request_type); UNUSED_PARAM(extensions); UNUSED_PARAM(userarg);
-UNUSED_PARAM(transaction_id); UNUSED_PARAM(callback); return GETDNS_RETURN_GOOD; }
+UNUSED_PARAM(transaction_id); UNUSED_PARAM(callback); return GETDNS_RETURN_GOOD; } /* getdns_general */
 
 getdns_return_t
 getdns_address(
@@ -59,12 +86,22 @@ getdns_service(
 { UNUSED_PARAM(context); UNUSED_PARAM(name); UNUSED_PARAM(extensions); UNUSED_PARAM(userarg);
 UNUSED_PARAM(transaction_id); UNUSED_PARAM(callback); return GETDNS_RETURN_GOOD; }
 
+/*
+ * getdns_context_create
+ *
+ * call this to initialize the context that is used in other getdns calls
+ */
 getdns_return_t
 getdns_context_create(
     getdns_context_t       *context,
     bool                   set_from_os
 )
-{ UNUSED_PARAM(context); UNUSED_PARAM(set_from_os); return GETDNS_RETURN_GOOD; }
+{
+
+UNUSED_PARAM(context); UNUSED_PARAM(set_from_os);
+
+    return GETDNS_RETURN_GOOD;
+} /* getdns_context_create */
 
 void
 getdns_context_destroy(