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,12 @@
#pragma once
/**
** \defgroup ssb_connections SSB Connections
** Primitive tracking for SSB connections, as in we tried to connect to host X
** Y seconds ago, and it failed. This needs to be replaced with something better.
** @{
*/
typedef struct _tf_ssb_t tf_ssb_t;
typedef struct _tf_ssb_connections_t tf_ssb_connections_t;
@ -9,3 +16,5 @@ void tf_ssb_connections_destroy(tf_ssb_connections_t* connections);
void tf_ssb_connections_store(tf_ssb_connections_t* connections, const char* host, int port, const char* key);
void tf_ssb_connections_set_attempted(tf_ssb_connections_t* connections, const char* host, int port, const char* key);
void tf_ssb_connections_set_succeeded(tf_ssb_connections_t* connections, const char* host, int port, const char* key);
/** @} */