[Opensync-commits] r5182 - in trunk/opensync: common debug helper

[<dg...@su...>]

Author: bricks
Date: Sun Jan 18 11:32:16 2009
New Revision: 5182
URL: http://www.opensync.org/changeset/5182

Log:
doxygen rearrangements
moved annotations from c files to header, created new groups, ...

Modified:
   trunk/opensync/common/opensync_error.c
   trunk/opensync/common/opensync_error.h
   trunk/opensync/common/opensync_error_private.h
   trunk/opensync/common/opensync_file.c
   trunk/opensync/common/opensync_file.h
   trunk/opensync/common/opensync_marshal.h
   trunk/opensync/common/opensync_marshal_private.h
   trunk/opensync/common/opensync_memory.h
   trunk/opensync/common/opensync_string.h
   trunk/opensync/common/opensync_thread.c
   trunk/opensync/common/opensync_thread_internals.h
   trunk/opensync/common/opensync_thread_private.h
   trunk/opensync/common/opensync_xml_internals.h
   trunk/opensync/debug/opensync_trace.h
   trunk/opensync/helper/opensync_anchor_internals.h

Modified: trunk/opensync/common/opensync_error.c
==============================================================================
--- trunk/opensync/common/opensync_error.c	Sun Jan 18 09:51:07 2009	(r5181)
+++ trunk/opensync/common/opensync_error.c	Sun Jan 18 11:32:16 2009	(r5182)
@@ -23,22 +23,6 @@
 
 #include "opensync_error_private.h"
 
-/**
- * @defgroup OSyncErrorPrivateAPI OpenSync Error Internals
- * @ingroup OSyncPrivate
- * @brief The public API of opensync
- * 
- * This gives you an insight in the public API of opensync.
- * 
- */
-/*@{*/
-
-/*! @brief Translate a error type into something human readable
- * 
- * @param type The error type to look up
- * @returns The name of the error type
- * 
- */
 static const char *osync_error_name_from_type(OSyncErrorType type)
 {
 	switch (type) {
@@ -61,14 +45,6 @@
 	}
 }
 
-/*! @brief Sets a error from a va_list
- * 
- * @param error A pointer to a error struct
- * @param type The type to set
- * @param format The message
- * @param args The arguments to the message
- * 
- */
 void osync_error_set_vargs(OSyncError **error, OSyncErrorType type, const char *format, va_list args)
 {
 	osync_return_if_fail(error);
@@ -85,23 +61,6 @@
 	return;
 }
 
-/*@}*/
-
-/**
- * @defgroup OSyncErrorAPI OpenSync Errors
- * @ingroup OSyncPublic
- * @brief OpenSync's error reporting facilities
- * 
- */
-/*@{*/
-
-
-/*! @brief This will return a string describing the type of the error
- * 
- * @param error A pointer to a error struct
- * @returns The description, NULL on error
- * 
- */
 const char *osync_error_get_name(OSyncError **error)
 {
 	osync_return_val_if_fail(error != NULL, NULL);
@@ -110,12 +69,6 @@
 	return osync_error_name_from_type((*error)->type);
 }
 
-/** @brief Increase the reference count of the error object 
- * 
- * @param error The error object 
- * @returns The referenced error pointer
- * 
- */
 OSyncError **osync_error_ref(OSyncError **error)
 {
 	if (!osync_error_is_set(error))
@@ -126,11 +79,6 @@
 	return error;
 }
 
-/** @brief Decrease the reference count of the error object
- * 
- * @param error The error object 
- * 
- */
 void osync_error_unref(OSyncError **error)
 {
 	if (!osync_error_is_set(error))
@@ -149,12 +97,6 @@
 	*error = NULL;
 }
 
-/*! @brief Checks if the error is set
- * 
- * @param error A pointer to a error struct to check
- * @returns TRUE if the error is set, FALSE otherwise
- * 
- */
 osync_bool osync_error_is_set (OSyncError **error)
 {
 	if (!error)
@@ -169,12 +111,6 @@
 	return FALSE;
 }
 
