diff options
Diffstat (limited to 'include')
| -rw-r--r-- | include/dlt/dlt_client.h | 16 | ||||
| -rw-r--r-- | include/dlt/dlt_common.h | 11 | ||||
| -rw-r--r-- | include/dlt/dlt_offline_trace.h | 18 | ||||
| -rw-r--r-- | include/dlt/dlt_user.h | 11 |
4 files changed, 30 insertions, 26 deletions
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 <port> when starting dlt-daemon + * The standard TCP Port used for DLT daemon, can be overwritten via -p \<port\> 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 <dir> on the console + * behaves like calling mkdir -p \<dir\> 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, |