summaryrefslogtreecommitdiff
path: root/include/dlt/dlt_offline_trace.h
diff options
context:
space:
mode:
authorSaya Sugiura <ssugiura@jp.adit-jv.com>2019-07-08 16:25:05 +0900
committerSaya Sugiura <39760799+ssugiura@users.noreply.github.com>2019-07-19 14:46:29 +0900
commit0d3cd872a6ab5a14cfb66bb7faa5a6d83ad3c5ea (patch)
treec766a223d631df369d8939c4ec1d38fa1a1b3e67 /include/dlt/dlt_offline_trace.h
parent868d212f5de18d084f5bcb88154ee7bad77ca71b (diff)
downloadDLT-daemon-0d3cd872a6ab5a14cfb66bb7faa5a6d83ad3c5ea.tar.gz
doxygen: Get rid of warnings
Signed-off-by: Saya Sugiura <ssugiura@jp.adit-jv.com>
Diffstat (limited to 'include/dlt/dlt_offline_trace.h')
-rw-r--r--include/dlt/dlt_offline_trace.h18
1 files changed, 9 insertions, 9 deletions
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);