-/*! @brief Returns the type of the error
- * 
- * @param error The error
- * @returns The type of the error or OSYNC_NO_ERROR if no error
- * 
- */
 OSyncErrorType osync_error_get_type(OSyncError **error)
 {
 	if (!osync_error_is_set(error))
@@ -182,12 +118,6 @@
 	return (*error)->type;
 }
 
-/*! @brief Returns the message of the error
- * 
- * @param error The error to print
- * @returns The message of the error or NULL if no error
- * 
- */
 const char *osync_error_print(OSyncError **error)
 {
 	if (!osync_error_is_set(error))
@@ -195,13 +125,6 @@
 	return (*error)->message;
 }
 
-
-/*! @brief Returns the entired error stack as single string 
- * 
- * @param error The error stack to print
- * @returns The message of the error or NULL if no error
- * 
- */
 char *osync_error_print_stack(OSyncError **error)
 {
 	char *submessage = NULL;
@@ -221,13 +144,6 @@
 	return message;
 }
 
-/*! @brief Duplicates the error into the target
- * 
- * 
- * @param target The target error to update
- * @param source The source error which to duplicate
- * 
- */
 void osync_error_set_from_error(OSyncError **target, OSyncError **source)
 {
 	if (!target || osync_error_is_set(target))
@@ -242,15 +158,6 @@
 	osync_error_ref(target);
 }
 
-/*! @brief Sets the error
- * 
- * You can use this function to set the error to the given type and message
- * 
- * @param error A pointer to a error struct to set
- * @param type The Error type to set
- * @param format The message
- * 
- */
 void osync_error_set(OSyncError **error, OSyncErrorType type, const char *format, ...)
 {
 	va_list args;
@@ -259,14 +166,6 @@
 	va_end (args);
 }
 
-/*! @brief Stack error on another error object 
- * 
- * Use this function to stack all errors to describe the root cause of an error 
- * 
- * @param parent A pointer to a error which gets the child stacked 
- * @param child A pointer to a error to which get stacked on parent error
- * 
- */
 void osync_error_stack(OSyncError **parent, OSyncError **child)
 {
 	if (!parent || !*parent)
@@ -286,13 +185,6 @@
 	osync_error_ref(child);
 }
 
-/*! @brief Get stacked child of an error object 
- * 
- * Use this function to read an error stack 
- * 
- * @param parent A pointer to a error stack 
- * 
- */
 OSyncError *osync_error_get_child(OSyncError **parent)
 {
 	if (!parent || !*parent)
@@ -301,12 +193,6 @@
 	return (*parent)->child;
 }
 
-/*! @brief Sets the type of an error
- * 
- * @param error A pointer to a error struct to set
- * @param type The Error type to set
- * 
- */
 void osync_error_set_type(OSyncError **error, OSyncErrorType type)
 {
 	if (!error)
@@ -316,4 +202,3 @@
 	return;
 }
 
-/*@}*/

Modified: trunk/opensync/common/opensync_error.h
==============================================================================
--- trunk/opensync/common/opensync_error.h	Sun Jan 18 09:51:07 2009	(r5181)
+++ trunk/opensync/common/opensync_error.h	Sun Jan 18 11:32:16 2009	(r5182)
@@ -25,7 +25,16 @@
 
 OPENSYNC_BEGIN_DECLS
 
-/*! @ingroup OSyncErrorAPI
+/**
+ * @defgroup OSyncCommon OpenSync Common Module
+ * @ingroup OSyncPublic
+ * @defgroup OSyncErrorAPI OpenSync Error
+ * @ingroup OSyncCommon
+ */
+ 
+/*@{*/
+
+ /*
  * @brief Defines the possible error types
  */
 typedef enum {
@@ -48,20 +57,120 @@
 	OSYNC_ERROR_PLUGIN_NOT_FOUND = 16
 } OSyncErrorType;
 
