From: <dg...@su...> - 2009-01-19 09:37:33
|
Author: bricks Date: Mon Jan 19 10:36:26 2009 New Revision: 5189 URL: http://www.opensync.org/changeset/5189 Log: Fixed all doxygen warning (Documentation is still missing ;-) ) Modified: trunk/opensync/archive/opensync_archive_internals.h trunk/opensync/common/opensync_string.h trunk/opensync/common/opensync_thread_internals.h trunk/opensync/data/opensync_data.h trunk/opensync/engine/opensync_engine.h trunk/opensync/engine/opensync_mapping_entry_engine_internals.h trunk/opensync/format/opensync_converter.h trunk/opensync/format/opensync_format_env.h trunk/opensync/format/opensync_objformat.h trunk/opensync/format/opensync_objformat_internals.h trunk/opensync/mapping/opensync_mapping_table.h trunk/opensync/module/opensync_module_internals.h trunk/opensync/plugin/opensync_plugin.h trunk/opensync/plugin/opensync_plugin_config.h trunk/opensync/plugin/opensync_plugin_internals.h trunk/opensync/xmlformat/opensync_xmlformat_schema_internals.h Modified: trunk/opensync/archive/opensync_archive_internals.h ============================================================================== --- trunk/opensync/archive/opensync_archive_internals.h Mon Jan 19 01:31:16 2009 (r5188) +++ trunk/opensync/archive/opensync_archive_internals.h Mon Jan 19 10:36:26 2009 (r5189) @@ -102,7 +102,7 @@ * * @param archive The group archive * @param objtype Requested object type - * @param ids List to store the archive (database) ids of each entry + * @param mappingsids List to store the archive (database) ids of each entry * @param changetypes List to store the changetypes for each entry * @param error Pointer to an error struct * @return TRUE on when all changes successfully loaded otherwise FALSE @@ -114,7 +114,7 @@ * * @param archive The group archive * @param objtype Reported object type of entry - * @param id Mapping Entry ID of entry + * @param mappingid Mapping Entry ID of entry * @param changetype Changetype of entry * @param error Pointer to an error struct * @return Returns TRUE on success, FALSE otherwise Modified: trunk/opensync/common/opensync_string.h ============================================================================== --- trunk/opensync/common/opensync_string.h Mon Jan 19 01:31:16 2009 (r5188) +++ trunk/opensync/common/opensync_string.h Mon Jan 19 10:36:26 2009 (r5189) @@ -39,9 +39,9 @@ */ 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 + * Duplicates a string, ending with terminating-zero: * * @param str The pointer of the string to duplicate * @returns The duplicate string, caller is responsible for freeing. @@ -49,12 +49,12 @@ */ 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 + * Duplicates a formated string, ending with terminating-zero: * - * @param str The pointer of the string to duplicate - * @param args + * @param format The format for the output + * @param ... vararg list * @returns The duplicate string, caller is responsible for freeing. * */ Modified: trunk/opensync/common/opensync_thread_internals.h ============================================================================== --- trunk/opensync/common/opensync_thread_internals.h Mon Jan 19 01:31:16 2009 (r5188) +++ trunk/opensync/common/opensync_thread_internals.h Mon Jan 19 10:36:26 2009 (r5189) @@ -23,7 +23,7 @@ #define _OPENSYNC_THREAD_INTERNALS_H /** - * @defroup OSyncThreadInternalAPI OpenSync Thread Internals + * @defgroup OSyncThreadInternalAPI OpenSync Thread Internals * @ingroup OSyncCommonPrivate * @brief Some threading functions */ Modified: trunk/opensync/data/opensync_data.h ============================================================================== --- trunk/opensync/data/opensync_data.h Mon Jan 19 01:31:16 2009 (r5188) +++ trunk/opensync/data/opensync_data.h Mon Jan 19 10:36:26 2009 (r5189) @@ -30,40 +30,40 @@ */ /*@{*/ -/*! @brief Create a new data object +/** @brief Create a new data object * - * @param buffer Character buffer containing the data + * @param data Character buffer containing the data * @param size The size of the data contained in the buffer * @param format The object format of the data * @param error An error struct - * @returns The new data object + * @return The new data object * */ OSYNC_EXPORT OSyncData *osync_data_new(char *data, unsigned int size, OSyncObjFormat *format, OSyncError **error); -/*! @brief Increase the reference count on a data object +/** @brief Increase the reference count on a data object * * @param data The data object * */ OSYNC_EXPORT OSyncData *osync_data_ref(OSyncData *data); -/*! @brief Decrease the reference count on a data object +/** @brief Decrease the reference count on a data object * * @param data The data object * */ OSYNC_EXPORT void osync_data_unref(OSyncData *data); -/*! @brief Get the object format from a data object +/** @brief Get the object format from a data object * * @param data The data object - * @returns the object format of the data object + * @return the object format of the data object * */ OSYNC_EXPORT OSyncObjFormat *osync_data_get_objformat(OSyncData *data); -/*! @brief Set the object format on a data object +/** @brief Set the object format on a data object * * @param data The data object * @param objformat The object format to set @@ -71,15 +71,15 @@ */ OSYNC_EXPORT void osync_data_set_objformat(OSyncData *data, OSyncObjFormat *objformat); -/*! @brief Get the object type from a data object +/** @brief Get the object type from a data object * * @param data The data object - * @returns the name of the object type of the data object + * @return the name of the object type of the data object * */ OSYNC_EXPORT const char *osync_data_get_objtype(OSyncData *data); -/*! @brief Set the object type of a data object +/** @brief Set the object type of a data object * * @param data The data object * @param objtype The name of the object type to set @@ -87,7 +87,7 @@ */ OSYNC_EXPORT void osync_data_set_objtype(OSyncData *data, const char *objtype); -/*! @brief Get the data from a data object +/** @brief Get the data from a data object * * @param data The data object * @param buffer Pointer to a char * that will be set to point to the data if specified. Do not free this buffer. @@ -96,7 +96,7 @@ */ OSYNC_EXPORT void osync_data_get_data(OSyncData *data, char **buffer, unsigned int *size); -/*! @brief Set the data of a data object +/** @brief Set the data of a data object * * @param data The data object * @param buffer The data as a character array. Freeing this buffer will be handled by the data object. @@ -105,39 +105,38 @@ */ OSYNC_EXPORT void osync_data_set_data(OSyncData *data, char *buffer, unsigned int size); -/*! @brief Check if the data object has data stored +/** @brief Check if the data object has data stored * * @param data The data object - * @returns TRUE if the data object has data, FALSE otherwise + * @return TRUE if the data object has data, FALSE otherwise * */ OSYNC_EXPORT osync_bool osync_data_has_data(OSyncData *data); -/*! @brief Returns a string describing a data object +/** @brief Returns a string describing a data object * * Some formats cannot be printed directly. To be able to print these * objects they should specify a print function. * * @param data The data to get printable - * @returns A string describing the object - * + * @return A string describing the object */ OSYNC_EXPORT char *osync_data_get_printable(OSyncData *data); -/*! @brief Clone a data object +/** @brief Clone a data object * - * @param source The data object to clone + * @param data The data object to clone * @param error An error struct - * @returns a copy of the specified data object, or NULL if an error occurred + * @return a copy of the specified data object, or NULL if an error occurred * */ OSYNC_EXPORT OSyncData *osync_data_clone(OSyncData *data, OSyncError **error); -/*! @brief Returns the revision of the object +/** @brief Returns the revision of the object * * @param data The change to get the revision from * @param error An error struct - * @returns The revision of the object in seconds since the epoch in zulu time + * @return The revision of the object in seconds since the epoch in zulu time * */ OSYNC_EXPORT time_t osync_data_get_revision(OSyncData *data, OSyncError **error); Modified: trunk/opensync/engine/opensync_engine.h ============================================================================== --- trunk/opensync/engine/opensync_engine.h Mon Jan 19 01:31:16 2009 (r5188) +++ trunk/opensync/engine/opensync_engine.h Mon Jan 19 10:36:26 2009 (r5189) @@ -252,8 +252,7 @@ * osync_engine_wait_sync_end for this as this might introduce a race condition. * * @param engine A pointer to the engine, which to sync and wait for the sync end - * @param member A pointer to the member, which to discover - * @param error A pointer to a error struct + * @param error A pointer to an error struct * @returns TRUE on success, FALSE otherwise. * */ @@ -382,7 +381,7 @@ * The change status handler will be called every time a new change is received, written etc * * @param engine A pointer to the engine, for which to set the callback - * @param function A pointer to a function which will receive the change status + * @param callback A pointer to a function which will receive the change status * @param user_data Pointer to some data that will get passed to the status function as the last argument * */ @@ -393,7 +392,7 @@ * The mapping status handler will be called every time a mapping is updated * * @param engine A pointer to the engine, for which to set the callback - * @param function A pointer to a function which will receive the mapping status + * @param callback A pointer to a function which will receive the mapping status * @param user_data Pointer to some data that will get passed to the status function as the last argument * */ @@ -404,7 +403,7 @@ * The engine status handler will be called every time the engine is updated (started, stopped etc) * * @param engine A pointer to the engine, for which to set the callback - * @param function A pointer to a function which will receive the engine status + * @param callback A pointer to a function which will receive the engine status * @param user_data Pointer to some data that will get passed to the status function as the last argument * */ @@ -415,7 +414,7 @@ * The member status handler will be called every time a member is updated (connects, disconnects etc) * * @param engine A pointer to the engine, for which to set the callback - * @param function A pointer to a function which will receive the member status + * @param callback A pointer to a function which will receive the member status * @param user_data Pointer to some data that will get passed to the status function as the last argument * */ Modified: trunk/opensync/engine/opensync_mapping_entry_engine_internals.h ============================================================================== --- trunk/opensync/engine/opensync_mapping_entry_engine_internals.h Mon Jan 19 01:31:16 2009 (r5188) +++ trunk/opensync/engine/opensync_mapping_entry_engine_internals.h Mon Jan 19 10:36:26 2009 (r5189) @@ -42,31 +42,32 @@ */ /*@{*/ -/*! @brief Register a new Mapping Entry Engine +/** @brief Register a new Mapping Entry Engine * * @param entry Pointer to an OSyncMappingEntry * @param mapping_engine Pointer to an OSyncMappingEngine * @param sink_engine Pointer to an OSyncSinkEngine + * @param objengine Pointer to an OSyncObjEngine * @param error Pointer to an error struct * @returns the newly registered Mapping Entry Engine, NULL on error */ OSyncMappingEntryEngine *osync_entry_engine_new(OSyncMappingEntry *entry, OSyncMappingEngine *mapping_engine, OSyncSinkEngine *sink_engine, OSyncObjEngine *objengine, OSyncError **error); -/*! @brief Increase the reference count on a Mapping Entry Engine +/** @brief Increase the reference count on a Mapping Entry Engine * - * @param plugin Pointer to the Mapping Entry Engine + * @param engine Pointer to the Mapping Entry Engine * */ OSyncMappingEntryEngine *osync_entry_engine_ref(OSyncMappingEntryEngine *engine); -/*! @brief Decrease the reference count on a Mapping Entry Engine +/** @brief Decrease the reference count on a Mapping Entry Engine * - * @param plugin Pointer to the Mapping Entry Engine + * @param engine Pointer to the Mapping Entry Engine * */ void osync_entry_engine_unref(OSyncMappingEntryEngine *engine); -/*! @brief Tries to match OSyncMappingEntryEngine with a OSyncChange. +/** @brief Tries to match OSyncMappingEntryEngine with a OSyncChange. * * Based on the UID of the OSyncChange and the Mapping Entry of the * OSyncMappingEntryEngine, this functions tries to match the two objects. @@ -80,14 +81,14 @@ */ osync_bool osync_entry_engine_matches(OSyncMappingEntryEngine *engine, OSyncChange *change); -/*! @brief Get the pointer of the assinged OSyncChange object +/** @brief Get the pointer of the assinged OSyncChange object * * @param engine Pointer to an OSyncMappingEntryEngine * @returns Pointer to assigned OSyncChange, or NULL if no change is set */ OSyncChange *osync_entry_engine_get_change(OSyncMappingEntryEngine *engine); -/*! @brief Update the OSyncChange object in Mapping Entry Engine +/** @brief Update the OSyncChange object in Mapping Entry Engine * * Mapping Entry Engine get flagged as not sync in the Mapping Table, when * change get updated. @@ -97,17 +98,17 @@ */ void osync_entry_engine_update(OSyncMappingEntryEngine *engine, OSyncChange *change); -/*! @brief Set the dirty flag for OSyncMappingEntryEngine +/** @brief Set the dirty flag for OSyncMappingEntryEngine * * If dirty flag for OSyncMappingEntryEngine get set, the entry gets handled * in the engine WRITE section. * * @param engine Pointer to an OSyncMappingEntryEngine - * @param change Pointer to new change to assign or NULL to unset the current change + * @param dirty Boolean value to set */ void osync_entry_engine_set_dirty(OSyncMappingEntryEngine *engine, osync_bool dirty); -/*! @brief Demerge the entry in the OSyncMappingEntryEngine +/** @brief Demerge the entry in the OSyncMappingEntryEngine * * The demerge includes storing the "entire" entry in the Archive. The demerging is done * based on the supplied OSyncCapabilities. @@ -120,7 +121,7 @@ */ osync_bool osync_entry_engine_demerge(OSyncMappingEntryEngine *engine, OSyncArchive *archive, OSyncCapabilities *caps, OSyncError **error); -/*! @brief convert the entry in the OSyncMappingEntryEngine +/** @brief convert the entry in the OSyncMappingEntryEngine * * The conversion of the entry of OSyncMappingEntryEngine, uses the format * configurations of OSyncObjTypeSink (i.e. which supported formats, preferred Modified: trunk/opensync/format/opensync_converter.h ============================================================================== --- trunk/opensync/format/opensync_converter.h Mon Jan 19 01:31:16 2009 (r5188) +++ trunk/opensync/format/opensync_converter.h Mon Jan 19 10:36:26 2009 (r5189) @@ -105,7 +105,7 @@ /** * @brief Detects the Object Format of passed OSyncData - * @param detector Pointer to the detector + * @param converter Pointer to the converter * @param data Pointer to OSyncData object which should be detected * @returns The detected Object Format or NULL */ @@ -193,17 +193,18 @@ /** * @brief Sets the finalize function of a converter * @param converter Pointer to the converter - * @param initialize_func Pointer to the finialize function + * @param finalize_func Pointer to the finalize function */ OSYNC_EXPORT void osync_converter_set_finalize_func(OSyncFormatConverter *converter, OSyncFormatConverterFinalizeFunc finalize_func); /** * @brief Invokes initialize function of a converter * - * @param converter Pointer to the converter which should be initalized + * @param converter Pointer to the converter which should be initialized * @param config configuration + * @param error Pointer to an error struct * - * @todo config is not used currently. Should be usesd in the future to pass a directoy for xml format schema location + * @todo config is not used currently. Should be used in the future to pass a directory for xml format schema location */ OSYNC_EXPORT void osync_converter_initialize(OSyncFormatConverter *converter, const char *config, OSyncError **error); Modified: trunk/opensync/format/opensync_format_env.h ============================================================================== --- trunk/opensync/format/opensync_format_env.h Mon Jan 19 01:31:16 2009 (r5188) +++ trunk/opensync/format/opensync_format_env.h Mon Jan 19 10:36:26 2009 (r5189) @@ -239,9 +239,10 @@ * * @param env The format environment to use * @param sourcedata The OSyncData object which should be converted and the detectors will run on - * @param targetformat The target format to be converted to + * @param targetformat The target format to be converted to + * @param preferred_format Format that should be preferred to build the conversion path * @param error The error-return location - * @returns The appropriate conversion path, or NULL if an error occurred. + * @return The appropriate conversion path, or NULL if an error occurred. * */ OSYNC_EXPORT OSyncFormatConverterPath *osync_format_env_find_path_with_detectors(OSyncFormatEnv *env, OSyncData *sourcedata, OSyncObjFormat *targetformat, const char *preferred_format, OSyncError **error); @@ -251,6 +252,7 @@ * @param env The format environment to use * @param sourcedata The OSyncData object which should be converted and the detectors will run on * @param targets List of possible Object Format Sinks + * @param preferred_format Format that should be preferred to build the conversion path * @param error The error-return location * @returns The appropriate conversion path, or NULL if an error occurred. * Modified: trunk/opensync/format/opensync_objformat.h ============================================================================== --- trunk/opensync/format/opensync_objformat.h Mon Jan 19 01:31:16 2009 (r5188) +++ trunk/opensync/format/opensync_objformat.h Mon Jan 19 10:36:26 2009 (r5189) @@ -207,7 +207,7 @@ * @param format Pointer to the object format * @param demarshal_func The demarshal function to set */ -OSYNC_EXPORT void osync_objformat_set_demarshal_func(OSyncObjFormat *format, OSyncFormatDemarshalFunc marshal_func); +OSYNC_EXPORT void osync_objformat_set_demarshal_func(OSyncObjFormat *format, OSyncFormatDemarshalFunc demarshal_func); /** * @brief Sets the optional validation function for an object format Modified: trunk/opensync/format/opensync_objformat_internals.h ============================================================================== --- trunk/opensync/format/opensync_objformat_internals.h Mon Jan 19 01:31:16 2009 (r5188) +++ trunk/opensync/format/opensync_objformat_internals.h Mon Jan 19 10:36:26 2009 (r5189) @@ -183,7 +183,8 @@ * * @param format Pointer to the object format * @param data Reference of buffer which stores data to merge - * @param size Refernce of size in bytes of the buffer specified by the data paramter + * @param size Reference of size in bytes of the buffer specified by the data paramter + * @param entire * @param entsize Size in bytes of the base data buffer specified by the entire parameter * @param caps The capabilities list which describes what must get merged: entire -> input * @param error Pointer to an error struct @@ -195,7 +196,7 @@ OSyncCapabilities *caps, OSyncError **error); /** - * @brief Demrge supplied data in format specific way + * @brief Demerge supplied data in format specific way * * @param format Pointer to the object format * @param data Pointer to the buffer which should get demerged Modified: trunk/opensync/mapping/opensync_mapping_table.h ============================================================================== --- trunk/opensync/mapping/opensync_mapping_table.h Mon Jan 19 01:31:16 2009 (r5188) +++ trunk/opensync/mapping/opensync_mapping_table.h Mon Jan 19 10:36:26 2009 (r5189) @@ -87,7 +87,7 @@ * @brief Search for the mapping object with the mapping id * * @param table The mapping table object - * @param long long int The mapping id to search for + * @param id The mapping id to search for * @return Returns Mapping object or NULL if no mapping matched the mapping id */ OSYNC_EXPORT OSyncMapping *osync_mapping_table_find_mapping(OSyncMappingTable *table, long long int id); Modified: trunk/opensync/module/opensync_module_internals.h ============================================================================== --- trunk/opensync/module/opensync_module_internals.h Mon Jan 19 01:31:16 2009 (r5188) +++ trunk/opensync/module/opensync_module_internals.h Mon Jan 19 10:36:26 2009 (r5189) @@ -77,14 +77,12 @@ OSYNC_TEST_EXPORT void osync_module_unref(OSyncModule *module); /** - * @brief dlopen()s a format plugin + * @brief Loads a module * - * The get_info() function on the format plugin gets called - * - * @param env The environment in which to open the plugin - * @param path Where to find this plugin - * @param error Pointer to a error struct - * @return Pointer to the plugin on success, NULL otherwise + * @param module Module that should be loaded + * @param path Where to find this module + * @param error Pointer to an error struct + * @return TRUE on success, FALSE otherwise * */ OSYNC_TEST_EXPORT osync_bool osync_module_load(OSyncModule *module, const char *path, OSyncError **error); @@ -145,9 +143,9 @@ * * Looks up and returns a function * - * @param plugin Pointer to the plugin + * @param module Pointer to the module * @param name The name of the function to look up - * @param error Pointer to a error struct + * @param error Pointer to an error struct * @return Pointer to the function * */ Modified: trunk/opensync/plugin/opensync_plugin.h ============================================================================== --- trunk/opensync/plugin/opensync_plugin.h Mon Jan 19 01:31:16 2009 (r5188) +++ trunk/opensync/plugin/opensync_plugin.h Mon Jan 19 10:36:26 2009 (r5189) @@ -275,16 +275,17 @@ */ OSYNC_EXPORT void osync_plugin_set_finalize_timeout(OSyncPlugin *plugin, unsigned int timeout); -/** @brief Initialize Plugin +/** @brief Initialize a Plugin * * @param plugin Pointer to the plugin + * @param plugin_data Pointer to store the data that is returned by the plugin * @param info Pointer to OSyncPluginInfo which describes the plugin * @param error Pointer to error-struct - * @return Userdata returned by the plugin on success, NULL on error + * @return TREU if successful, FALSE otherwise */ OSYNC_EXPORT osync_bool osync_plugin_initialize(OSyncPlugin *plugin, void **plugin_data, OSyncPluginInfo *info, OSyncError **error); -/** @brief Finalize Plugin +/** @brief Finalize a Plugin * * @param plugin Pointer to the plugin * @param data Pointer to userdata which got returned by plugin initialize function Modified: trunk/opensync/plugin/opensync_plugin_config.h ============================================================================== --- trunk/opensync/plugin/opensync_plugin_config.h Mon Jan 19 01:31:16 2009 (r5188) +++ trunk/opensync/plugin/opensync_plugin_config.h Mon Jan 19 10:36:26 2009 (r5189) @@ -81,8 +81,9 @@ * * @param config Contents of config file as OsyncPluginConfig object * @param path Path to file to load + * @param schemadir Path to the schema location. If schmadir is NULL the default value is used * @param error Pointer to error struct - * @returns True on success, False on failure - error will contain details + * @return True on success, False on failure - error will contain details */ OSYNC_EXPORT osync_bool osync_plugin_config_file_load(OSyncPluginConfig *config, const char *path, const char *schemadir, OSyncError **error); Modified: trunk/opensync/plugin/opensync_plugin_internals.h ============================================================================== --- trunk/opensync/plugin/opensync_plugin_internals.h Mon Jan 19 01:31:16 2009 (r5188) +++ trunk/opensync/plugin/opensync_plugin_internals.h Mon Jan 19 10:36:26 2009 (r5189) @@ -25,9 +25,9 @@ typedef osync_bool (* usable_fn) (OSyncError **); /** - * @defgroup OSyncPluginPrivateAPI OpenSync Plugin Internals + * @defgroup OSyncPluginInternalsAPI OpenSync Plugin Internals * @ingroup OSyncPluginPrivate - * @brief Private functions to manage plugins + * @brief Internal functions to manage plugins * */ Modified: trunk/opensync/xmlformat/opensync_xmlformat_schema_internals.h ============================================================================== --- trunk/opensync/xmlformat/opensync_xmlformat_schema_internals.h Mon Jan 19 01:31:16 2009 (r5188) +++ trunk/opensync/xmlformat/opensync_xmlformat_schema_internals.h Mon Jan 19 10:36:26 2009 (r5189) @@ -29,6 +29,7 @@ * @brief The internal part of the OSyncXMLFormatSchema * */ + /*@{*/ /** @@ -49,4 +50,6 @@ */ OSYNC_TEST_EXPORT OSyncXMLFormatSchema *osync_xmlformat_schema_new_path(const char *objtype, const char *path, OSyncError **error); +/*@}*/ + #endif /* OPENSYNC_XMLFORMAT_SCHEMA_INTERNALS_H_ */ |