Add a Doxyfile and preliminary module-level docs.

This commit is contained in:
2024-02-20 21:41:37 -05:00
parent 17b92126de
commit 450b07fd08
30 changed files with 2868 additions and 0 deletions

View File

@ -1,5 +1,13 @@
#pragma once
/**
** \defgroup trace Performance Tracing
** Generates trace output that is compatible with speedscope.app,
** chrome://tracing or ui.perfetto.dev for scrutining what each thread is doing
** for optimization purposes.
** @{
*/
#include <inttypes.h>
#include <stddef.h>
@ -22,3 +30,5 @@ void tf_trace_set_write_callback(tf_trace_t* trace, tf_trace_write_callback_t* c
void tf_trace_raw(tf_trace_t* trace, const char* buffer, size_t size);
void tf_trace_sqlite(tf_trace_t* trace, sqlite3* sqlite);
/** @} */