Menu
▾
▴
[Opensync-commits] r6001 - in trunk/opensync: client debug format group ipc
|
From: <svn...@op...> - 2010-01-10 19:11:49
|
Author: dgollub Date: Sun Jan 10 20:11:36 2010 New Revision: 6001 URL: http://www.opensync.org/changeset/6001 Log: Move all doxygen anotation from C-files to their header files. This is now complete for the opensync/ directory. fixes #898 Added: trunk/opensync/debug/opensync_trace_private.h - copied, changed from r5993, trunk/opensync/debug/opensync_trace.h Modified: trunk/opensync/client/opensync_client_proxy.c trunk/opensync/client/opensync_client_proxy_private.h trunk/opensync/debug/opensync_trace.c trunk/opensync/format/opensync_time.c trunk/opensync/format/opensync_time_internals.h trunk/opensync/group/opensync_member.c trunk/opensync/group/opensync_member_private.h trunk/opensync/ipc/opensync_queue.c trunk/opensync/ipc/opensync_queue_private.h Modified: trunk/opensync/client/opensync_client_proxy.c ============================================================================== --- trunk/opensync/client/opensync_client_proxy.c Sun Jan 10 20:02:37 2010 (r6000) +++ trunk/opensync/client/opensync_client_proxy.c Sun Jan 10 20:11:36 2010 (r6001) @@ -1243,18 +1243,6 @@ return FALSE; } -/** - * @brief Check if passed resource is valid. - * - * This check looks for: - * - are all format plugins in the format-sinks available - * - ... - * - * @param proxy Pointer to OSyncClientProxy - * @param resource Pointer to resource to check - * @param error The error which will hold the info of an invalid resource - * @return TRUE if valid, FALSE otherwise. - */ static osync_bool osync_client_proxy_check_resource(OSyncClientProxy *proxy, OSyncPluginResource *resource, OSyncError **error) { OSyncList *format_sinks = osync_plugin_resource_get_objformat_sinks(resource); Modified: trunk/opensync/client/opensync_client_proxy_private.h ============================================================================== --- trunk/opensync/client/opensync_client_proxy_private.h Sun Jan 10 20:02:37 2010 (r6000) +++ trunk/opensync/client/opensync_client_proxy_private.h Sun Jan 10 20:11:36 2010 (r6001) @@ -81,4 +81,18 @@ void osync_client_proxy_set_error(OSyncClientProxy *proxy, OSyncError *error); +/** + * @brief Check if passed resource is valid. + * + * This check looks for: + * - are all format plugins in the format-sinks available + * - ... + * + * @param proxy Pointer to OSyncClientProxy + * @param resource Pointer to resource to check + * @param error The error which will hold the info of an invalid resource + * @return TRUE if valid, FALSE otherwise. + */ +static osync_bool osync_client_proxy_check_resource(OSyncClientProxy *proxy, OSyncPluginResource *resource, OSyncError **error); + #endif /*OSYNC_CLIENT_PROXY_PRIVATE_H_*/ Modified: trunk/opensync/debug/opensync_trace.c ============================================================================== --- trunk/opensync/debug/opensync_trace.c Sun Jan 10 20:02:37 2010 (r6000) +++ trunk/opensync/debug/opensync_trace.c Sun Jan 10 20:11:36 2010 (r6001) @@ -23,6 +23,8 @@ #include "opensync.h" #include "opensync_internals.h" +#include "opensync_trace_private.h" + GPrivate* current_tabs = NULL; GPrivate* thread_id = NULL; GPrivate* trace_disabled = NULL; @@ -68,9 +70,6 @@ #ifdef OPENSYNC_TRACE -/*! @brief Initailize tracing - * - */ static void _osync_trace_init() { const char *noprivacy; Copied and modified: trunk/opensync/debug/opensync_trace_private.h (from r5993, trunk/opensync/debug/opensync_trace.h) ============================================================================== --- trunk/opensync/debug/opensync_trace.h Sun Jan 10 19:03:23 2010 (r5993, copy source) +++ trunk/opensync/debug/opensync_trace_private.h Sun Jan 10 20:11:36 2010 (r6001) @@ -1,6 +1,7 @@ /* * libopensync - A synchronization framework * Copyright (C) 2004-2005 Armin Bauer <arm...@op...> + * Copyright (C) 2010 Daniel Gollub <go...@b1...> * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public @@ -18,73 +19,24 @@ * */ -#ifndef _OPENSYNC_TRACE_H -#define _OPENSYNC_TRACE_H +#ifndef _OPENSYNC_TRACE_PRIVATE_H +#define _OPENSYNC_TRACE_PRIVATE_H /** * @defgroup OSyncDebug OpenSync Debug Module - * @ingroup OSyncPublic - * @defgroup OSyncDebugAPI OpenSync Debug + * @ingroup OSyncPrivate + * @defgroup OSyncDebugPrivateAPI OpenSync Debug * @ingroup OSyncDebug * @brief Functions for debugging */ /*@{*/ -/*! @brief The type of the trace +/*! @brief Initailize tracing * */ -typedef enum { - /** Used when entering a function. This will indent the callgraph */ - TRACE_ENTRY, - /** Used when exiting a function. This will unindent the callgraph */ - TRACE_EXIT, - /** Used for traces inside a function. Does not indent. */ - TRACE_INTERNAL, - /** Used for traces with sensitive content inside a function. Does not indent. */ - TRACE_SENSITIVE, - /** Used when exiting a function with a error. This will unindent the callgraph */ - TRACE_EXIT_ERROR, - /** Used to log a general error. This will not unindent the callgraph */ - TRACE_ERROR -} OSyncTraceType; - - -/*! @brief Reset the indentation of the trace function. - * - * Use this function after when process got forked. It's up to the forked - * process (child) to reset the indent. - * - */ -OSYNC_EXPORT void osync_trace_reset_indent(void); - -/*! @brief Used for tracing the application - * - * use this function to trace calls. The call graph will be saved into - * the file that is given in the OSYNC_TRACE environment variable - * - * @param type The type of the trace - * @param message The message to save - * - */ -OSYNC_EXPORT void osync_trace(OSyncTraceType type, const char *message, ...) GCC_FORMAT_CHECK(2, 3); - -/*! @brief Disable tracing - * - */ -OSYNC_EXPORT void osync_trace_disable(void); - -/*! @brief Enable tracing - * - */ -OSYNC_EXPORT void osync_trace_enable(void); - -/*! @brief Is tracing enabled? - * - * @returns TRUE if tracing is enabled, FALSE if disabled. - */ -OSYNC_EXPORT osync_bool osync_trace_is_enabled(void); +static void _osync_trace_init(); /*@} */ -#endif /* _OPENSYNC_TRACE_H */ +#endif /* _OPENSYNC_TRACE_PRIVATE_H */ Modified: trunk/opensync/format/opensync_time.c ============================================================================== --- trunk/opensync/format/opensync_time.c Sun Jan 10 20:02:37 2010 (r6000) +++ trunk/opensync/format/opensync_time.c Sun Jan 10 20:11:36 2010 (r6001) @@ -146,18 +146,6 @@ } #if 0 -/*! @brief Function sets the time of vtime timestamp to the given time parameter - * - * If vtime only stores date (without THHMMSS[Z]) parameter time will - * appended. The is_utc append a Z (Zulu) for UTC if not present. - * - * Mainly used for workarounds. - * - * @param vtime The original data-timestamp which gets modified - * @param time The time which should be set - * @param is_utc If the given time is UTC is_utc have to be TRUE - * @returns data-timestamp in UTC if is_utc TRUE - */ char *osync_time_set_vtime(const char *vtime, const char *time, osync_bool is_utc) { char *tmp = NULL; Modified: trunk/opensync/format/opensync_time_internals.h ============================================================================== --- trunk/opensync/format/opensync_time_internals.h Sun Jan 10 20:02:37 2010 (r6000) +++ trunk/opensync/format/opensync_time_internals.h Sun Jan 10 20:11:36 2010 (r6001) @@ -31,6 +31,21 @@ OSYNC_TEST_EXPORT inline struct tm* localtime_r (const time_t *clock, struct tm *result); #endif /* _WIN32 */ +#if 0 +/*! @brief Function sets the time of vtime timestamp to the given time parameter + * + * If vtime only stores date (without THHMMSS[Z]) parameter time will + * appended. The is_utc append a Z (Zulu) for UTC if not present. + * + * Mainly used for workarounds. + * + * @param vtime The original data-timestamp which gets modified + * @param time The time which should be set + * @param is_utc If the given time is UTC is_utc have to be TRUE + * @returns data-timestamp in UTC if is_utc TRUE + */ +char *osync_time_set_vtime(const char *vtime, const char *time, osync_bool is_utc); +#endif /* 0 */ #endif /* _OPENSYNC_TIME_INTERNALS_H_ */ Modified: trunk/opensync/group/opensync_member.c ============================================================================== --- trunk/opensync/group/opensync_member.c Sun Jan 10 20:02:37 2010 (r6000) +++ trunk/opensync/group/opensync_member.c Sun Jan 10 20:11:36 2010 (r6001) @@ -774,13 +774,6 @@ osync_objtype_sink_ref(sink); } -// FIXME this procedure does not seem to be referred to anywhere... -/** @brief Remove an OSyncObjTypeSink object to the member list of supported object types of this member - * - * @param member The member pointer - * @param sink The OSyncObjTypeSink object to add - * - */ void osync_member_remove_objtype_sink(OSyncMember *member, OSyncObjTypeSink *sink) { osync_assert(member); Modified: trunk/opensync/group/opensync_member_private.h ============================================================================== --- trunk/opensync/group/opensync_member_private.h Sun Jan 10 20:02:37 2010 (r6000) +++ trunk/opensync/group/opensync_member_private.h Sun Jan 10 20:11:36 2010 (r6001) @@ -48,6 +48,15 @@ */ static OSyncObjTypeSink *osync_member_parse_objtype(xmlNode *cur, OSyncError **error); +// FIXME this procedure does not seem to be referred to anywhere... +/** @brief Remove an OSyncObjTypeSink object to the member list of supported object types of this member + * + * @param member The member pointer + * @param sink The OSyncObjTypeSink object to add + * + */ +void osync_member_remove_objtype_sink(OSyncMember *member, OSyncObjTypeSink *sink); + /*@}*/ #endif /* _OPENSYNC_MEMBER_PRIVATE_H_ */ Modified: trunk/opensync/ipc/opensync_queue.c ============================================================================== --- trunk/opensync/ipc/opensync_queue.c Sun Jan 10 20:02:37 2010 (r6000) +++ trunk/opensync/ipc/opensync_queue.c Sun Jan 10 20:11:36 2010 (r6001) @@ -764,14 +764,6 @@ } -/** @brief Flush all message of the Queue - * - * Flush all message inside the Queue and dereference the messages. - * - * @param queue The queue to flush - * - */ - static void _osync_queue_flush_messages(GAsyncQueue *queue) { OSyncMessage *message; Modified: trunk/opensync/ipc/opensync_queue_private.h ============================================================================== --- trunk/opensync/ipc/opensync_queue_private.h Sun Jan 10 20:02:37 2010 (r6000) +++ trunk/opensync/ipc/opensync_queue_private.h Sun Jan 10 20:11:36 2010 (r6001) @@ -153,6 +153,15 @@ * */ static long long int opensync_queue_gen_id(const GTimeVal *tv); +/** @brief Flush all message of the Queue + * + * Flush all message inside the Queue and dereference the messages. + * + * @param queue The queue to flush + * + */ +static void _osync_queue_flush_messages(GAsyncQueue *queue); + /*@}*/ #endif /* _OPENSYNC_QUEUE_PRIVATE_H */ |
