Menu
▾
▴
[Opensync-commits] r5053 - trunk/opensync/plugin
|
From: <dg...@su...> - 2009-01-08 10:48:27
|
Author: bricks Date: Thu Jan 8 11:47:50 2009 New Revision: 5053 URL: http://www.opensync.org/changeset/5053 Log: Changed and added doxygen groups of plugin module Modified: trunk/opensync/plugin/opensync_context.h trunk/opensync/plugin/opensync_objtype_sink.h trunk/opensync/plugin/opensync_plugin_advancedoptions.h trunk/opensync/plugin/opensync_plugin_authentication.h trunk/opensync/plugin/opensync_plugin_config.h trunk/opensync/plugin/opensync_plugin_connection.h trunk/opensync/plugin/opensync_plugin_env.h trunk/opensync/plugin/opensync_plugin_info.h trunk/opensync/plugin/opensync_plugin_localization.h trunk/opensync/plugin/opensync_plugin_resource.h Modified: trunk/opensync/plugin/opensync_context.h ============================================================================== --- trunk/opensync/plugin/opensync_context.h Thu Jan 8 09:15:39 2009 (r5052) +++ trunk/opensync/plugin/opensync_context.h Thu Jan 8 11:47:50 2009 (r5053) @@ -23,6 +23,14 @@ OPENSYNC_BEGIN_DECLS +/** + * @defgroup OSyncContextAPI OpenSync Context + * @ingroup OSyncPlugin + * Public part of OpenSync Context + */ + +/*@{*/ + typedef void (* OSyncContextCallbackFn)(void *, OSyncError *); typedef void (* OSyncContextChangeFn) (OSyncChange *, void *); @@ -41,6 +49,8 @@ OSYNC_EXPORT void osync_context_report_osyncwarning(OSyncContext *context, OSyncError *error); OSYNC_EXPORT void osync_context_report_change(OSyncContext *context, OSyncChange *change); +/*@}*/ + OPENSYNC_END_DECLS #endif //_OPENSYNC_CONTEXT_H Modified: trunk/opensync/plugin/opensync_objtype_sink.h ============================================================================== --- trunk/opensync/plugin/opensync_objtype_sink.h Thu Jan 8 09:15:39 2009 (r5052) +++ trunk/opensync/plugin/opensync_objtype_sink.h Thu Jan 8 11:47:50 2009 (r5053) @@ -23,7 +23,7 @@ /** * @defgroup OSyncObjTypeSinkAPI OpenSync Object Type Sink - * @ingroup OSyncPublic + * @ingroup OSyncPlugin * @brief Functions to register and manage object type sinks * */ @@ -53,7 +53,7 @@ OSyncSinkConnectDoneFn connect_done; } OSyncObjTypeSinkFunctions; -/*! @brief Creates a new main sink +/** @brief Creates a new main sink * * Main sink is objtype neutral and should be used for object type * neutral actions. Actions like connecting/disconnecting which could @@ -68,7 +68,7 @@ */ OSYNC_EXPORT OSyncObjTypeSink *osync_objtype_main_sink_new(OSyncError **error); -/*! @brief Creates a new sink for an object type +/** @brief Creates a new sink for an object type * * @param objtype The name of the object type for the sink * @param error Pointer to an error struct @@ -76,21 +76,21 @@ */ OSYNC_EXPORT OSyncObjTypeSink *osync_objtype_sink_new(const char *objtype, OSyncError **error); -/*! @brief Increase the reference count on a sink +/** @brief Increase the reference count on a sink * * @param sink Pointer to the sink * */ OSYNC_EXPORT OSyncObjTypeSink *osync_objtype_sink_ref(OSyncObjTypeSink *sink); -/*! @brief Decrease the reference count on a sink +/** @brief Decrease the reference count on a sink * * @param sink Pointer to the sink * */ OSYNC_EXPORT void osync_objtype_sink_unref(OSyncObjTypeSink *sink); -/*! @brief Request an anchor for this Sink +/** @brief Request an anchor for this Sink * * If for this sink an anchor is required, this needs to be requested by this * function. If anchor gets enabled/requested inside the plugin, the framework @@ -105,7 +105,7 @@ */ OSYNC_EXPORT void osync_objtype_sink_enable_anchor(OSyncObjTypeSink *sink, osync_bool enable); -/*! @brief Get the pointer to the sink OSyncAnchor +/** @brief Get the pointer to the sink OSyncAnchor * * This Anchor is sink specific and can store persistent, sink specific data. * Originally designed to detect if a certain value changed since last @@ -119,7 +119,7 @@ OSYNC_EXPORT OSyncAnchor *osync_objtype_sink_get_anchor(OSyncObjTypeSink *sink); -/*! @brief Return the name of the object type of a sink +/** @brief Return the name of the object type of a sink * * @param sink Pointer to the sink * @returns the name of the object type of the specified sink @@ -128,7 +128,7 @@ OSYNC_EXPORT const char *osync_objtype_sink_get_name(OSyncObjTypeSink *sink); -/*! @brief Set the object type of a sink +/** @brief Set the object type of a sink * * @param sink Pointer to the sink * @param name the name of the object type to set @@ -137,7 +137,7 @@ OSYNC_EXPORT void osync_objtype_sink_set_name(OSyncObjTypeSink *sink, const char *name); -/*! @brief Return the preferred format for the conversion +/** @brief Return the preferred format for the conversion * * @param sink Pointer to the sink * @returns the name of the preferred format @@ -145,7 +145,7 @@ */ OSYNC_EXPORT const char *osync_objtype_sink_get_preferred_format(OSyncObjTypeSink *sink); -/*! @brief Set the preferred format for the conversion +/** @brief Set the preferred format for the conversion * * @param sink Pointer to the sink * @param preferred_format the name of the preferred format to set @@ -154,7 +154,7 @@ OSYNC_EXPORT void osync_objtype_sink_set_preferred_format(OSyncObjTypeSink *sink, const char *preferred_format); -/*! @brief Returns the number of object formats in the sink +/** @brief Returns the number of object formats in the sink * * @param sink Pointer to the sink * @returns the number of object formats in the sink @@ -162,7 +162,7 @@ */ OSYNC_EXPORT unsigned int osync_objtype_sink_num_objformat_sinks(OSyncObjTypeSink *sink); -/*! @brief Returns the nth object format in the sink +/** @brief Returns the nth object format in the sink * * @param sink Pointer to the sink * @param nth the index of the object format to return @@ -171,7 +171,7 @@ */ OSYNC_EXPORT OSyncObjFormatSink *osync_objtype_sink_nth_objformat_sink(OSyncObjTypeSink *sink, unsigned int nth); -/*! @brief Finds the objformat sink for the corresponding objformat +/** @brief Finds the objformat sink for the corresponding objformat * * @param sink Pointer to the sink * @param objformat the objformat to look for the corresponding objformat sink @@ -180,7 +180,7 @@ */ OSYNC_EXPORT OSyncObjFormatSink *osync_objtype_sink_find_objformat_sink(OSyncObjTypeSink *sink, OSyncObjFormat *objformat); -/*! @brief Get list of object format sinks +/** @brief Get list of object format sinks * * @param sink Pointer to the sink * @returns List of object format sinks @@ -230,7 +230,7 @@ OSYNC_EXPORT void *osync_objtype_sink_get_userdata(OSyncObjTypeSink *sink); -/*! @brief Checks if a sink is enabled +/** @brief Checks if a sink is enabled * * @param sink Pointer to the sink * @returns TRUE if the sink is enabled, FALSE otherwise @@ -238,7 +238,7 @@ */ OSYNC_EXPORT osync_bool osync_objtype_sink_is_enabled(OSyncObjTypeSink *sink); -/*! @brief Sets the enabled/disabled state of a sink +/** @brief Sets the enabled/disabled state of a sink * * @param sink Pointer to the sink * @param enabled TRUE if the sink is enabled, FALSE otherwise @@ -247,7 +247,7 @@ OSYNC_EXPORT void osync_objtype_sink_set_enabled(OSyncObjTypeSink *sink, osync_bool enabled); -/*! @brief Checks if a sink is available +/** @brief Checks if a sink is available * * @param sink Pointer to the sink * @returns TRUE if the sink is available, FALSE otherwise @@ -255,7 +255,7 @@ */ OSYNC_EXPORT osync_bool osync_objtype_sink_is_available(OSyncObjTypeSink *sink); -/*! @brief Sets the available state of a sink +/** @brief Sets the available state of a sink * * @param sink Pointer to the sink * @param available TRUE if the sink is available, FALSE otherwise @@ -264,7 +264,7 @@ OSYNC_EXPORT void osync_objtype_sink_set_available(OSyncObjTypeSink *sink, osync_bool available); -/*! @brief Checks if sink is allowed to write (commit) +/** @brief Checks if sink is allowed to write (commit) * * If the sink is not allowed to write, then no changes will be commited to * the sink. @@ -274,7 +274,7 @@ */ OSYNC_EXPORT osync_bool osync_objtype_sink_get_write(OSyncObjTypeSink *sink); -/*! @brief Sets the write status of the sink (commit) +/** @brief Sets the write status of the sink (commit) * * See osync_objtype_sink_get_write() * @@ -285,7 +285,7 @@ OSYNC_EXPORT void osync_objtype_sink_set_write(OSyncObjTypeSink *sink, osync_bool write); -/*! @brief Checks if sink is allowed to get latest changes +/** @brief Checks if sink is allowed to get latest changes * * @param sink Pointer to the sink * @returns TRUE if the sink is allowed to get latest changed entries, FALSE otherwise @@ -293,7 +293,7 @@ */ OSYNC_EXPORT osync_bool osync_objtype_sink_get_getchanges(OSyncObjTypeSink *sink); -/*! @brief Sets the get latest changes status of the sink (get_change) +/** @brief Sets the get latest changes status of the sink (get_change) * * See osync_objtype_sink_get_getchanges() * @@ -304,7 +304,7 @@ OSYNC_EXPORT void osync_objtype_sink_set_getchanges(OSyncObjTypeSink *sink, osync_bool getchanges); -/*! @brief Checks if sink is allowed to read single entries +/** @brief Checks if sink is allowed to read single entries * * "Read" means to request a single entry and does not mean to get the * latest changes since last sink. See osync_objtype_sink_get_getchanges(). @@ -319,7 +319,7 @@ */ OSYNC_EXPORT osync_bool osync_objtype_sink_get_read(OSyncObjTypeSink *sink); -/*! @brief Sets the (single) read status of a sink +/** @brief Sets the (single) read status of a sink * * See osync_objtype_sink_get_read() * @@ -330,7 +330,7 @@ OSYNC_EXPORT void osync_objtype_sink_set_read(OSyncObjTypeSink *sink, osync_bool read); -/*! @brief Checks if slow-sync has been requested +/** @brief Checks if slow-sync has been requested * * When slow-sync is requested, OpenSync synchronizes all entries rather than * just the changes. @@ -347,7 +347,7 @@ */ OSYNC_EXPORT osync_bool osync_objtype_sink_get_slowsync(OSyncObjTypeSink *sink); -/*! @brief Sets the slow-sync state of a sink +/** @brief Sets the slow-sync state of a sink * * When slow-sync is requested, OpenSync synchronizes all entries rather than * just the changes. @@ -463,7 +463,7 @@ OSYNC_EXPORT void osync_objtype_sink_committed_all(OSyncObjTypeSink *sink, void *plugindata, OSyncPluginInfo *info, OSyncContext *ctx); -/*! @brief Sets the connect timeout in seconds for the OSyncObjTypeSink +/** @brief Sets the connect timeout in seconds for the OSyncObjTypeSink * * @param sink Pointer to the sink * @param timeout The timeout in seconds @@ -471,7 +471,7 @@ */ OSYNC_EXPORT void osync_objtype_sink_set_connect_timeout(OSyncObjTypeSink *sink, unsigned int timeout); -/*! @brief Sets the disconnect timeout in seconds for the OSyncObjTypeSink +/** @brief Sets the disconnect timeout in seconds for the OSyncObjTypeSink * * @param sink Pointer to the sink * @param timeout The timeout in seconds @@ -479,7 +479,7 @@ */ OSYNC_EXPORT void osync_objtype_sink_set_disconnect_timeout(OSyncObjTypeSink *sink, unsigned int timeout); -/*! @brief Sets the get_changes timeout in seconds for the OSyncObjTypeSink +/** @brief Sets the get_changes timeout in seconds for the OSyncObjTypeSink * * @param sink Pointer to the sink * @param timeout The timeout in seconds @@ -487,7 +487,7 @@ */ OSYNC_EXPORT void osync_objtype_sink_set_getchanges_timeout(OSyncObjTypeSink *sink, unsigned int timeout); -/*! @brief Sets the commit timeout in seconds for the OSyncObjTypeSink +/** @brief Sets the commit timeout in seconds for the OSyncObjTypeSink * * @param sink Pointer to the sink * @param timeout The timeout in seconds @@ -495,7 +495,7 @@ */ OSYNC_EXPORT void osync_objtype_sink_set_commit_timeout(OSyncObjTypeSink *sink, unsigned int timeout); -/*! @brief Sets the batchcommit timeout in seconds for the OSyncObjTypeSink +/** @brief Sets the batchcommit timeout in seconds for the OSyncObjTypeSink * * @param sink Pointer to the sink * @param timeout The timeout in seconds @@ -503,7 +503,7 @@ */ OSYNC_EXPORT void osync_objtype_sink_set_batchcommit_timeout(OSyncObjTypeSink *sink, unsigned int timeout); -/*! @brief Sets the committedall timeout in seconds for the OSyncObjTypeSink +/** @brief Sets the committedall timeout in seconds for the OSyncObjTypeSink * * @param sink Pointer to the sink * @param timeout The timeout in seconds @@ -511,7 +511,7 @@ */ OSYNC_EXPORT void osync_objtype_sink_set_committedall_timeout(OSyncObjTypeSink *sink, unsigned int timeout); -/*! @brief Sets the syncdone timeout in seconds for the OSyncObjTypeSink +/** @brief Sets the syncdone timeout in seconds for the OSyncObjTypeSink * * @param sink Pointer to the sink * @param timeout The timeout in seconds @@ -519,7 +519,7 @@ */ OSYNC_EXPORT void osync_objtype_sink_set_syncdone_timeout(OSyncObjTypeSink *sink, unsigned int timeout); -/*! @brief Sets the write timeout in seconds for the OSyncObjTypeSink +/** @brief Sets the write timeout in seconds for the OSyncObjTypeSink * * @param sink Pointer to the sink * @param timeout The timeout in seconds @@ -527,7 +527,7 @@ */ OSYNC_EXPORT void osync_objtype_sink_set_write_timeout(OSyncObjTypeSink *sink, unsigned int timeout); -/*! @brief Sets the read timeout in seconds for the OSyncObjTypeSink +/** @brief Sets the read timeout in seconds for the OSyncObjTypeSink * * @param sink Pointer to the sink * @param timeout The timeout in seconds Modified: trunk/opensync/plugin/opensync_plugin_advancedoptions.h ============================================================================== --- trunk/opensync/plugin/opensync_plugin_advancedoptions.h Thu Jan 8 09:15:39 2009 (r5052) +++ trunk/opensync/plugin/opensync_plugin_advancedoptions.h Thu Jan 8 11:47:50 2009 (r5053) @@ -23,7 +23,7 @@ /** * @defgroup OSyncPluginConfigAdvancedOptionsAPI OpenSync Plugin Config Advanced Options - * @ingroup OSyncPublic + * @ingroup OSyncPlugin * @brief Functions to get and set a plugin's custom configuration options * * The AdvancedOptions system allows plugins to store custom (plugin-specific) @@ -37,7 +37,7 @@ /*@{*/ -/*! @brief Advanced option value types +/** @brief Advanced option value types * **/ typedef enum { @@ -69,7 +69,7 @@ OSYNC_EXPORT OSyncPluginAdvancedOptionType osync_plugin_advancedoption_type_string_to_val(const char *typestr); /* OSyncPluginAdvancedOption */ -/*! @brief Create a new OSyncPluginAdvancedOption object +/** @brief Create a new OSyncPluginAdvancedOption object * * @param error Pointer to an error struct * @returns the newly created object, or NULL in case of an error. @@ -77,14 +77,14 @@ */ OSYNC_EXPORT OSyncPluginAdvancedOption *osync_plugin_advancedoption_new(OSyncError **error); -/*! @brief Decrease the reference count on an OSyncPluginAdvancedOption object +/** @brief Decrease the reference count on an OSyncPluginAdvancedOption object * * @param option Pointer to the OSyncPluginAdvancedOption object * */ OSYNC_EXPORT void osync_plugin_advancedoption_unref(OSyncPluginAdvancedOption *option); -/*! @brief Increase the reference count on an OSyncPluginAdvancedOption object +/** @brief Increase the reference count on an OSyncPluginAdvancedOption object * * @param option Pointer to the OSyncPluginAdvancedOption object * @returns The OSyncPluginAdvancedOption object passed in @@ -93,7 +93,7 @@ OSYNC_EXPORT OSyncPluginAdvancedOption *osync_plugin_advancedoption_ref(OSyncPluginAdvancedOption *option); -/*! @brief Get a list of the parameters in an option +/** @brief Get a list of the parameters in an option * * @param option Pointer to the OSyncPluginAdvancedOption object * @returns the list of parameters @@ -101,7 +101,7 @@ */ OSYNC_EXPORT OSyncList *osync_plugin_advancedoption_get_parameters(OSyncPluginAdvancedOption *option); -/*! @brief Add a parameter to an option +/** @brief Add a parameter to an option * * @param option Pointer to the OSyncPluginAdvancedOption object * @param param the parameter to add @@ -109,7 +109,7 @@ */ OSYNC_EXPORT void osync_plugin_advancedoption_add_parameter(OSyncPluginAdvancedOption *option, OSyncPluginAdvancedOptionParameter *param); -/*! @brief Remove a parameter from an option +/** @brief Remove a parameter from an option * * @param option Pointer to the OSyncPluginAdvancedOption object * @param param the parameter to remove @@ -118,7 +118,7 @@ OSYNC_EXPORT void osync_plugin_advancedoption_remove_parameter(OSyncPluginAdvancedOption *option, OSyncPluginAdvancedOptionParameter *param); -/*! @brief Get the maximum value/length of an option +/** @brief Get the maximum value/length of an option * * @param option Pointer to the OSyncPluginAdvancedOption object * @returns the maximum value/length of the option @@ -126,7 +126,7 @@ */ OSYNC_EXPORT unsigned int osync_plugin_advancedoption_get_max(OSyncPluginAdvancedOption *option); -/*! @brief Set the maximum value/length of an option +/** @brief Set the maximum value/length of an option * * @param option Pointer to the OSyncPluginAdvancedOption object * @param max the maximum value/length to set @@ -135,7 +135,7 @@ OSYNC_EXPORT void osync_plugin_advancedoption_set_max(OSyncPluginAdvancedOption *option, unsigned int max); -/*! @brief Get the minimum value/length of an option +/** @brief Get the minimum value/length of an option * * @param option Pointer to the OSyncPluginAdvancedOption object * @returns the minimum value/length of the option @@ -143,7 +143,7 @@ */ OSYNC_EXPORT unsigned int osync_plugin_advancedoption_get_min(OSyncPluginAdvancedOption *option); -/*! @brief Set the minimum value/length of an option +/** @brief Set the minimum value/length of an option * * @param option Pointer to the OSyncPluginAdvancedOption object * @param min the minimum value/length to set @@ -156,7 +156,7 @@ OSYNC_EXPORT void osync_plugin_advancedoption_set_maxoccurs(OSyncPluginAdvancedOption *option, unsigned int maxoccurs); -/*! @brief Get the display name of an option +/** @brief Get the display name of an option * * The display name is intended to be shown in the configuration user interface for the option. * @@ -166,7 +166,7 @@ */ OSYNC_EXPORT const char *osync_plugin_advancedoption_get_displayname(OSyncPluginAdvancedOption *option); -/*! @brief Set the display name of an option +/** @brief Set the display name of an option * * The display name is intended to be shown in the configuration user interface for the option. * @@ -177,7 +177,7 @@ OSYNC_EXPORT void osync_plugin_advancedoption_set_displayname(OSyncPluginAdvancedOption *option, const char *displayname); -/*! @brief Get the name of an option +/** @brief Get the name of an option * * This name is intended as an internal identifier for the option. It should not be shown in the user interface. * @@ -187,7 +187,7 @@ */ OSYNC_EXPORT const char *osync_plugin_advancedoption_get_name(OSyncPluginAdvancedOption *option); -/*! @brief Set the name of an option +/** @brief Set the name of an option * * This name is intended as an internal identifier for the option. It should not be shown in the user interface. * @@ -198,7 +198,7 @@ OSYNC_EXPORT void osync_plugin_advancedoption_set_name(OSyncPluginAdvancedOption *option, const char *name); -/*! @brief Get the value type of an option +/** @brief Get the value type of an option * * @param option Pointer to the OSyncPluginAdvancedOption object * @returns the value type of the option @@ -206,7 +206,7 @@ */ OSYNC_EXPORT OSyncPluginAdvancedOptionType osync_plugin_advancedoption_get_type(OSyncPluginAdvancedOption *option); -/*! @brief Get the value type of an option (as text) +/** @brief Get the value type of an option (as text) * * @param option Pointer to the OSyncPluginAdvancedOption object * @returns a string representing the value type of the option @@ -214,7 +214,7 @@ */ OSYNC_EXPORT const char *osync_plugin_advancedoption_get_type_string(OSyncPluginAdvancedOption *option); -/*! @brief Set the value type of an option +/** @brief Set the value type of an option * * @param option Pointer to the OSyncPluginAdvancedOption object * @param type the value type to set @@ -223,7 +223,7 @@ OSYNC_EXPORT void osync_plugin_advancedoption_set_type(OSyncPluginAdvancedOption *option, OSyncPluginAdvancedOptionType type); -/*! @brief Get a list of the enumerated values of an option +/** @brief Get a list of the enumerated values of an option * * For options which accept only a set list of possible values (i.e. an enumeration) this function * returns a list of the possible values. @@ -234,7 +234,7 @@ */ OSYNC_EXPORT OSyncList *osync_plugin_advancedoption_get_valenums(OSyncPluginAdvancedOption *option); -/*! @brief Add an enumerated value to an option +/** @brief Add an enumerated value to an option * * @param option Pointer to the OSyncPluginAdvancedOption object * @param value the value to add to the enumeration @@ -242,7 +242,7 @@ */ OSYNC_EXPORT void osync_plugin_advancedoption_add_valenum(OSyncPluginAdvancedOption *option, const char *value); -/*! @brief Remove an enumerated value from an option +/** @brief Remove an enumerated value from an option * * @param option Pointer to the OSyncPluginAdvancedOption object * @param value the value to remove from the enumeration @@ -251,7 +251,7 @@ OSYNC_EXPORT void osync_plugin_advancedoption_remove_valenum(OSyncPluginAdvancedOption *option, const char *value); -/*! @brief Set the value of an option +/** @brief Set the value of an option * * @param option Pointer to the OSyncPluginAdvancedOption object * @param value the value to set (as a null-terminated string) @@ -259,7 +259,7 @@ */ OSYNC_EXPORT void osync_plugin_advancedoption_set_value(OSyncPluginAdvancedOption *option, const char *value); -/*! @brief Get the value of an option +/** @brief Get the value of an option * * @param option Pointer to the OSyncPluginAdvancedOption object * @returns the value of the option (as a null-terminated string) @@ -269,7 +269,7 @@ /* OSyncPluginAdvancedOptionParameter */ -/*! @brief Create a new OSyncPluginAdvancedOptionParameter object +/** @brief Create a new OSyncPluginAdvancedOptionParameter object * * @param error Pointer to an error struct * @returns the newly created object, or NULL in case of an error. @@ -277,14 +277,14 @@ */ OSYNC_EXPORT OSyncPluginAdvancedOptionParameter *osync_plugin_advancedoption_param_new(OSyncError **error); -/*! @brief Decrease the reference count on an OSyncPluginAdvancedOptionParameter object +/** @brief Decrease the reference count on an OSyncPluginAdvancedOptionParameter object * * @param param Pointer to the OSyncPluginAdvancedOptionParameter object * */ OSYNC_EXPORT void osync_plugin_advancedoption_param_unref(OSyncPluginAdvancedOptionParameter *param); -/*! @brief Increase the reference count on an OSyncPluginAdvancedOptionParameter object +/** @brief Increase the reference count on an OSyncPluginAdvancedOptionParameter object * * @param param Pointer to the OSyncPluginAdvancedOptionParameter object * @returns The OSyncPluginAdvancedOptionParameter object passed in @@ -293,7 +293,7 @@ OSYNC_EXPORT OSyncPluginAdvancedOptionParameter *osync_plugin_advancedoption_param_ref(OSyncPluginAdvancedOptionParameter *param); -/*! @brief Get the display name of a parameter +/** @brief Get the display name of a parameter * * The display name is intended to be shown in the configuration user interface for the parameter. * @@ -303,7 +303,7 @@ */ OSYNC_EXPORT const char *osync_plugin_advancedoption_param_get_displayname(OSyncPluginAdvancedOptionParameter *param); -/*! @brief Set the display name of a parameter +/** @brief Set the display name of a parameter * * The display name is intended to be shown in the configuration user interface for the parameter. * @@ -314,7 +314,7 @@ OSYNC_EXPORT void osync_plugin_advancedoption_param_set_displayname(OSyncPluginAdvancedOptionParameter *param, const char *displayname); -/*! @brief Get the name of a parameter +/** @brief Get the name of a parameter * * This name is intended as an internal identifier for the parameter. It should not be shown in the user interface. * @@ -324,7 +324,7 @@ */ OSYNC_EXPORT const char *osync_plugin_advancedoption_param_get_name(OSyncPluginAdvancedOptionParameter *param); -/*! @brief Set the name of a parameter +/** @brief Set the name of a parameter * * This name is intended as an internal identifier for the parameter. It should not be shown in the user interface. * @@ -335,7 +335,7 @@ OSYNC_EXPORT void osync_plugin_advancedoption_param_set_name(OSyncPluginAdvancedOptionParameter *param, const char *name); -/*! @brief Get the value type of a parameter +/** @brief Get the value type of a parameter * * @param param Pointer to the OSyncPluginAdvancedOptionParameter object * @returns the value type of the parameter @@ -343,7 +343,7 @@ */ OSYNC_EXPORT OSyncPluginAdvancedOptionType osync_plugin_advancedoption_param_get_type(OSyncPluginAdvancedOptionParameter *param); -/*! @brief Get the value type of a parameter (as text) +/** @brief Get the value type of a parameter (as text) * * @param param Pointer to the OSyncPluginAdvancedOptionParameter object * @returns a string representing the value type of the parameter @@ -351,7 +351,7 @@ */ OSYNC_EXPORT const char *osync_plugin_advancedoption_param_get_type_string(OSyncPluginAdvancedOptionParameter *param); -/*! @brief Set the value type of a parameter +/** @brief Set the value type of a parameter * * @param param Pointer to the OSyncPluginAdvancedOptionParameter object * @param type the value type to set @@ -359,7 +359,7 @@ */ OSYNC_EXPORT void osync_plugin_advancedoption_param_set_type(OSyncPluginAdvancedOptionParameter *param, OSyncPluginAdvancedOptionType type); -/*! @brief Get a list of the enumerated values of a parameter +/** @brief Get a list of the enumerated values of a parameter * * For parameters which accept only a set list of possible values (i.e. an enumeration) this function * returns a list of the possible values. @@ -370,7 +370,7 @@ */ OSYNC_EXPORT OSyncList *osync_plugin_advancedoption_param_get_valenums(OSyncPluginAdvancedOptionParameter *param); -/*! @brief Add an enumerated value to a parameter +/** @brief Add an enumerated value to a parameter * * @param param Pointer to the OSyncPluginAdvancedOptionParameter object * @param value the value to add to the enumeration @@ -378,7 +378,7 @@ */ OSYNC_EXPORT void osync_plugin_advancedoption_param_add_valenum(OSyncPluginAdvancedOptionParameter *param, const char *value); -/*! @brief Remove an enumerated value from a parameter +/** @brief Remove an enumerated value from a parameter * * @param param Pointer to the OSyncPluginAdvancedOptionParameter object * @param value the value to remove from the enumeration @@ -387,7 +387,7 @@ OSYNC_EXPORT void osync_plugin_advancedoption_param_remove_valenum(OSyncPluginAdvancedOptionParameter *param, const char *value); -/*! @brief Set the value of a parameter +/** @brief Set the value of a parameter * * @param param Pointer to the OSyncPluginAdvancedOptionParameter object * @param value the value to set (as a null-terminated string) @@ -395,7 +395,7 @@ */ OSYNC_EXPORT void osync_plugin_advancedoption_param_set_value(OSyncPluginAdvancedOptionParameter *param, const char *value); -/*! @brief Get the value of a parameter +/** @brief Get the value of a parameter * * @param param Pointer to the OSyncPluginAdvancedOptionParameter object * @returns the value of the option (as a null-terminated string) Modified: trunk/opensync/plugin/opensync_plugin_authentication.h ============================================================================== --- trunk/opensync/plugin/opensync_plugin_authentication.h Thu Jan 8 09:15:39 2009 (r5052) +++ trunk/opensync/plugin/opensync_plugin_authentication.h Thu Jan 8 11:47:50 2009 (r5053) @@ -23,13 +23,13 @@ /** * @defgroup OSyncPluginAuthAPI OpenSync Plugin Authentication - * @ingroup OSyncPublic + * @ingroup OSyncPlugin * @brief Functions for configuring plugin authentication * */ /*@{*/ -/*! @brief Types of authentication options supported by a plugin +/** @brief Types of authentication options supported by a plugin * **/ typedef enum { @@ -41,12 +41,12 @@ OSYNC_PLUGIN_AUTHENTICATION_REFERENCE = (1 << 2), } OSyncPluginAuthenticationOptionSupportedFlag; -/*! @brief Set of OSyncPluginAuthenticationOptionSupportedFlags +/** @brief Set of OSyncPluginAuthenticationOptionSupportedFlags * **/ typedef unsigned int OSyncPluginAuthenticationOptionSupportedFlags; -/*! @brief Create a new OSyncPluginAuthentication object +/** @brief Create a new OSyncPluginAuthentication object * * @param error Pointer to an error struct * @returns the newly created object, or NULL in case of an error. @@ -54,14 +54,14 @@ */ OSYNC_EXPORT OSyncPluginAuthentication *osync_plugin_authentication_new(OSyncError **error); -/*! @brief Decrease the reference count on an OSyncPluginAuthentication object +/** @brief Decrease the reference count on an OSyncPluginAuthentication object * * @param auth Pointer to the OSyncPluginAuthentication object * */ OSYNC_EXPORT void osync_plugin_authentication_unref(OSyncPluginAuthentication *auth); -/*! @brief Increase the reference count on an OSyncPluginAuthentication object +/** @brief Increase the reference count on an OSyncPluginAuthentication object * * @param auth Pointer to the OSyncPluginAuthentication object * @returns The OSyncPluginAuthentication object passed in @@ -70,7 +70,7 @@ OSYNC_EXPORT OSyncPluginAuthentication *osync_plugin_authentication_ref(OSyncPluginAuthentication *auth); -/*! @brief Determine if an authentication option is supported by a plugin +/** @brief Determine if an authentication option is supported by a plugin * * @param auth Pointer to the OSyncPluginAuthentication object * @param flag Authentication option to check @@ -79,7 +79,7 @@ */ OSYNC_EXPORT osync_bool osync_plugin_authentication_option_is_supported(OSyncPluginAuthentication *auth, OSyncPluginAuthenticationOptionSupportedFlag flag); -/*! @brief Set the authentication options supported by a plugin +/** @brief Set the authentication options supported by a plugin * * @param auth Pointer to the OSyncPluginAuthentication object * @param flags Authentication option to check @@ -88,7 +88,7 @@ OSYNC_EXPORT void osync_plugin_authentication_option_set_supported(OSyncPluginAuthentication *auth, OSyncPluginAuthenticationOptionSupportedFlags flags); -/*! @brief Get the authentication username +/** @brief Get the authentication username * * @param auth Pointer to the OSyncPluginAuthentication object * @returns the username or NULL if not set @@ -96,7 +96,7 @@ */ OSYNC_EXPORT const char *osync_plugin_authentication_get_username(OSyncPluginAuthentication *auth); -/*! @brief Set the authentication username +/** @brief Set the authentication username * * @param auth Pointer to the OSyncPluginAuthentication object * @param username the username to set @@ -105,7 +105,7 @@ OSYNC_EXPORT void osync_plugin_authentication_set_username(OSyncPluginAuthentication *auth, const char *username); -/*! @brief Get the authentication password +/** @brief Get the authentication password * * @param auth Pointer to the OSyncPluginAuthentication object * @returns the username or NULL if not set @@ -113,7 +113,7 @@ */ OSYNC_EXPORT const char *osync_plugin_authentication_get_password(OSyncPluginAuthentication *auth); -/*! @brief Set the authentication password +/** @brief Set the authentication password * * WARNING: This password will be stored in plain text in the plugin configuration file. In * future versions of OpenSync, interfaces should be available to password databases @@ -127,7 +127,7 @@ OSYNC_EXPORT void osync_plugin_authentication_set_password(OSyncPluginAuthentication *auth, const char *password); -/*! @brief Get the authentication reference. +/** @brief Get the authentication reference. * * This reference is intended to be a key used to look up the password using some kind of * password storage system, such as KDE's KWallet or Gnome-keyring. As this is not yet @@ -139,7 +139,7 @@ */ OSYNC_EXPORT const char *osync_plugin_authentication_get_reference(OSyncPluginAuthentication *auth); -/*! @brief Set the authentication reference +/** @brief Set the authentication reference * * This reference is intended to be a key used to look up the password using some kind of * password storage system, such as KDE's KWallet or Gnome-keyring. As this is not yet Modified: trunk/opensync/plugin/opensync_plugin_config.h ============================================================================== --- trunk/opensync/plugin/opensync_plugin_config.h Thu Jan 8 09:15:39 2009 (r5052) +++ trunk/opensync/plugin/opensync_plugin_config.h Thu Jan 8 11:47:50 2009 (r5053) @@ -26,14 +26,14 @@ /** * @defgroup OSyncPluginConfigAPI OpenSync Plugin Config - * @ingroup OSyncPublic + * @ingroup OSyncPlugin * @brief Functions to get and set a plugin's configuration * */ /*@{*/ -/*! @brief Flags specifying the elements supported by a plugin config +/** @brief Flags specifying the elements supported by a plugin config * * @param error Pointer to and error struct * @returns the newly registered plugin config object @@ -51,25 +51,25 @@ OPENSYNC_PLUGIN_CONFIG_CONNECTION = (1 << 4) } OSyncPluginConfigSupportedFlag; -/*! @brief Set of OSyncPluginConfigSupportedFlags +/** @brief Set of OSyncPluginConfigSupportedFlags * **/ typedef unsigned int OSyncPluginConfigSupportedFlags; -/*! @brief Create a new plugin config object +/** @brief Create a new plugin config object * * @param error Pointer to and error struct * @returns the newly registered plugin config object */ OSYNC_EXPORT OSyncPluginConfig *osync_plugin_config_new(OSyncError **error); -/*! @brief Decrease the reference count on a plugin config object +/** @brief Decrease the reference count on a plugin config object * * @param config Pointer to the plugin config object */ OSYNC_EXPORT void osync_plugin_config_unref(OSyncPluginConfig *config); -/*! @brief Increase the reference count on a plugin config object +/** @brief Increase the reference count on a plugin config object * * @param config Pointer to the plugin config object * @returns the passed plugin config @@ -77,7 +77,7 @@ OSYNC_EXPORT OSyncPluginConfig *osync_plugin_config_ref(OSyncPluginConfig *config); -/*! @brief Load a plugin config file +/** @brief Load a plugin config file * * @param config Contents of config file as OsyncPluginConfig object * @param path Path to file to load @@ -86,7 +86,7 @@ */ OSYNC_EXPORT osync_bool osync_plugin_config_file_load(OSyncPluginConfig *config, const char *path, const char *schemadir, OSyncError **error); -/*! @brief Save a plugin config to a file +/** @brief Save a plugin config to a file * * @param config Plugin config to save * @param path Path to save file @@ -96,7 +96,7 @@ OSYNC_EXPORT osync_bool osync_plugin_config_file_save(OSyncPluginConfig *config, const char *path, OSyncError **error); -/*! @brief Check if a config element is supported by a config +/** @brief Check if a config element is supported by a config * * @param config Plugin config to check * @param flag The type of configuration element to check @@ -104,7 +104,7 @@ */ OSYNC_EXPORT osync_bool osync_plugin_config_is_supported(OSyncPluginConfig *config, OSyncPluginConfigSupportedFlag flag); -/*! @brief Sets the passed config element flags as supported by the config +/** @brief Sets the passed config element flags as supported by the config * * @param config An OsyncPluginConfig to modify * @param flags An OSyncPluginConfigSupportedFlags to set the flags to (merge or overwrite??) @@ -112,14 +112,14 @@ OSYNC_EXPORT void osync_plugin_config_set_supported(OSyncPluginConfig *config, OSyncPluginConfigSupportedFlags flags); /* Advanced Options */ -/*! @brief Get the advanced options from a config +/** @brief Get the advanced options from a config * * @param config An OSyncPluginConfig to get the advanced options from * @returns An OSyncList of OSyncPluginAdvancedOption s */ OSYNC_EXPORT OSyncList *osync_plugin_config_get_advancedoptions(OSyncPluginConfig *config); -/*!@brief Get an advanced option from the config by name +/**@brief Get an advanced option from the config by name * * @param config An OSyncPluginConfig to search * @param name The name of the advanced option to get @@ -127,14 +127,14 @@ */ OSYNC_EXPORT OSyncPluginAdvancedOption *osync_plugin_config_get_advancedoption_value_by_name(OSyncPluginConfig *config, const char *name); -/*!@brief Add an advanced option to a config +/**@brief Add an advanced option to a config * * @param config The config to add the option to * @param option the advanced option to add */ OSYNC_EXPORT void osync_plugin_config_add_advancedoption(OSyncPluginConfig *config, OSyncPluginAdvancedOption *option); -/*!@brief Remove an advanced option from a config +/**@brief Remove an advanced option from a config * * @param config An OSyncPluginConfig to remove from * @param option The advanced option to be removed @@ -142,14 +142,14 @@ OSYNC_EXPORT void osync_plugin_config_remove_advancedoption(OSyncPluginConfig *config, OSyncPluginAdvancedOption *option); /* Authentication */ -/*!@brief Get the authentication settings from a config +/**@brief Get the authentication settings from a config * * @param config An OSyncPluginConfig * @returns an OSyncPluginAuthentication with the details ?? or NULL if no authentication configured */ OSYNC_EXPORT OSyncPluginAuthentication *osync_plugin_config_get_authentication(OSyncPluginConfig *config); -/*!@brief Set the authentication configuration +/**@brief Set the authentication configuration * * @param config An OSyncPluginConfig * @param authentication The new authentication settings as an OSyncPluginAuthentication @@ -157,14 +157,14 @@ OSYNC_EXPORT void osync_plugin_config_set_authentication(OSyncPluginConfig *config, OSyncPluginAuthentication *authentication); /* Localization */ -/*!@brief Get the localization settings +/**@brief Get the localization settings * * @param config An OSyncPluginConfig * @returns the localization settings as an OSyncPluginLocalization */ OSYNC_EXPORT OSyncPluginLocalization *osync_plugin_config_get_localization(OSyncPluginConfig *config); -/*!@brief Set the localization settings +/**@brief Set the localization settings * * @param config An OSyncPluginConfig * @param localization An OSyncPluginLocalization containing the new localization settings @@ -172,14 +172,14 @@ OSYNC_EXPORT void osync_plugin_config_set_localization(OSyncPluginConfig *config, OSyncPluginLocalization *localization); /* Resources */ -/*!@brief Get the configured resources +/**@brief Get the configured resources * * @param config An OSyncPluginConfig * @returns a list of OSyncPluginResource */ OSYNC_EXPORT OSyncList *osync_plugin_config_get_resources(OSyncPluginConfig *config); -/*!@brief Find the active resource by object type +/**@brief Find the active resource by object type * * @param config An OSyncPluginConfig * @param objtype the object type to find the active resource for @@ -187,14 +187,14 @@ */ OSYNC_EXPORT OSyncPluginResource *osync_plugin_config_find_active_resource(OSyncPluginConfig *config, const char *objtype); -/*!@brief Add a resource to a config +/**@brief Add a resource to a config * * @param config An OSyncPluginConfig to add to * @param resource An OSyncPluginResource to add to the config */ OSYNC_EXPORT void osync_plugin_config_add_resource(OSyncPluginConfig *config, OSyncPluginResource *resource); -/*!@brief Remove a resource from a config +/**@brief Remove a resource from a config * * @param config An OSyncPluginConfig to remove from * @param resource The OSyncPluginResource to remove @@ -204,14 +204,14 @@ OSYNC_EXPORT void osync_plugin_config_flush_resources(OSyncPluginConfig *config); /* Connection */ -/*!@brief Get the connection settings from a config +/**@brief Get the connection settings from a config * * @param config An OSyncPluginConfig * @returns the connection settings as an OSyncPluginConnection */ OSYNC_EXPORT OSyncPluginConnection *osync_plugin_config_get_connection(OSyncPluginConfig *config); -/*!@brief Set the connection settings in a config +/**@brief Set the connection settings in a config * * @param config An OSyncPluginConfig * @param connection the connection settings as an OSyncPluginConnection Modified: trunk/opensync/plugin/opensync_plugin_connection.h ============================================================================== --- trunk/opensync/plugin/opensync_plugin_connection.h Thu Jan 8 09:15:39 2009 (r5052) +++ trunk/opensync/plugin/opensync_plugin_connection.h Thu Jan 8 11:47:50 2009 (r5053) @@ -23,14 +23,14 @@ /** * @defgroup OSyncPluginConnectionAPI OpenSync Plugin Connection Options - * @ingroup OSyncPublic + * @ingroup OSyncPlugin * @brief Functions to get and set a plugin's connection options * */ /*@{*/ -/*! @brief Connection type support flags +/** @brief Connection type support flags * **/ typedef enum { @@ -48,17 +48,17 @@ OSYNC_PLUGIN_CONNECTION_IRDA = (1 << 4) } OSyncPluginConnectionType; -/*! @brief Connection type +/** @brief Connection type * */ typedef OSyncPluginConnectionType OSyncPluginConnectionSupportedFlag; -/*! @brief Set of OSyncPluginConnectionType values +/** @brief Set of OSyncPluginConnectionType values * */ typedef unsigned int OSyncPluginConnectionSupportedFlags; -/*! @brief Connection option support flags +/** @brief Connection option support flags * */ typedef enum { @@ -90,12 +90,12 @@ OSYNC_PLUGIN_CONNECTION_IRDA_SERVICE = (1 << 12) } OSyncPluginConnectionOptionSupportedFlag; -/*! @brief Set of OSyncPluginConnectionOptionSupportedFlag values +/** @brief Set of OSyncPluginConnectionOptionSupportedFlag values * */ typedef unsigned int OSyncPluginConnectionOptionSupportedFlags; -/*! @brief Create a new OSyncPluginConnection object +/** @brief Create a new OSyncPluginConnection object * * @param error Pointer to an error struct * @returns the newly created object, or NULL in case of an error. @@ -103,14 +103,14 @@ */ OSYNC_EXPORT OSyncPluginConnection *osync_plugin_connection_new(OSyncError **error); -/*! @brief Decrease the reference count on an OSyncPluginConnection object +/** @brief Decrease the reference count on an OSyncPluginConnection object * * @param connection Pointer to the OSyncPluginConnection object * */ OSYNC_EXPORT void osync_plugin_connection_unref(OSyncPluginConnection *connection); -/*! @brief Increase the reference count on an OSyncPluginConnection object +/** @brief Increase the reference count on an OSyncPluginConnection object * * @param connection Pointer to the OSyncPluginConnection object * @returns The OSyncPluginConnection object passed in @@ -119,7 +119,7 @@ OSYNC_EXPORT OSyncPluginConnection *osync_plugin_connection_ref(OSyncPluginConnection *connection); -/*! @brief Get the type of a connection +/** @brief Get the type of a connection * * @param connection Pointer to the OSyncPluginConnection object * @returns The connection type @@ -127,7 +127,7 @@ */ OSYNC_EXPORT OSyncPluginConnectionType osync_plugin_connection_get_type(OSyncPluginConnection *connection); -/*! @brief Set the type of a connection +/** @brief Set the type of a connection * * @param connection Pointer to the OSyncPluginConnection object * @param type The connection type to set @@ -136,7 +136,7 @@ OSYNC_EXPORT void osync_plugin_connection_set_type(OSyncPluginConnection *connection, OSyncPluginConnectionType type); -/*! @brief Check if a type of connection is supported +/** @brief Check if a type of connection is supported * * @param connection Pointer to the OSyncPluginConnection object * @param flag The connection type to check @@ -145,7 +145,7 @@ */ OSYNC_EXPORT osync_bool osync_plugin_connection_is_supported(OSyncPluginConnection *connection, OSyncPluginConnectionSupportedFlag flag); -/*! @brief Set the types of a connection that are supported +/** @brief Set the types of a connection that are supported * * @param connection Pointer to the OSyncPluginConnection object * @param flags The set of connection types to set as supported @@ -154,7 +154,7 @@ OSYNC_EXPORT void osync_plugin_connection_set_supported(OSyncPluginConnection *connection, OSyncPluginConnectionSupportedFlags flags); -/*! @brief Check if a connection option is supported +/** @brief Check if a connection option is supported * * @param connection Pointer to the OSyncPluginConnection object * @param flag The connection option to check @@ -163,7 +163,7 @@ */ OSYNC_EXPORT osync_bool osync_plugin_connection_option_is_supported(OSyncPluginConnection *connection, OSyncPluginConnectionOptionSupportedFlag flag); -/*! @brief Set the connection options that are supported +/** @brief Set the connection options that are supported * * @param connection Pointer to the OSyncPluginConnection object * @param flags The set of connection options to set as supported @@ -174,7 +174,7 @@ /* Bluetooth */ -/*! @brief Get the Bluetooth address +/** @brief Get the Bluetooth address * * @param connection Pointer to the OSyncPluginConnection object * @returns The bluetooth address or NULL if not set @@ -183,7 +183,7 @@ OSYNC_EXPORT const char *osync_plugin_connection_bt_get_addr(OSyncPluginConnection *connection); -/*! @brief Set the Bluetooth address +/** @brief Set the Bluetooth address * * @param connection Pointer to the OSyncPluginConnection object * @param address The bluetooth address to set @@ -191,7 +191,7 @@ */ OSYNC_EXPORT void osync_plugin_connection_bt_set_addr(OSyncPluginConnection *connection, const char *address); -/*! @brief Get the Bluetooth RFCOMM channel +/** @brief Get the Bluetooth RFCOMM channel * * @param connection Pointer to the OSyncPluginConnection object * @returns The RFCOMM channel @@ -199,7 +199,7 @@ */ OSYNC_EXPORT unsigned int osync_plugin_connection_bt_get_channel(OSyncPluginConnection *connection); -/*! @brief Set the Bluetooth RFCOMM channel +/** @brief Set the Bluetooth RFCOMM channel * * @param connection Pointer to the OSyncPluginConnection object * @param channel The RFCOMM channel to set @@ -208,7 +208,7 @@ OSYNC_EXPORT void osync_plugin_connection_bt_set_channel(OSyncPluginConnection *connection, unsigned int channel); -/*! @brief Get the Bluetooth SDP UUID +/** @brief Get the Bluetooth SDP UUID * * @param connection Pointer to the OSyncPluginConnection object * @returns The SDP UUID or NULL if not set @@ -216,7 +216,7 @@ */ OSYNC_EXPORT const char *osync_plugin_connection_bt_get_sdpuuid(OSyncPluginConnection *connection); -/*! @brief Set the Bluetooth SDP UUID +/** @brief Set the Bluetooth SDP UUID * * @param connection Pointer to the OSyncPluginConnection object * @param sdpuuid The SDP UUID to set @@ -226,7 +226,7 @@ /* USB */ -/*! @brief Get the USB vendor ID +/** @brief Get the USB vendor ID * * @param connection Pointer to the OSyncPluginConnection object * @returns The USB vendor ID @@ -234,7 +234,7 @@ */ OSYNC_EXPORT const char *osync_plugin_connection_usb_get_vendorid(OSyncPluginConnection *connection); -/*! @brief Set the USB vendor ID +/** @brief Set the USB vendor ID * * @param connection Pointer to the OSyncPluginConnection object * @param vendorid The USB vendor ID to set @@ -243,7 +243,7 @@ OSYNC_EXPORT void osync_plugin_connection_usb_set_vendorid(OSyncPluginConnection *connection, const char *vendorid); -/*! @brief Get the USB product ID +/** @brief Get the USB product ID * * @param connection Pointer to the OSyncPluginConnection object * @returns The USB product ID @@ -251,7 +251,7 @@ */ OSYNC_EXPORT const char *osync_plugin_connection_usb_get_productid(OSyncPluginConnection *connection); -/*! @brief Set the USB product ID +/** @brief Set the USB product ID * * @param connection Pointer to the OSyncPluginConnection object * @param productid The USB product ID to set @@ -260,7 +260,7 @@ OSYNC_EXPORT void osync_plugin_connection_usb_set_productid(OSyncPluginConnection *connection, const char *productid); -/*! @brief Get the USB interface number +/** @brief Get the USB interface number * * @param connection Pointer to the OSyncPluginConnection object * @returns The USB interface number @@ -268,7 +268,7 @@ */ OSYNC_EXPORT unsigned int osync_plugin_connection_usb_get_interface(OSyncPluginConnection *connection); -/*! @brief Set the USB interface number +/** @brief Set the USB interface number * * @param connection Pointer to the OSyncPluginConnection object * @param interf The USB interface number to set @@ -279,7 +279,7 @@ /* Network */ -/*! @brief Get the network address (IP address or hostname) +/** @brief Get the network address (IP address or hostname) * * @param connection Pointer to the OSyncPluginConnection object * @returns The network address @@ -287,7 +287,7 @@ */ OSYNC_EXPORT const char *osync_plugin_connection_net_get_address(OSyncPluginConnection *connection); -/*! @brief Set the network address (IP address or hostname) +/** @brief Set the network address (IP address or hostname) * * @param connection Pointer to the OSyncPluginConnection object * @param address The network address to set @@ -296,7 +296,7 @@ OSYNC_EXPORT void osync_plugin_connection_net_set_address(OSyncPluginConnection *connection, const char *address); -/*! @brief Get the network port +/** @brief Get the network port * * @param connection Pointer to the OSyncPluginConnection object * @returns The network port @@ -304,7 +304,7 @@ */ OSYNC_EXPORT unsigned int osync_plugin_connection_net_get_port(OSyncPluginConnection *connection); -/*! @brief Set the network port +/** @brief Set the network port * * @param connection Pointer to the OSyncPluginConnection object * @param port The network port to set @@ -313,7 +313,7 @@ OSYNC_EXPORT void osync_plugin_connection_net_set_port(OSyncPluginConnection *connection, unsigned int port); -/*! @brief Get the network protocol +/** @brief Get the network protocol * * @param connection Pointer to the OSyncPluginConnection object * @returns The network protocol @@ -321,7 +321,7 @@ */ OSYNC_EXPORT const char *osync_plugin_connection_net_get_protocol(OSyncPluginConnection *connection); -/*! @brief Set the network protocol +/** @brief Set the network protocol * * @param connection Pointer to the OSyncPluginConnection object * @param protocol The network protocol to set @@ -330,7 +330,7 @@ OSYNC_EXPORT void osync_plugin_connection_net_set_protocol(OSyncPluginConnection *connection, const char *protocol); -/*! @brief Get the network DNS-SD service type +/** @brief Get the network DNS-SD service type * * @param connection Pointer to the OSyncPluginConnection object * @returns The DNS-SD service type or NULL if not set @@ -338,7 +338,7 @@ */ OSYNC_EXPORT const char *osync_plugin_connection_net_get_dnssd(OSyncPluginConnection *connection); -/*! @brief Set the network DNS-SD service type +/** @brief Set the network DNS-SD service type * * @param connection Pointer to the OSyncPluginConnection object * @param dnssd The DNS-SD service type to set @@ -349,7 +349,7 @@ /* Serial */ -/*! @brief Get the serial port speed +/** @brief Get the serial port speed * * @param connection Pointer to the OSyncPluginConnection object * @returns The serial port speed, in bps @@ -357,7 +357,7 @@ */ OSYNC_EXPORT unsigned int osync_plugin_connection_serial_get_speed(OSyncPluginConnection *connection); -/*! @brief Set the serial port speed +/** @brief Set the serial port speed * * @param connection Pointer to the OSyncPluginConnection object * @param speed The serial port speed to set, in bps @@ -366,7 +366,7 @@ OSYNC_EXPORT void osync_plugin_connection_serial_set_speed(OSyncPluginConnection *connection, unsigned int speed); -/*! @brief Get the serial port device +/** @brief Get the serial port device * * The serial port device node, eg. /dev/ttyS0, /dev/ttyUSB0 etc. * @@ -376,7 +376,7 @@ */ OSYNC_EXPORT const char *osync_plugin_connection_serial_get_devicenode(OSyncPluginConnection *connection); -/*! @brief Set the serial port device +/** @brief Set the serial port device * * The serial port device node, eg. /dev/ttyS0, /dev/ttyUSB0 etc. * @@ -389,7 +389,7 @@ /* IrDA */ -/*! @brief Get the IrDA identifier (service) string +/** @brief Get the IrDA identifier (service) string * * @param connection Pointer to the OSyncPluginConnection object * @returns The IrDA service string @@ -397,7 +397,7 @@ */ OSYNC_EXPORT const char *osync_plugin_connection_irda_get_service(OSyncPluginConnection *connection); -/*! @brief Set the IrDA identifier (service) string +/** @brief Set the IrDA identifier (service) string * * @param connection Pointer to the OSyncPluginConnection object * @param irdaservice The IrDA service string to set Modified: trunk/opensync/plugin/opensync_plugin_env.h ============================================================================== --- trunk/opensync/plugin/opensync_plugin_env.h Thu Jan 8 09:15:39 2009 (r5052) +++ trunk/opensync/plugin/opensync_plugin_env.h Thu Jan 8 11:47:50 2009 (r5053) @@ -31,14 +31,14 @@ /** * @defgroup OSyncPluginEnvAPI OpenSync Environment - * @ingroup OSyncPublic + * @ingroup OSyncPlugin * @brief The public API of the opensync environment * */ /*@{*/ -/*! @brief This will create a new opensync environment +/** @brief This will create a new opensync environment * * The environment will hold all information about plugins, groups etc * @@ -47,7 +47,7 @@ */ OSYNC_EXPORT OSyncPluginEnv *osync_plugin_env_new(OSyncError **error); -/*! @brief Increases the reference counton an opensync plugin environment +/** @brief Increases the reference counton an opensync plugin environment * * The reference count on the OSyncPluginEnv is incremented. When the * reference is no longer needed it should be removed with @@ -58,7 +58,7 @@ */ OSYNC_EXPORT OSyncPluginEnv *osync_plugin_env_ref(OSyncPluginEnv *env); -/*! @brief Removes a reference to an OSyncPluginEnv +/** @brief Removes a reference to an OSyncPluginEnv * * Decrements the reference count on an osync plugin environment. If * the reference count reaches zero the environment is freed and all @@ -69,7 +69,7 @@ */ OSYNC_EXPORT void osync_plugin_env_unref(OSyncPluginEnv *env); -/*! @brief Loads the sync modules from a given directory +/** @brief Loads the sync modules from a given directory * * Loads all sync modules from a directory into a osync environment * @@ -82,7 +82,7 @@ OSYNC_EXPORT osync_bool osync_plugin_env_load(OSyncPluginEnv *env, const char *path, OSyncError **error); -/*! @brief Register plugin to plugin environment +/** @brief Register plugin to plugin environment * * @param env Pointer to a plugin environment * @param plugin Pointer to plugin which should get added to environment @@ -90,7 +90,7 @@ */ OSYNC_EXPORT void osync_plugin_env_register_plugin(OSyncPluginEnv *env, OSyncPlugin *plugin); -/*! @brief Finds the plugin with the given name +/** @brief Finds the plugin with the given name * * Finds the plugin with the given name * @@ -101,7 +101,7 @@ */ OSYNC_EXPORT OSyncPlugin *osync_plugin_env_find_plugin(OSyncPluginEnv *env, const char *name); -/*! @brief Returns the number of loaded plugins +/** @brief Returns the number of loaded plugins * * Returns the number of loaded plugins. 0 if used before initialization * @@ -111,7 +111,7 @@ */ OSYNC_EXPORT int osync_plugin_env_num_plugins(OSyncPluginEnv *env); -/*! @brief Returns pointer to nth plugin +/** @brief Returns pointer to nth plugin * * Returns pointer to nth plugin * Modified: trunk/opensync/plugin/opensync_plugin_info.h ============================================================================== --- trunk/opensync/plugin/opensync_plugin_info.h Thu Jan 8 09:15:39 2009 (r5052) +++ trunk/opensync/plugin/opensync_plugin_info.h Thu Jan 8 11:47:50 2009 (r5053) @@ -23,28 +23,29 @@ /** * @defgroup OSyncPluginInfoAPI OpenSync Plugin Info - * @ingroup OSyncPublic + * @ingroup OSyncPlugin * @brief Functions to get and set information about a plugin * */ + /*@{*/ -/*! @brief Create a new plugin info object +/** @brief Create a new plugin info object * * @param error Pointer to an error struct * @returns the newly registered plugin info object */ OSYNC_EXPORT OSyncPluginInfo *osync_plugin_info_new(OSyncError **error); -/*! @brief Increase the reference count on a plugin info object +/** @brief Increase the reference count on a plugin info object * * @param info Pointer to the plugin info object * */ OSYNC_EXPORT OSyncPluginInfo *osync_plugin_info_ref(OSyncPluginInfo *info); -/*! @brief Decrease the reference count on a plugin info object +/** @brief Decrease the reference count on a plugin info object * * @param info Pointer to the plugin info object * @@ -52,7 +53,7 @@ OSYNC_EXPORT void osync_plugin_info_unref(OSyncPluginInfo *info); -/*! @brief Set reference to loop for the specific plugin +/** @brief Set reference to loop for the specific plugin * * @param info Pointer to the plugin info object * @param loop Pointer to the loop which get set for specified OSyncPluginInfo object @@ -60,7 +61,7 @@ */ OSYNC_EXPORT void osync_plugin_info_set_loop(OSyncPluginInfo *info, void *loop); -/*! @brief Get loop reference of OSyncPluginInfo object +/** @brief Get loop reference of OSyncPluginInfo object * * @param info Pointer to the plugin info object * @returns Reference to the loop of the OSyncPluginInfo object @@ -68,14 +69,14 @@ OSYNC_EXPORT void *osync_plugin_info_get_loop(OSyncPluginInfo *info); -/*! @brief Set the plugin configuration data +/** @brief Set the plugin configuration data * * @param info Pointer to the plugin info object * @param config Plugin configuration */ OSYNC_EXPORT void osync_plugin_info_set_config(OSyncPluginInfo *info, OSyncPluginConfig *config); -/*! @brief Returns the plugin configuration data +/** @brief Returns the plugin configuration data * * @param info Pointer to the plugin info object * @returns the plugin configuration data (null-terminated string) @@ -84,7 +85,7 @@ OSYNC_EXPORT OSyncPluginConfig *osync_plugin_info_get_config(OSyncPluginInfo *info); -/*! @brief Set plugin configuration directory +/** @brief Set plugin configuration directory * * @param info Pointer to the plugin info object * @param configdir Configuration directory to set @@ -92,7 +93,7 @@ */ OSYNC_EXPORT void osync_plugin_info_set_configdir(OSyncPluginInfo *info, const char *configdir); -/*! @brief Returns the plugin configuration directory +/** @brief Returns the plugin configuration directory * * @param info Pointer to the plugin info object * @returns the full path where configuration files for the plugin are stored @@ -101,7 +102,7 @@ OSYNC_EXPORT const char *osync_plugin_info_get_configdir(OSyncPluginInfo *info); -/*! @brief Find ObjTypeSink of corresponding Object Type in OSyncPluginInfo object +/** @brief Find ObjTypeSink of corresponding Object Type in OSyncPluginInfo object * * @param info Pointer to the OSyncPluginInfo object * @param name Name of the Object Type @@ -110,7 +111,7 @@ */ OSYNC_EXPORT OSyncObjTypeSink *osync_plugin_info_find_objtype(OSyncPluginInfo *info, const char *name); -/*! @brief Adds an object type (sink) to a plugin +/** @... [truncated message content] |