+/** @brief Increase the reference count of the error object 
+ * 
+ * @param error The error object 
+ * @returns The referenced error pointer
+ * 
+ */
 OSYNC_EXPORT OSyncError **osync_error_ref(OSyncError **error);
+
+/** @brief Decrease the reference count of the error object
+ * 
+ * @param error The error object 
+ * 
+ */
 OSYNC_EXPORT void osync_error_unref(OSyncError **error);
+
+/** @brief Checks if the error is set
+ * 
+ * @param error A pointer to a error struct to check
+ * @returns TRUE if the error is set, FALSE otherwise
+ * 
+ */
 OSYNC_EXPORT osync_bool osync_error_is_set (OSyncError **error);
+
+/** @brief Sets the error
+ * 
+ * You can use this function to set the error to the given type and message
+ * 
+ * @param error A pointer to a error struct to set
+ * @param type The Error type to set
+ * @param format The message
+ * 
+ */
 OSYNC_EXPORT void osync_error_set(OSyncError **error, OSyncErrorType type, const char *format, ...);
+
+/** @brief This will return a string describing the type of the error
+ * 
+ * @param error A pointer to a error struct
+ * @returns The description, NULL on error
+ * 
+ */
 OSYNC_EXPORT const char *osync_error_get_name(OSyncError **error);
+
+/** @brief Duplicates the error into the target
+ * 
+ * 
+ * @param target The target error to update
+ * @param source The source error which to duplicate
+ * 
+ */
 OSYNC_EXPORT void osync_error_set_from_error(OSyncError **target, OSyncError **source);
+
+/** @brief Returns the message of the error
+ * 
+ * @param error The error to print
+ * @returns The message of the error or NULL if no error
+ * 
+ */
 OSYNC_EXPORT const char *osync_error_print(OSyncError **error);
+
+/** @brief Returns the entired error stack as single string 
+ * 
+ * @param error The error stack to print
+ * @returns The message of the error or NULL if no error
+ * 
+ */
 OSYNC_EXPORT char *osync_error_print_stack(OSyncError **error);
+
+/** @brief Stack error on another error object 
+ * 
+ * Use this function to stack all errors to describe the root cause of an error 
+ * 
+ * @param parent A pointer to a error which gets the child stacked 
+ * @param child A pointer to a error to which get stacked on parent error
+ * 
+ */
 OSYNC_EXPORT void osync_error_stack(OSyncError **parent, OSyncError **child);
+
+/** @brief Get stacked child of an error object 
+ * 
+ * Use this function to read an error stack 
+ * 
+ * @param parent A pointer to a error stack 
+ * 
+ */
 OSYNC_EXPORT OSyncError *osync_error_get_child(OSyncError **parent);
+
+/** @brief Returns the type of the error
+ * 
+ * @param error The error
+ * @returns The type of the error or OSYNC_NO_ERROR if no error
+ * 
+ */
 OSYNC_EXPORT OSyncErrorType osync_error_get_type(OSyncError **error);
+
+/** @brief Sets the type of an error
+ * 
+ * @param error A pointer to a error struct to set
+ * @param type The Error type to set
+ * 
+ */
 OSYNC_EXPORT void osync_error_set_type(OSyncError **error, OSyncErrorType type);
+
+/** @brief Sets a error from a va_list
+ * 
+ * @param error A pointer to a error struct
+ * @param type The type to set
+ * @param format The message
+ * @param args The arguments to the message
+ * 
+ */
 OSYNC_EXPORT void osync_error_set_vargs(OSyncError **error, OSyncErrorType type, const char *format, va_list args);
 
+/*@}*/
+
 OPENSYNC_END_DECLS
 
 #endif //OPENSYNC_ERROR_H_

