trace: add doxygen comments

baresip · Jan 18, 2023 · 41e21dd · 41e21dd
1 parent c4cfd97
commit 41e21dd
Showing 1 changed file with 17 additions and 0 deletions.
diff --git a/src/trace/trace.c b/src/trace/trace.c
@@ -93,6 +93,13 @@ static inline int get_process_id(void)
 }
 
 
+/**
+ * Init new trace json file
+ *
+ * @param json_file  json file for trace events
+ *
+ * @return 0 if success, otherwise errorcode
+ */
 int re_trace_init(const char *json_file)
 {
 	int err = 0;
@@ -144,6 +151,11 @@ int re_trace_init(const char *json_file)
 }
 
 
+/**
+ * Close and flush trace file
+ *
+ * @return 0 if success, otherwise errorcode
+ */
 int re_trace_close(void)
 {
 	int err = 0;
@@ -172,6 +184,11 @@ int re_trace_close(void)
 }
 
 
+/**
+ * Flush trace buffer (can be called multiple times)
+ *
+ * @return 0 if success, otherwise errorcode
+ */
 int re_trace_flush(void)
 {
 	int i, flush_count;