tests.h and tlscontext.js.h docs.

This commit is contained in:
Cory McWilliams 2024-02-28 21:18:59 -05:00
parent 72dae14f87
commit c991763b00
2 changed files with 29 additions and 0 deletions

View File

@ -6,12 +6,21 @@
** @{ ** @{
*/ */
/**
** Options to control how tests are run.
*/
typedef struct _tf_test_options_t typedef struct _tf_test_options_t
{ {
/** The path to the Tilde Friends executable, in order to run subprocesses. */
const char* exe_path; const char* exe_path;
/** A comma-separated list of tests to run, or NULL. */
const char* tests; const char* tests;
} tf_test_options_t; } tf_test_options_t;
/**
** Run tests.
** @param options Test options.
*/
void tf_tests(const tf_test_options_t* options); void tf_tests(const tf_test_options_t* options);
/** @} */ /** @} */

View File

@ -8,10 +8,30 @@
#include "quickjs.h" #include "quickjs.h"
/**
** A TLS context instance.
*/
typedef struct _tf_tls_context_t tf_tls_context_t; typedef struct _tf_tls_context_t tf_tls_context_t;
/**
** Register TLS script interface.
** @param context The TLS context.
** @return the TlsContext constructor.
*/
JSValue tf_tls_context_register(JSContext* context); JSValue tf_tls_context_register(JSContext* context);
/**
** Get a TLS context instance from its JS object.
** @param value A TlsContext JS object.
** @return The corresponding instance.
*/
tf_tls_context_t* tf_tls_context_get(JSValue value); tf_tls_context_t* tf_tls_context_get(JSValue value);
/**
** Get the number of active TLS context instances.
** @return The number of TlsContext objects created that have not been
** finalized.
*/
int tf_tls_context_get_count(); int tf_tls_context_get_count();
/** @} */ /** @} */