Modified: trunk/opensync/common/opensync_error_private.h
==============================================================================
--- trunk/opensync/common/opensync_error_private.h	Sun Jan 18 09:51:07 2009	(r5181)
+++ trunk/opensync/common/opensync_error_private.h	Sun Jan 18 11:32:16 2009	(r5182)
@@ -21,7 +21,16 @@
 #ifndef OPENSYNC_ERROR_PRIVATE_H_
 #define OPENSYNC_ERROR_PRIVATE_H_
 
-/*! @brief Represent an error
+/**
+ * @defgroup OSyncCommonPrivate OpenSync Common Module Private
+ * @ingroup OSyncPrivate
+ * @defgroup OSyncErrorPrivateAPI OpenSync Error Private
+ * @ingroup OSyncCommonPrivate
+ */
+
+/*@{*/
+
+/** @brief Represent an error
  */
 struct OSyncError {
 	/** The type of the error that occured */
@@ -32,4 +41,14 @@
 	OSyncError *child;
 };
 
+/** @brief Translate a error type into something human readable
+ * 
+ * @param type The error type to look up
+ * @returns The name of the error type
+ * 
+ */
+static const char *osync_error_name_from_type(OSyncErrorType type);
+
+/*@}*/
+
 #endif //OPENSYNC_ERROR_PRIVATE_H_

Modified: trunk/opensync/common/opensync_file.c
==============================================================================
--- trunk/opensync/common/opensync_file.c	Sun Jan 18 09:51:07 2009	(r5181)
+++ trunk/opensync/common/opensync_file.c	Sun Jan 18 11:32:16 2009	(r5182)
@@ -119,10 +119,10 @@
 	} /* While */
 	g_dir_close(gdir);
 	gdir = NULL;
-        if (g_rmdir(dirname) < 0){
-          g_set_error(&gerror, G_FILE_ERROR, g_file_error_from_errno(errno), "%s", dirname);
-          goto error;
-        }
+	if (g_rmdir(dirname) < 0){
+		g_set_error(&gerror, G_FILE_ERROR, g_file_error_from_errno(errno), "%s", dirname);
+		goto error;
+	}
 
 	return 0; 
 		

Modified: trunk/opensync/common/opensync_file.h
==============================================================================
--- trunk/opensync/common/opensync_file.h	Sun Jan 18 09:51:07 2009	(r5181)
+++ trunk/opensync/common/opensync_file.h	Sun Jan 18 11:32:16 2009	(r5182)
@@ -22,14 +22,14 @@
 #define _OPENSYNC_FILE_H
 
 /**
- * @defgroup OSyncFileAPI OpenSync File interface 
+ * @defgroup OSyncFileAPI OpenSync File 
  * @ingroup OSyncCommon
  * @brief Functions for handling common file operations 
  */
 
 /*@{*/
 
-/*! @brief Writes data to a file
+/** @brief Writes data to a file
  * 
  * Writes data to a file
  * 
@@ -43,7 +43,7 @@
  */
 OSYNC_EXPORT osync_bool osync_file_write(const char *filename, const char *data, unsigned int size, int mode, OSyncError **error);
 
-/*! @brief Reads a file
+/** @brief Reads a file
  * 
  * Reads a file
  * 
@@ -56,7 +56,7 @@
  */
 OSYNC_EXPORT osync_bool osync_file_read(const char *filename, char **data, unsigned int *size, OSyncError **error);
 
-/*! @brief Removes a directory recursively
+/** @brief Removes a directory recursively
  * 
  * Removes a directory recursively. This is an 
  * internal function for portability. 

Modified: trunk/opensync/common/opensync_marshal.h
==============================================================================
--- trunk/opensync/common/opensync_marshal.h	Sun Jan 18 09:51:07 2009	(r5181)
+++ trunk/opensync/common/opensync_marshal.h	Sun Jan 18 11:32:16 2009	(r5182)
@@ -24,8 +24,8 @@
 /**
  * @defgroup OSyncCommon OpenSync Common Module
  * @ingroup OSyncPublic
- * @defgroup OSyncMarshal OpenSync Marshal
- * @ingroup OSyncMarshal
+ * @defgroup OSyncMarshalAPI OpenSync Marshal
+ * @ingroup OSyncCommon
  * @brief Functions for serializing/marshaling data 
  * 
  */

