From 0d3cd872a6ab5a14cfb66bb7faa5a6d83ad3c5ea Mon Sep 17 00:00:00 2001 From: Saya Sugiura Date: Mon, 8 Jul 2019 16:25:05 +0900 Subject: doxygen: Get rid of warnings Signed-off-by: Saya Sugiura --- doc/dlt_for_developers.md | 2 +- include/dlt/dlt_client.h | 16 ++++------ include/dlt/dlt_common.h | 11 ++++--- include/dlt/dlt_offline_trace.h | 18 +++++------ include/dlt/dlt_user.h | 11 +++++-- src/console/dlt-control-common.c | 2 +- src/console/dlt-control.c | 4 +-- src/console/dlt-convert.c | 4 +-- src/console/dlt-passive-node-ctrl.c | 6 ++-- src/console/dlt-receive.c | 4 +-- src/console/dlt-sortbytimestamp.c | 4 +-- src/console/logstorage/dlt-logstorage-udev.c | 6 ++-- src/core_dump_handler/i686/dlt_cdh_cpuinfo.c | 2 +- src/core_dump_handler/x86_64/dlt_cdh_cpuinfo.c | 2 +- src/daemon/dlt_daemon_client.h | 2 ++ src/daemon/dlt_daemon_common.h | 4 +-- src/daemon/dlt_daemon_connection.c | 2 +- src/daemon/dlt_daemon_event_handler.c | 12 +++---- src/daemon/dlt_daemon_offline_logstorage.c | 13 ++++++-- src/daemon/dlt_daemon_offline_logstorage.h | 13 ++++---- src/daemon/dlt_daemon_socket.h | 2 +- src/gateway/dlt_gateway.c | 17 +++++----- src/gateway/dlt_gateway.h | 7 ++-- src/lib/dlt_env_ll.c | 4 +++ src/lib/dlt_filetransfer.c | 8 +++-- src/offlinelogstorage/dlt_offline_logstorage.c | 37 ++++++++++++---------- src/offlinelogstorage/dlt_offline_logstorage.h | 11 ++++--- .../dlt_offline_logstorage_behavior.c | 4 ++- src/shared/dlt_config_file_parser.c | 1 + src/shared/dlt_config_file_parser.h | 2 +- 30 files changed, 134 insertions(+), 97 deletions(-) diff --git a/doc/dlt_for_developers.md b/doc/dlt_for_developers.md index 026eba4..a3aa198 100644 --- a/doc/dlt_for_developers.md +++ b/doc/dlt_for_developers.md @@ -211,7 +211,7 @@ runtime configuration). It allows to set a per-application-context log level. Refer to [Initial Log level](#initial-log-level) for more detail. -- Application registers itself at daemon with self defined log level +- Application registers itself at daemon with self-defined log level - In this case no log level is set by the daemon but by the application itself. - This happens when the application registers itself with diff --git a/include/dlt/dlt_client.h b/include/dlt/dlt_client.h index 8947e2f..45b6d9b 100644 --- a/include/dlt/dlt_client.h +++ b/include/dlt/dlt_client.h @@ -174,7 +174,7 @@ DltReturnValue dlt_client_send_inject_msg(DltClient *client, * @param client pointer to dlt client structure * @param apid application id * @param ctid context id - * @param SendLogLevel Log Level + * @param logLevel Log Level * @return Value from DltReturnValue enum */ DltReturnValue dlt_client_send_log_level(DltClient *client, char *apid, char *ctid, uint8_t logLevel); @@ -198,13 +198,11 @@ DltReturnValue dlt_client_get_default_log_level(DltClient *client); int dlt_client_get_software_version(DltClient *client); /** * Initialise get log info structure - * @param void * @return void */ void dlt_getloginfo_init(void); /** * To free the memory allocated for app description in get log info - * @param void * @return void */ void dlt_getloginfo_free(void); @@ -213,7 +211,7 @@ void dlt_getloginfo_free(void); * @param client pointer to dlt client structure * @param apid application id * @param ctid context id - * @param defaultTraceStatus Default Trace Status + * @param traceStatus Default Trace Status * @return Value from DltReturnValue enum */ DltReturnValue dlt_client_send_trace_status(DltClient *client, char *apid, char *ctid, uint8_t traceStatus); @@ -276,23 +274,23 @@ DltReturnValue dlt_client_setbaudrate(DltClient *client, int baudrate); /** * Set server ip * @param client pointer to dlt client structure - * @param pointer to command line argument + * @param ipaddr pointer to command line argument * @return negative value if there was an error */ int dlt_client_set_server_ip(DltClient *client, char *ipaddr); /** * Set serial device - * @client pointer to dlt client structure - * @param param pointer to command line argument + * @param client pointer to dlt client structure + * @param serial_device pointer to command line argument * @return negative value if there was an error */ int dlt_client_set_serial_device(DltClient *client, char *serial_device); /** * Set socket path - * @client pointer to dlt client structure - * @param param pointer to socket path string + * @param client pointer to dlt client structure + * @param socket_path pointer to socket path string * @return negative value if there was an error */ int dlt_client_set_socket_path(DltClient *client, char *socket_path); diff --git a/include/dlt/dlt_common.h b/include/dlt/dlt_common.h index e41fa5c..9e0bee7 100644 --- a/include/dlt/dlt_common.h +++ b/include/dlt/dlt_common.h @@ -192,7 +192,7 @@ enum { }; /** - * The standard TCP Port used for DLT daemon, can be overwritten via -p when starting dlt-daemon + * The standard TCP Port used for DLT daemon, can be overwritten via -p \ when starting dlt-daemon */ # define DLT_DAEMON_TCP_PORT 3490 @@ -1218,7 +1218,7 @@ DltReturnValue dlt_receiver_move_to_begin(DltReceiver *receiver); * @param receiver pointer to dlt receiver structure * @param dest pointer to the destination buffer * @param to_get size of the data to copy in dest - * @skip_header whether if the DltUserHeader must be skipped. + * @param skip_header whether if the DltUserHeader must be skipped. */ int dlt_receiver_check_and_get(DltReceiver *receiver, void *dest, @@ -1293,6 +1293,7 @@ DltReturnValue dlt_buffer_free_dynamic(DltBuffer *buf); /** * Check if message fits into buffer. * @param buf Pointer to buffer structure + * @param needed Needed size * @return DLT_RETURN_OK if enough space, DLT_RETURN_ERROR otherwise */ DltReturnValue dlt_buffer_check_size(DltBuffer *buf, int needed); @@ -1309,7 +1310,7 @@ DltReturnValue dlt_buffer_push(DltBuffer *buf, const unsigned char *data, unsign /** * Write up to three entries to ringbuffer. * Entries are joined to one block. - * @param dlt Pointer to ringbuffer structure + * @param buf Pointer to ringbuffer structure * @param data1 Pointer to data to be written to ringbuffer * @param size1 Size of data in bytes to be written to ringbuffer * @param data2 Pointer to data to be written to ringbuffer @@ -1552,7 +1553,7 @@ int16_t dlt_getloginfo_conv_ascii_to_int16_t(char *rp, int *rp_count); * @param rp char * @param rp_count int * @param wp char - * @param length int + * @param len int */ void dlt_getloginfo_conv_ascii_to_id(char *rp, int *rp_count, char *wp, int len); @@ -1567,7 +1568,7 @@ void dlt_hex_ascii_to_binary(const char *ptr, uint8_t *binary, int *size); # ifndef DLT_USE_UNIX_SOCKET_IPC /** * Create the specified path, recursive if necessary - * behaves like calling mkdir -p on the console + * behaves like calling mkdir -p \ on the console */ int dlt_mkdir_recursive(const char *dir); # endif diff --git a/include/dlt/dlt_offline_trace.h b/include/dlt/dlt_offline_trace.h index a8cf1ee..6f6d8a6 100644 --- a/include/dlt/dlt_offline_trace.h +++ b/include/dlt/dlt_offline_trace.h @@ -105,7 +105,7 @@ extern DltReturnValue dlt_offline_trace_init(DltOfflineTrace *trace, * Uninitialise the offline trace * This function call closes currently used log file. * This function must be called after usage of offline trace - * @param trace pointer to offline trace structure + * @param buf pointer to offline trace structure * @return negative value if there was an error */ extern DltReturnValue dlt_offline_trace_free(DltOfflineTrace *buf); @@ -140,25 +140,25 @@ extern unsigned long dlt_offline_trace_get_total_size(DltOfflineTrace *trace); /** * Provides info about the offline logs storage directory - * @param path of the storage directory - * @param filename to search for - * @param pointer to store newest filename - * @param pointer to store oldest filename + * @param path path of the storage directory + * @param file_name filename to search for + * @param newest pointer to store newest filename + * @param oldest pointer to store oldest filename * @return num of files in the directory */ unsigned int dlt_offline_trace_storage_dir_info(char *path, char *file_name, char *newest, char *oldest); /** * creates filename with index - * @param log file name created with index - * @param filename base - * @param index to be used for file name creation + * @param log_file_name file name created with index + * @param name filename base + * @param idx index to be used for file name creation */ void dlt_offline_trace_file_name(char *log_file_name, char *name, unsigned int idx); /** * generates index for log file name - * @param filename supplied to create index + * @param file filename supplied to create index * @return the index to be used for log file name */ unsigned int dlt_offline_trace_get_idx_of_log_file(char *file); diff --git a/include/dlt/dlt_user.h b/include/dlt/dlt_user.h index c7a9949..bfd1c96 100644 --- a/include/dlt/dlt_user.h +++ b/include/dlt/dlt_user.h @@ -570,7 +570,7 @@ DltReturnValue dlt_register_context_ll_ts(DltContext *handle, * @param handle pointer to an object containing information about one special logging context * @param contextid four byte long character array with the context id * @param description long name of the context - * @param callback fn This is the fn which will be called when log level is changed + * @param *dlt_log_level_changed_callback This is the fn which will be called when log level is changed * @return Value from DltReturnValue enum */ DltReturnValue dlt_register_context_llccb(DltContext *handle, @@ -631,6 +631,7 @@ DltReturnValue dlt_register_injection_callback(DltContext *handle, uint32_t serv * @param handle pointer to an object containing information about one special logging context * @param service_id the service id to be waited for * @param (*dlt_injection_callback) function pointer to callback function + * @param priv private data * @return Value from DltReturnValue enum */ DltReturnValue dlt_register_injection_callback_with_id(DltContext *handle, uint32_t service_id, @@ -659,8 +660,8 @@ DltReturnValue dlt_verbose_mode(void); /** * Check the version of dlt library with library version used of the application. - * @param Major version number of application - see dlt_version.h - * @param Minor version number of application - see dlt_version.h + * @param user_major_version version number of application - see dlt_version.h + * @param user_minor_version version number of application - see dlt_version.h * @return Value from DltReturnValue enum, DLT_RETURN_ERROR if there is a mismatch */ DltReturnValue dlt_user_check_library_version(const char *user_major_version, const char *user_minor_version); @@ -726,6 +727,10 @@ DltReturnValue dlt_set_application_ll_ts_limit(DltLogLevelType loglevel, DltTrac * - no ctid, apid matches: use ll with prio 3 * - apid, ctid matches: use ll with prio 4 * + * @param ll_set + * @param apid + * @param ctid + * @param ll * If no item matches or in case of error, the original log-level (\param ll) is returned */ int dlt_env_adjust_ll_from_env(dlt_env_ll_set const *const ll_set, diff --git a/src/console/dlt-control-common.c b/src/console/dlt-control-common.c index d6787fc..1505f50 100644 --- a/src/console/dlt-control-common.c +++ b/src/console/dlt-control-common.c @@ -483,7 +483,7 @@ static void *dlt_control_listen_to_daemon(void *data) * New values are signaled using a dedicated condition variable. * * @param message The DLT answer - * @data Unused + * @param data Unused * * @return The analyzer return value or -1 on early errors. */ diff --git a/src/console/dlt-control.c b/src/console/dlt-control.c index f977b46..d35c1aa 100644 --- a/src/console/dlt-control.c +++ b/src/console/dlt-control.c @@ -21,13 +21,13 @@ * \copyright Copyright © 2011-2015 BMW AG. \n * License MPL-2.0: Mozilla Public License version 2.0 http://mozilla.org/MPL/2.0/. * - * \file dlt-control.cpp + * \file dlt-control.c */ /******************************************************************************* ** ** -** SRC-MODULE: dlt-control.cpp ** +** SRC-MODULE: dlt-control.c ** ** ** ** TARGET : linux ** ** ** diff --git a/src/console/dlt-convert.c b/src/console/dlt-convert.c index 373f4d1..511ba0c 100644 --- a/src/console/dlt-convert.c +++ b/src/console/dlt-convert.c @@ -21,12 +21,12 @@ * \copyright Copyright © 2011-2015 BMW AG. \n * License MPL-2.0: Mozilla Public License version 2.0 http://mozilla.org/MPL/2.0/. * - * \file dlt-convert.cpp + * \file dlt-convert.c */ /******************************************************************************* ** ** -** SRC-MODULE: dlt-convert.cpp ** +** SRC-MODULE: dlt-convert.c ** ** ** ** TARGET : linux ** ** ** diff --git a/src/console/dlt-passive-node-ctrl.c b/src/console/dlt-passive-node-ctrl.c index c41129e..0937af7 100644 --- a/src/console/dlt-passive-node-ctrl.c +++ b/src/console/dlt-passive-node-ctrl.c @@ -157,11 +157,13 @@ static void dlt_print_passive_node_status( * @brief Analyze received DLT Daemon response * * This function checks the received message. In particular, it checks the - * answer string 'service(, {ok, error, perm_denied})'. In any case the + * answer string 'service(\, {ok, error, perm_denied})'. In any case the * g_callback_return variable will be set as well which is evaluated in the * main function after the communication thread returned. * - * @param message Received DLT Message + * @param answer Recieved response + * @param payload Received DLT Message + * @param len Length of received DLT message * @return 0 if daemon returns 'ok' message, -1 otherwise */ static int dlt_passive_node_analyze_response(char *answer, diff --git a/src/console/dlt-receive.c b/src/console/dlt-receive.c index aef92b9..4ad96f4 100644 --- a/src/console/dlt-receive.c +++ b/src/console/dlt-receive.c @@ -21,13 +21,13 @@ * \copyright Copyright © 2011-2015 BMW AG. \n * License MPL-2.0: Mozilla Public License version 2.0 http://mozilla.org/MPL/2.0/. * - * \file dlt-receive.cpp + * \file dlt-receive.c */ /******************************************************************************* ** ** -** SRC-MODULE: dlt-receive.cpp ** +** SRC-MODULE: dlt-receive.c ** ** ** ** TARGET : linux ** ** ** diff --git a/src/console/dlt-sortbytimestamp.c b/src/console/dlt-sortbytimestamp.c index c7b5818..9717e5c 100644 --- a/src/console/dlt-sortbytimestamp.c +++ b/src/console/dlt-sortbytimestamp.c @@ -23,12 +23,12 @@ * Copyright © 2011-2015 BMW AG. \n * License MPL-2.0: Mozilla Public License version 2.0 http://mozilla.org/MPL/2.0/. * - * \file dlt-sortbytimestamp.cpp + * \file dlt-sortbytimestamp.c */ /******************************************************************************* ** ** -** SRC-MODULE: dlt-sortbytimestamp.cpp ** +** SRC-MODULE: dlt-sortbytimestamp.c ** ** ** ** TARGET : linux ** ** ** diff --git a/src/console/logstorage/dlt-logstorage-udev.c b/src/console/logstorage/dlt-logstorage-udev.c index e50e660..73b4d24 100644 --- a/src/console/logstorage/dlt-logstorage-udev.c +++ b/src/console/logstorage/dlt-logstorage-udev.c @@ -132,8 +132,8 @@ static char *dlt_logstorage_udev_get_mount_point(char *dev_node) * Check if the device was on the list, remove it and send the message * to the daemon. * - * @event The kind of event happening - * @part The device partition to be checked + * @param event The kind of event happening + * @param part The device partition to be checked * * @return 0 on success, -1 if an error occured. */ @@ -268,7 +268,7 @@ static int logstorage_udev_udevd_callback(void) * The function looks for block devices that are of "partition" type. * Then, it gets the node, and call check_mountpoint_from_partition with it. * - * @udev The udev device used to find all the nodes + * @param udev The udev device used to find all the nodes * * @return 0 on success, -1 otherwise. */ diff --git a/src/core_dump_handler/i686/dlt_cdh_cpuinfo.c b/src/core_dump_handler/i686/dlt_cdh_cpuinfo.c index aee7441..f11e45c 100644 --- a/src/core_dump_handler/i686/dlt_cdh_cpuinfo.c +++ b/src/core_dump_handler/i686/dlt_cdh_cpuinfo.c @@ -22,7 +22,7 @@ * \copyright Copyright © 2011-2015 BMW AG. \n * License MPL-2.0: Mozilla Public License version 2.0 http://mozilla.org/MPL/2.0/. * - * \file dlt_cdh_cpuinfo.c + * \file i686/dlt_cdh_cpuinfo.c */ #include "../dlt_cdh_cpuinfo.h" diff --git a/src/core_dump_handler/x86_64/dlt_cdh_cpuinfo.c b/src/core_dump_handler/x86_64/dlt_cdh_cpuinfo.c index f18720e..bd6be65 100644 --- a/src/core_dump_handler/x86_64/dlt_cdh_cpuinfo.c +++ b/src/core_dump_handler/x86_64/dlt_cdh_cpuinfo.c @@ -22,7 +22,7 @@ * \copyright Copyright © 2011-2015 BMW AG. \n * License MPL-2.0: Mozilla Public License version 2.0 http://mozilla.org/MPL/2.0/. * - * \file dlt_cdh_cpuinfo.c + * \file x86_64/dlt_cdh_cpuinfo.c */ #include "../dlt_cdh_cpuinfo.h" diff --git a/src/daemon/dlt_daemon_client.h b/src/daemon/dlt_daemon_client.h index 8406608..268371a 100644 --- a/src/daemon/dlt_daemon_client.h +++ b/src/daemon/dlt_daemon_client.h @@ -152,6 +152,8 @@ void dlt_daemon_control_get_default_log_level(int sock, DltDaemon *daemon, DltDa * @param sock connection handle used for sending response * @param daemon pointer to dlt daemon structure * @param daemon_local pointer to dlt daemon local structure + * @param overflow_counter Overflow counter + * @param apid Application ID * @param verbose if set to true verbose information is printed out. * @return -1 if there is an error or buffer overflow, else 0 */ diff --git a/src/daemon/dlt_daemon_common.h b/src/daemon/dlt_daemon_common.h index 507098a..a1e1d3e 100644 --- a/src/daemon/dlt_daemon_common.h +++ b/src/daemon/dlt_daemon_common.h @@ -240,7 +240,7 @@ DltDaemonRegisteredUsers *dlt_daemon_find_users_list(DltDaemon *daemon, /** * Loads the user saved configurations to daemon * @param daemon pointer to dlt daemon structure - * @param runtime directory path + * @param runtime_directory directory path * @param verbose if set to true verbose information is printed out * @return DLT_RETURN_OK on success, DLT_RETURN_ERROR otherwise */ @@ -488,7 +488,7 @@ void dlt_daemon_user_send_all_log_state(DltDaemon *daemon, int verbose); * @param filename1 name of file containing the runtime defaults for contexts * @param InitialContextLogLevel loglevel to be sent to context when those register with loglevel default, read from dlt.conf * @param InitialContextTraceStatus tracestatus to be sent to context when those register with tracestatus default, read from dlt.conf - * @param ForceLLTS force default log-level + * @param InitialEnforceLlTsStatus force default log-level * @param verbose if set to true verbose information is printed out. */ void dlt_daemon_control_reset_to_factory_default(DltDaemon *daemon, diff --git a/src/daemon/dlt_daemon_connection.c b/src/daemon/dlt_daemon_connection.c index 7973b9c..d936927 100644 --- a/src/daemon/dlt_daemon_connection.c +++ b/src/daemon/dlt_daemon_connection.c @@ -184,7 +184,7 @@ DLT_STATIC void dlt_connection_destroy_receiver(DltConnection *con) * Based on the connection type provided, this function returns the pointer * to the DltReceiver structure corresponding. * - * @param dameon_local Structure where to take the DltReceiver pointer from. + * @param daemon_local Structure where to take the DltReceiver pointer from. * @param type Type of the connection. * @param fd File descriptor * diff --git a/src/daemon/dlt_daemon_event_handler.c b/src/daemon/dlt_daemon_event_handler.c index b2af56b..d514c9d 100644 --- a/src/daemon/dlt_daemon_event_handler.c +++ b/src/daemon/dlt_daemon_event_handler.c @@ -59,7 +59,7 @@ * * That ensures that no event will be mis-watched. * - * @param pfd: The element to initialize + * @param pfd The element to initialize */ static void init_poll_fd(struct pollfd *pfd) { @@ -104,9 +104,9 @@ int dlt_daemon_prepare_event_handling(DltEventHandler *ev) * Adds a file descriptor to the descriptor list. If the list is to small, * increase its size. * - * @param ev: The event handler structure, containing the list - * @param fd: The file descriptor to add - * @param mask: The mask of event to be watched + * @param ev The event handler structure, containing the list + * @param fd The file descriptor to add + * @param mask The mask of event to be watched */ static void dlt_event_handler_enable_fd(DltEventHandler *ev, int fd, int mask) { @@ -138,8 +138,8 @@ static void dlt_event_handler_enable_fd(DltEventHandler *ev, int fd, int mask) * The file descriptor is removed from the descriptor list, the list is * compressed during the process. * - * @param ev: The event handler structure containing the list - * @param fd: The file descriptor to be removed + * @param ev The event handler structure containing the list + * @param fd The file descriptor to be removed */ static void dlt_event_handler_disable_fd(DltEventHandler *ev, int fd) { diff --git a/src/daemon/dlt_daemon_offline_logstorage.c b/src/daemon/dlt_daemon_offline_logstorage.c index 8a6dd75..7620ecd 100644 --- a/src/daemon/dlt_daemon_offline_logstorage.c +++ b/src/daemon/dlt_daemon_offline_logstorage.c @@ -38,7 +38,7 @@ * @param key Key * @param len Key length * @param ecuid ECU ID from key stored here - * @param apid Application ID as .* stored here + * @param appid Application ID as .* stored here * @param ctxid Context id as .* stored here * @return 0 on success -1 on error */ @@ -196,9 +196,11 @@ DLT_STATIC DltReturnValue dlt_logstorage_split_ecuid_apid(char *key, * Prepares keys with application ID alone, will use ecuid if provided * (ecuid:apid::) or (:apid::) * - * @param ecuid ECU ID - * @param apid Application ID * @param key Prepared key stored here + * @param len Key length + * @param ecuid ECU ID + * @param appid Application ID + * @param ctxid Context ID * @return None */ DLT_STATIC DltReturnValue dlt_logstorage_split_multi(char *key, @@ -251,6 +253,7 @@ DLT_STATIC DltReturnValue dlt_logstorage_split_multi(char *key, * @param key Given key of filter hash map * @param appid Application id * @param ctxid Context id + * @param ecuid ECU id * @return 0 on success, -1 on error */ DLT_STATIC DltReturnValue dlt_logstorage_split_key(char *key, char *appid, char *ctxid, char *ecuid) @@ -416,6 +419,7 @@ DLT_STATIC DltReturnValue dlt_daemon_logstorage_send_log_level(DltDaemon *daemon * * @param daemon DltDaemon structure * @param daemon_local DltDaemonLocal structure + * @param context DltDaemonContext structure * @param ecuid ECU ID * @param loglevel log level to be set to context * @param verbose If set to true verbose information is printed out @@ -466,6 +470,8 @@ DLT_STATIC DltReturnValue dlt_daemon_logstorage_reset_log_level(DltDaemon *daemo * * @param daemon DltDaemon structure * @param daemon_local DltDaemonLocal structure + * @param apid Application ID + * @param ctxid Context ID * @param ecuid ECU ID * @param loglevel log level to be set to context * @param verbose If set to true verbose information is printed out @@ -668,6 +674,7 @@ DltReturnValue dlt_logstorage_update_context(DltDaemon *daemon, * Update all contexts or particular context depending provided key * * @param daemon Pointer to DLT Daemon structure + * @param daemon_local Pointer to DLT Daemon Local structure * @param key Filter key stored in Hash Map * @param curr_log_level log level to be set to context * @param verbose If set to true verbose information is printed out diff --git a/src/daemon/dlt_daemon_offline_logstorage.h b/src/daemon/dlt_daemon_offline_logstorage.h index f9d587d..83d3470 100644 --- a/src/daemon/dlt_daemon_offline_logstorage.h +++ b/src/daemon/dlt_daemon_offline_logstorage.h @@ -121,13 +121,12 @@ void dlt_daemon_logstorage_update_application_loglevel(DltDaemon *daemon, * * @param daemon Pointer to Dlt Daemon structure * @param user_config DltDaemon configuration - * @param apid application id - * @param ctid context id - * @param log_level log level * @param data1 message header buffer * @param size1 message header buffer size - * @param data2 message data buffer - * @param size2 message data size + * @param data2 message extended data buffer + * @param size2 message extended data size + * @param data3 message data buffer + * @param size3 message data size */ void dlt_daemon_logstorage_write(DltDaemon *daemon, DltDaemonFlags *user_config, @@ -176,7 +175,7 @@ int dlt_daemon_logstorage_cleanup(DltDaemon *daemon, * * @param daemon Pointer to Dlt Daemon structure * @param daemon_local Pointer to Dlt Daemon Local structure - * @param mount_point Logstorage device mount point + * @param mnt_point Logstorage device mount point * @param verbose If set to true verbose information is printed out * @return 0 on success, -1 otherwise */ @@ -192,7 +191,7 @@ int dlt_daemon_logstorage_sync_cache(DltDaemon *daemon, * * @param daemon Pointer to Dlt Daemon structure * @param daemon_local Pointer to Dlt Daemon Local structure - * @param mount_point Logstorage device mount point + * @param mnt_point Logstorage device mount point * @param verbose If set to true verbose information is printed out * @return handle to Logstorage device on success, NULL otherwise */ diff --git a/src/daemon/dlt_daemon_socket.h b/src/daemon/dlt_daemon_socket.h index a9ac008..6a2f54e 100644 --- a/src/daemon/dlt_daemon_socket.h +++ b/src/daemon/dlt_daemon_socket.h @@ -72,7 +72,7 @@ int dlt_daemon_socket_send(int sock, void *data1, int size1, void *data2, int si /** * @brief dlt_daemon_socket_sendreliable - sends data to socket with additional checks and resending functionality - trying to be reliable * @param sock - * @param buffer + * @param data_buffer * @param message_size * @return on sucess: DLT_DAEMON_ERROR_OK, on error: DLT_DAEMON_ERROR_SEND_FAILED */ diff --git a/src/gateway/dlt_gateway.c b/src/gateway/dlt_gateway.c index 1dde171..1188e35 100644 --- a/src/gateway/dlt_gateway.c +++ b/src/gateway/dlt_gateway.c @@ -499,10 +499,10 @@ DLT_STATIC DltGatewayConf configuration_entries[GW_CONF_COUNT] = { /** * Check if gateway connection configuration parameter is valid. * - * @param g DltGateway - * @param c DltGatewayConnection - * @param key DltGatwayConnection property - * @param value specified property value from configuration file + * @param gateway DltGateway + * @param con DltGatewayConnection + * @param ctype DltGatwayConnection property + * @param value specified property value from configuration file * @return Value from DltReturnValue enum */ DLT_STATIC DltReturnValue dlt_gateway_check_param(DltGateway *gateway, @@ -524,9 +524,9 @@ DLT_STATIC DltReturnValue dlt_gateway_check_param(DltGateway *gateway, /** * Store gateway connection in internal data structure * - * @param g DltGatway - * @param tmp DltGatewayConnection - * @param verbose verbose flag + * @param gateway DltGatway + * @param tmp DltGatewayConnection + * @param verbose verbose flag * @return 0 on success, -1 otherwise */ int dlt_gateway_store_connection(DltGateway *gateway, @@ -947,7 +947,7 @@ DltReceiver *dlt_gateway_get_connection_receiver(DltGateway *gateway, int fd) * Parse GET_LOG_INFO * * @param daemon DltDaemon - * @param daemon_local DltDaemonLocal + * @param ecu Ecu ID * @param msg DltMessage * @param req 1 if requested from gateway, 0 otherwise * @param verbose verbose flag @@ -1074,6 +1074,7 @@ DLT_STATIC DltReturnValue dlt_gateway_parse_get_log_info(DltDaemon *daemon, * * @param daemon DltDaemon * @param daemon_local DltDaemonLocal + * @param ecu Ecu ID * @param msg DltMessage * @param verbose verbose flag * @return 0 on success, -1 otherwise diff --git a/src/gateway/dlt_gateway.h b/src/gateway/dlt_gateway.h index 553b9b1..8c0e39a 100644 --- a/src/gateway/dlt_gateway.h +++ b/src/gateway/dlt_gateway.h @@ -123,7 +123,8 @@ int dlt_gateway_process_passive_node_messages(DltDaemon *daemon, * Process gateway timer * * @param daemon DltDaemon - * @param daemon_loocal DltDaemonLocal + * @param daemon_local DltDaemonLocal + * @param rec DltReceiver * @param verbose verbose flag * @return 0 on success, -1 otherwise */ @@ -152,8 +153,10 @@ int dlt_gateway_forward_control_message(DltGateway *g, * Process on demand connect/disconnect of passive nodes * * @param g DltGateway + * @param daemon_local DltDaemonLocal * @param node_id Passive Node identifier * @param connection_status Connection status + * @param verbose verbose flag * @return 0 on success, -1 otherwise */ int dlt_gateway_process_on_demand_request(DltGateway *g, @@ -167,7 +170,7 @@ int dlt_gateway_process_on_demand_request(DltGateway *g, * * @param con DltGatewayConnection * @param control_msg DltPassiveControlMessage - * @param msg DltMessage + * @param data DltMessage * @param verbose verbose flag * @return 0 on success, -1 otherwise */ diff --git a/src/lib/dlt_env_ll.c b/src/lib/dlt_env_ll.c index 85d2250..31913c0 100644 --- a/src/lib/dlt_env_ll.c +++ b/src/lib/dlt_env_ll.c @@ -53,6 +53,8 @@ * assert(*tmp == ':'); * assert(res[3] == 'd'); * + * @param env Environment variable + * @param id Extracted ID * @return 0 if successful, -1 else */ int dlt_env_extract_id(char **const env, char *id) @@ -181,6 +183,8 @@ int dlt_env_extract_symbolic_ll(char **const env, int8_t *ll) * assert(*tmp == NULL); * assert(ll == 6); * + * @param env Environment variable + * @param ll Extracted log level * @return 0 if successful, -1 else */ int dlt_env_extract_ll(char **const env, int8_t *ll) diff --git a/src/lib/dlt_filetransfer.c b/src/lib/dlt_filetransfer.c index 3304ff6..8175e13 100644 --- a/src/lib/dlt_filetransfer.c +++ b/src/lib/dlt_filetransfer.c @@ -79,6 +79,7 @@ unsigned char buffer[BUFFER_SIZE]; /*!Get some information about the file size of a file */ /**See stat(2) for more informations. * @param file Absolute file path + * @param ok Result of stat * @return Returns the size of the file (if it is a regular file or a symbolic link) in bytes. */ uint32_t getFilesize(const char *file, int *ok) @@ -120,7 +121,7 @@ void stringHash(const char *str, uint32_t *hash) /*!Get some information about the file serial number of a file */ /** See stat(2) for more informations. * @param file Absolute file path - * @param value *ok == 0 -> error; *ok == 1 -> ok + * @param ok *ok == 0 -> error; *ok == 1 -> ok * @return Returns a unique number associated with each filename */ uint32_t getFileSerialNumber(const char *file, int *ok) @@ -147,6 +148,7 @@ uint32_t getFileSerialNumber(const char *file, int *ok) /*!Returns the creation date of a file */ /** See stat(2) for more informations. * @param file Absolute file path + * @param ok Result of stat * @return Returns the creation date of a file */ time_t getFileCreationDate(const char *file, int *ok) @@ -165,6 +167,8 @@ time_t getFileCreationDate(const char *file, int *ok) /*!Returns the creation date of a file */ /** Format of the creation date is Day Mon dd hh:mm:ss yyyy * @param file Absolute file path + * @param ok Result of stat + * @param date Local time * @return Returns the creation date of a file */ void getFileCreationDate2(const char *file, int *ok, char *date) @@ -206,7 +210,7 @@ void doTimeout(int timeout) /*!Checks free space of the user buffer */ /** - * @param returns -1 if more than 50% space in the user buffer is free. Otherwise 1 will be returned. + * @return -1 if more than 50% space in the user buffer is free. Otherwise 1 will be returned. */ int checkUserBufferForFreeSpace() { diff --git a/src/offlinelogstorage/dlt_offline_logstorage.c b/src/offlinelogstorage/dlt_offline_logstorage.c index 0eda630..072999e 100644 --- a/src/offlinelogstorage/dlt_offline_logstorage.c +++ b/src/offlinelogstorage/dlt_offline_logstorage.c @@ -85,6 +85,8 @@ DLT_STATIC void dlt_logstorage_filter_config_free(DltLogStorageFilterConfig *dat * Destroy Filter configurations list. * * @param list List of the filter configurations will be destroyed. + * @param uconfig User configurations for log file + * @param dev_path Path to the device * @param reason Reason for the destroying of Filter configurations list * @return 0 on success, -1 on error */ @@ -377,7 +379,7 @@ DLT_STATIC int dlt_logstorage_read_list_of_names(char **names, char *value) * Non-digit characters including spaces and out of boundary will lead to an * error -1. * - * @param file_name string to store the file name + * @param number Number to be read * @param value string given in config file * @return 0 on success, -1 on error */ @@ -476,7 +478,7 @@ DLT_STATIC int dlt_logstorage_get_keys_list(char *ids, char *sep, char **list, * dlt_logstorage_create_keys_only_ctid * * Prepares keys with context ID alone, will use ecuid if provided - * (ecuid::ctid) or (::ctid) + * (ecuid\:\:ctid) or (\:\:ctid) * * @param ecuid ECU ID * @param ctid Context ID @@ -609,15 +611,15 @@ DLT_STATIC void dlt_logstorage_create_keys_only_ecu(char *ecuid, char *key) * wildcard. This will be rejected. * * If lists given for application and/or context id, all possible combinations - * are returned as keys in a form "[apid][ctid], e.g. "APP1:CTX1". - * If wildcards are used, the non-wildcard value becomes the key, e.g. "APP1:" - * or ":CTX2". - * - * @param[in]: apids: string given from filter configuration - * @param[in]: ctids: string given from filter configuration - * @param[in]: ecuid: string given from filter configuration - * @param[out]: keys: keys to fill into hash table - * @param[out]: num_keys: number of keys + * are returned as keys in a form "[apid][ctid], e.g. "APP1\:CTX1". + * If wildcards are used, the non-wildcard value becomes the key, e.g. "APP1\:" + * or "\:CTX2". + * + * @param[in] apids string given from filter configuration + * @param[in] ctids string given from filter configuration + * @param[in] ecuid string given from filter configuration + * @param[out] keys keys to fill into hash table + * @param[out] num_keys number of keys * @return: 0 on success, error on failure* */ DLT_STATIC int dlt_logstorage_create_keys(char *apids, @@ -713,7 +715,7 @@ DLT_STATIC int dlt_logstorage_create_keys(char *apids, * Prepares hash table with keys and data * * @param handle DLT Logstorage handle - * @param tmp_data Holds all other configuration values + * @param data Holds all other configuration values * @return 0 on success, -1 on error */ DLT_STATIC int dlt_logstorage_prepare_table(DltLogStorage *handle, @@ -1549,7 +1551,7 @@ DLT_STATIC int dlt_logstorage_store_filters(DltLogStorage *handle, * * Combination of two wildcards is not allowed. * - * @param input_file pointer to configuration file stored on device + * @param handle DLT Logstorage handle * @return 0 on success, -1 on error, 1 on warning */ DLT_STATIC int dlt_logstorage_load_config(DltLogStorage *handle) @@ -1732,6 +1734,7 @@ int dlt_logstorage_get_loglevel_by_key(DltLogStorage *handle, char *key) * @param config [out] Pointer to array of filter configurations * @param apid application id * @param ctid context id + * @param ecuid ecu id * @return number of configurations found */ int dlt_logstorage_get_config(DltLogStorage *handle, @@ -1916,11 +1919,13 @@ DLT_STATIC int dlt_logstorage_filter(DltLogStorage *handle, * configuration. * * @param handle DltLogStorage handle - * @param config User configurations for log file + * @param uconfig User configurations for log file * @param data1 Data buffer of message header * @param size1 Size of message header buffer - * @param data2 Data buffer of message body - * @param size2 Size of message body + * @param data2 Data buffer of extended message body + * @param size2 Size of extended message body + * @param data3 Data buffer of message body + * @param size3 Size of message body * @return 0 on success or write errors < max write errors, -1 on error */ int dlt_logstorage_write(DltLogStorage *handle, diff --git a/src/offlinelogstorage/dlt_offline_logstorage.h b/src/offlinelogstorage/dlt_offline_logstorage.h index 33f55f6..2d55bb8 100644 --- a/src/offlinelogstorage/dlt_offline_logstorage.h +++ b/src/offlinelogstorage/dlt_offline_logstorage.h @@ -270,8 +270,9 @@ int dlt_logstorage_device_disconnected(DltLogStorage *handle, * * @param handle DltLogStorage handle * @param config Pointer to array of filter configurations - * @param appid application id - * @param ctxid context id + * @param apid application id + * @param ctid context id + * @param ecutid ecu id * @return number of found configurations */ int dlt_logstorage_get_config(DltLogStorage *handle, @@ -303,8 +304,10 @@ int dlt_logstorage_get_loglevel_by_key(DltLogStorage *handle, char *key); * @param uconfig User configurations for log file * @param data1 Data buffer of message header * @param size1 Size of message header buffer - * @param data2 Data buffer of message body - * @param size2 Size of message body + * @param data2 Data buffer of extended message body + * @param size2 Size of extended message body + * @param data3 Data buffer of message body + * @param size3 Size of message body * @return 0 on success or write errors < max write errors, -1 on error */ int dlt_logstorage_write(DltLogStorage *handle, diff --git a/src/offlinelogstorage/dlt_offline_logstorage_behavior.c b/src/offlinelogstorage/dlt_offline_logstorage_behavior.c index 64ba153..e7dbec1 100644 --- a/src/offlinelogstorage/dlt_offline_logstorage_behavior.c +++ b/src/offlinelogstorage/dlt_offline_logstorage_behavior.c @@ -38,7 +38,7 @@ * dlt_logstorage_log_file_name * * Create log file name in the form configured by the user - * .dlt + * \\\\\.dlt * * filename: given in configuration file * delimiter: Punctuation characters (configured in dlt.conf) @@ -767,6 +767,8 @@ int dlt_logstorage_prepare_on_msg(DltLogStorageFilterConfig *config, * Write the log message. * * @param config DltLogStorageFilterConfig + * @param file_config DltLogStorageUserConfig + * @param dev_path Path to device * @param data1 header * @param size1 header size * @param data2 storage header diff --git a/src/shared/dlt_config_file_parser.c b/src/shared/dlt_config_file_parser.c index d73d445..a264baa 100644 --- a/src/shared/dlt_config_file_parser.c +++ b/src/shared/dlt_config_file_parser.c @@ -253,6 +253,7 @@ static int dlt_config_file_line_has_section(char *line) * Extract section name from line * * @param line Line in configuration file containing a section header + * @param name Section name * @return 0 on success, else -1 */ static int dlt_config_file_get_section_name_from_string(char *line, char *name) diff --git a/src/shared/dlt_config_file_parser.h b/src/shared/dlt_config_file_parser.h index 45fd150..98aef03 100644 --- a/src/shared/dlt_config_file_parser.h +++ b/src/shared/dlt_config_file_parser.h @@ -117,7 +117,7 @@ void dlt_config_file_release(DltConfigFile *file); * * @param[in] file DltConfigFile * @param[in] num Number of section - * @param[out] section Section name + * @param[out] name Section name * @return 0 on success, else -1 */ int dlt_config_file_get_section_name(const DltConfigFile *file, -- cgit v1.2.1