Modified: trunk/opensync/common/opensync_marshal_private.h
==============================================================================
--- trunk/opensync/common/opensync_marshal_private.h	Sun Jan 18 09:51:07 2009	(r5181)
+++ trunk/opensync/common/opensync_marshal_private.h	Sun Jan 18 11:32:16 2009	(r5182)
@@ -25,14 +25,15 @@
  * @defgroup OSyncCommonPrivate OpenSync Common Module Private
  * @ingroup OSyncPrivate
  * @defgroup OSyncMarshalPrivateAPI OpenSync Marshal Private 
- * @ingroup OSyncMarshalPrivate
+ * @ingroup OSyncCommonPrivate
  * @brief Serialized buffer 
  * 
  */
 
 /*@{*/
-/*! @brief A OSyncMarshal object 
- * 
+
+/**
+ * @brief A OSyncMarshal object 
  */
 struct OSyncMarshal {
 	/** Reference counting */

Modified: trunk/opensync/common/opensync_memory.h
==============================================================================
--- trunk/opensync/common/opensync_memory.h	Sun Jan 18 09:51:07 2009	(r5181)
+++ trunk/opensync/common/opensync_memory.h	Sun Jan 18 11:32:16 2009	(r5182)
@@ -22,12 +22,12 @@
 #define _OPENSYNC_MEMORY_H
 
 /**
- * @defgroup OSyncMemoryAPI OpenSync Memory interface 
+ * @defgroup OSyncMemoryAPI OpenSync Memory 
  * @ingroup OSyncCommon
  * @brief Functions for handling memory operations 
  */
 
-/*! @brief Safely tries to malloc memory
+/** @brief Safely tries to malloc memory
  * 
  * Tries to malloc memory but returns an error in an OOM situation instead
  * of aborting
@@ -39,7 +39,7 @@
  */
 OSYNC_EXPORT void *osync_try_malloc0(unsigned int size, OSyncError **error);
 
-/*! @brief Frees memory
+/** @brief Frees memory
  * 
  * Frees memory allocated by osync_try_malloc0() and others osync_* functions.
  * 

Modified: trunk/opensync/common/opensync_string.h
==============================================================================
--- trunk/opensync/common/opensync_string.h	Sun Jan 18 09:51:07 2009	(r5181)
+++ trunk/opensync/common/opensync_string.h	Sun Jan 18 11:32:16 2009	(r5182)
@@ -22,14 +22,14 @@
 #define _OPENSYNC_STRING_H
 
 /**
- * @defgroup OSyncStringAPI OpenSync String interface 
+ * @defgroup OSyncStringAPI OpenSync String
  * @ingroup OSyncCommon
  * @brief Functions for handling common string operations 
  */
 
 /*@{*/
 
-/*! @brief String replace
+/** @brief String replace
  * 
  * @param input Input string to work on
  * @param delimiter Delimiter
@@ -39,7 +39,7 @@
  */
 OSYNC_EXPORT char *osync_strreplace(const char *input, const char *delimiter, const char *replacement);
 
-/*! @brief Duplicates a string 
+/** @brief Duplicates a string 
  * 
  * Duplicates a string, ending with terminating-zero: \0
  * 
@@ -49,7 +49,7 @@
  */
 OSYNC_EXPORT char *osync_strdup(const char *str);
 
-/*! @brief Duplicates a formated string 
+/** @brief Duplicates a formated string 
  * 
  * Duplicates a formated string, ending with terminating-zero: \0
  * 
@@ -60,7 +60,7 @@
  */
 OSYNC_EXPORT char *osync_strdup_printf(const char *format, ...);
 
-/*! @brief Creates a random string
+/** @brief Creates a random string
  * 
  * Creates a random string of given length or less
  * 

Modified: trunk/opensync/common/opensync_thread.c
==============================================================================
--- trunk/opensync/common/opensync_thread.c	Sun Jan 18 09:51:07 2009	(r5181)
+++ trunk/opensync/common/opensync_thread.c	Sun Jan 18 11:32:16 2009	(r5182)
@@ -24,19 +24,6 @@
 #include "opensync_thread_private.h"
 #include "opensync_thread_internals.h"
 
-/**
- * @defgroup OSyncThreadAPI OpenSync Thread Module 
- * @ingroup OSyncPrivate
- * @brief Some threading  functions
- * 
- */
-/*@{*/
-
-/*! @brief Stop callback function to stop thread mainloop
- *
- * @param data Pointer to passed callback data
- * @returns Always FALSE
- */
 static gboolean osyncThreadStopCallback(gpointer data)
 {
 	OSyncThread *thread = data;
@@ -46,11 +33,6 @@
 	return FALSE;
 }
 
-/*! @brief Start callback function to emit signal when thread's mainloop got started
- *
- * @param data Pointer to passed callback data
- * @returns Always FALSE
- */
 static gboolean osyncThreadStartCallback(gpointer data)
 {
 	OSyncThread *thread = data;
@@ -62,13 +44,6 @@
 	return FALSE;
 }
 
-/*! @brief Allocates a new thread with a g_mainloop 
- * 
- * @param context Pointer to GMainContext 
- * @param error The error which will hold the info in case of an error
- * @returns A pointer to the new allocated OSyncThread with inactive thread and mainloop 
- * 
- */
 OSyncThread *osync_thread_new(GMainContext *context, OSyncError **error)
 {
 	OSyncThread *thread = NULL;
@@ -96,11 +71,6 @@
 	return NULL;
 }
 
-/** @brief Increases the reference count on thread object 
- * 
- * @param thread Pointer to OSyncThread
- * 
- */
 OSyncThread *osync_thread_ref(OSyncThread *thread)
 {
 	osync_trace(TRACE_ENTRY, "%s(%p)", __func__, thread);
@@ -112,11 +82,6 @@
 	return thread;
 }
 
-/** @brief Decrements reference count on thread object 
- * 
- * @param thread Pointer to OSyncThread
- * 
- */
 void osync_thread_unref(OSyncThread *thread)
 {
 	osync_trace(TRACE_ENTRY, "%s(%p)", __func__, thread);
@@ -153,29 +118,7 @@
 	return NULL;
 	}*/
 
-/*void osync_thread_start(OSyncThread *thread)
-	{
-	osync_trace(TRACE_ENTRY, "%s(%p)", __func__, thread);
-	osync_assert(thread);
-	
-	//Start the thread
-	g_mutex_lock(thread->started_mutex);
-	thread->thread = g_thread_create (osyncThreadStartCallback, thread, TRUE, NULL);
-	g_cond_wait(thread->started, thread->started_mutex);
-	g_mutex_unlock(thread->started_mutex);
-	
-	osync_trace(TRACE_EXIT, "%s", __func__);
-	}*/
 
-
-/*! @brief Start thread and it's mainloop 
- * 
- * @param func GThreadFunc Pointer
- * @param userdata Custom data poitner which get supplied to thread function
- * @param error Pointer to error struct
- * @return Newly allocate OSyncThread object with inactive mainloop
- * 
- */
 OSyncThread *osync_thread_create(GThreadFunc func, void *userdata, OSyncError **error)
 {
 	GError *gerror;
@@ -210,12 +153,6 @@
 	return NULL;
 }
 
-
-/*! @brief Start thread and it's mainloop 
- * 
- * @param thread Thread object 
- * 
- */
 void osync_thread_start(OSyncThread *thread)
 {
 	GSource *idle = NULL;
@@ -232,11 +169,6 @@
 	osync_trace(TRACE_EXIT, "%s", __func__);
 }	
 
-/*! @brief Stops thread's mainloop and joins the thread
- * 
- * @param thread Thread object 
- * 
- */
 void osync_thread_stop(OSyncThread *thread)
 {
 	GSource *source = NULL;
@@ -255,12 +187,6 @@
 	osync_trace(TRACE_EXIT, "%s", __func__);
 }
 
-/*! @brief Exit thread 
- * 
- * @param thread Thread object 
- * @param retval Return value of thread while exiting
- * 
- */
 void osync_thread_exit(OSyncThread *thread, int retval)
 {
 	GSource *source = NULL;
@@ -278,7 +204,3 @@
 	osync_trace(TRACE_EXIT, "%s", __func__);
 }
 
-
-
-/*@}*/
-

Modified: trunk/opensync/common/opensync_thread_internals.h
==============================================================================
--- trunk/opensync/common/opensync_thread_internals.h	Sun Jan 18 09:51:07 2009	(r5181)
+++ trunk/opensync/common/opensync_thread_internals.h	Sun Jan 18 11:32:16 2009	(r5182)
@@ -22,15 +22,72 @@
 #ifndef _OPENSYNC_THREAD_INTERNALS_H
 #define _OPENSYNC_THREAD_INTERNALS_H
 
+/**
+ * @defroup OSyncThreadInternalAPI OpenSync Thread Internals
+ * @ingroup OSyncCommonPrivate
+ * @brief Some threading functions
+ */
+
+/*@{*/
+
 typedef struct OSyncThread OSyncThread;
 
+/** @brief Allocates a new thread with a g_mainloop 
+ * 
+ * @param context Pointer to GMainContext 
+ * @param error The error which will hold the info in case of an error
+ * @returns A pointer to the new allocated OSyncThread with inactive thread and mainloop 
+ * 
+ */
 OSYNC_TEST_EXPORT OSyncThread *osync_thread_new(GMainContext *context, OSyncError **error);
+
+/** @brief Increases the reference count on thread object 
+ * 
+ * @param thread Pointer to OSyncThread
+ * 
+ */
 OSYNC_TEST_EXPORT OSyncThread *osync_thread_ref(OSyncThread *thread);
+
+/** @brief Decrements reference count on thread object 
+ * 
+ * @param thread Pointer to OSyncThread
+ * 
+ */
 OSYNC_TEST_EXPORT void osync_thread_unref(OSyncThread *thread);
+
+/** @brief Start thread and it's mainloop 
+ * 
+ * @param thread Thread object 
+ * 
+ */
 OSYNC_TEST_EXPORT void osync_thread_start(OSyncThread *thread);
+
+/** @brief Stops thread's mainloop and joins the thread
+ * 
+ * @param thread Thread object 
+ * 
+ */
 OSYNC_TEST_EXPORT void osync_thread_stop(OSyncThread *thread);
+
+/** @brief Exit thread 
+ * 
+ * @param thread Thread object 
+ * @param retval Return value of thread while exiting
+ * 
+ */
 OSYNC_TEST_EXPORT void osync_thread_exit(OSyncThread *thread, int retval);
+
+/** @brief Start thread and it's mainloop 
+ * 
+ * @param func GThreadFunc Pointer
+ * @param userdata Custom data poitner which get supplied to thread function
+ * @param error Pointer to error struct
+ * @return Newly allocate OSyncThread object with inactive mainloop
+ * 
+ */
 OSYNC_TEST_EXPORT OSyncThread *osync_thread_create(GThreadFunc func, void *userdata, OSyncError **error);
 
+/*@}*/
+
 #endif /* _OPENSYNC_THREAD_INTERNALS_H */
 

Modified: trunk/opensync/common/opensync_thread_private.h
==============================================================================
--- trunk/opensync/common/opensync_thread_private.h	Sun Jan 18 09:51:07 2009	(r5181)
+++ trunk/opensync/common/opensync_thread_private.h	Sun Jan 18 11:32:16 2009	(r5182)
@@ -21,14 +21,41 @@
 #ifndef _OPENSYNC_THREAD_PRIVATE_H
 #define _OPENSYNC_THREAD_PRIVATE_H
 
+/**
+ * @defgroup OSyncThreadPrivateAPI OpenSync Thread Private
+ * @ingroup OSyncCommonPrivate
+ */
+
+/*@{*/
+
+/**
+ * @brief Represents a Thread
+ */
 struct OSyncThread {
 	GThread *thread;
 	GCond *started;
 	GMutex *started_mutex;
 	GMainContext *context;
 	GMainLoop *loop;
+	/** reference counter */
 	int ref_count;
 };
 
+/** @brief Start callback function to emit signal when thread's mainloop got started
+ *
+ * @param data Pointer to passed callback data
+ * @returns Always FALSE
+ */
+static gboolean osyncThreadStartCallback(gpointer data);
+
+/** @brief Stop callback function to stop thread mainloop
+ *
+ * @param data Pointer to passed callback data
+ * @returns Always FALSE
+ */
+static gboolean osyncThreadStopCallback(gpointer data);
+
+/*@}*/
+
 #endif /* _OPENSYNC_THREAD_PRIVATE_H */
 

Modified: trunk/opensync/common/opensync_xml_internals.h
==============================================================================
--- trunk/opensync/common/opensync_xml_internals.h	Sun Jan 18 09:51:07 2009	(r5181)
+++ trunk/opensync/common/opensync_xml_internals.h	Sun Jan 18 11:32:16 2009	(r5182)
@@ -30,6 +30,13 @@
 #include <string.h>
 #include <stdio.h>
 
+/**
+ * @defgroup OSyncXMLInternalAPI OpenSync XML Internals
+ * @ingroup OSyncCommonPrivate
+ */
+
+/*@{*/
+
 typedef enum osxmlEncoding {
 	OSXML_8BIT = 0,
 	OSXML_QUOTED_PRINTABLE = 1,
@@ -85,4 +92,6 @@
 
 osync_bool osync_xml_open_file(xmlDocPtr *doc, xmlNodePtr *cur, const char *path, const char *topentry, OSyncError **error);
 
+/*@}*/
+
 #endif /*_OPENSYNC_XML_H*/

Modified: trunk/opensync/debug/opensync_trace.h
==============================================================================
--- trunk/opensync/debug/opensync_trace.h	Sun Jan 18 09:51:07 2009	(r5181)
+++ trunk/opensync/debug/opensync_trace.h	Sun Jan 18 11:32:16 2009	(r5182)
@@ -22,7 +22,9 @@
 #define _OPENSYNC_TRACE_H
 
 /**
- * @defgroup OSyncDebugAPI OpenSync Debugging 
+ * @defgroup OSyncDebug OpenSync Debug Module
+ * @ingroup OSyncPublic
+ * @defgroup OSyncDebugAPI OpenSync Debug 
  * @ingroup OSyncDebug
  * @brief Functions for debugging
  */

Modified: trunk/opensync/helper/opensync_anchor_internals.h
==============================================================================
--- trunk/opensync/helper/opensync_anchor_internals.h	Sun Jan 18 09:51:07 2009	(r5181)
+++ trunk/opensync/helper/opensync_anchor_internals.h	Sun Jan 18 11:32:16 2009	(r5182)
@@ -22,9 +22,7 @@
 #define OPENSYNC_ANCHOR_INTERNALS_H_
 
 /**
- * @defgroup OSyncHelperInternals OpenSync Helper Module Internals
- * @ingroup OSyncPrivate
- * @defgroup OSyncAnchorInternalsAPI OpenSync Anchor Internals
+ * @defgroup OSyncAnchorInternalAPI OpenSync Anchor Internals
  * @ingroup OSyncHelperPrivate
  * @brief Internal functions to deal with anchors
  */