From 6e8177dae93f592b1d39cd6d6e77c9e6f254360f Mon Sep 17 00:00:00 2001 From: Danny Holman Date: Fri, 25 Oct 2024 23:02:31 -0500 Subject: core: add documentation comments to API functions Add documentation comments to the functions and structures exposed through the Rune API. Signed-off-by: Danny Holman --- include/rune/core/init.h | 22 +++++++++++++++++++--- 1 file changed, 19 insertions(+), 3 deletions(-) (limited to 'include/rune/core/init.h') diff --git a/include/rune/core/init.h b/include/rune/core/init.h index 3aef63c..50f7188 100644 --- a/include/rune/core/init.h +++ b/include/rune/core/init.h @@ -19,12 +19,28 @@ * 3. This notice may not be removed or altered from any source distribution. */ -#ifndef RUNE_INIT_H -#define RUNE_INIT_H +#ifndef RUNE_CORE_INIT_H +#define RUNE_CORE_INIT_H #include -RAPI struct rune_window* rune_init(uint32_t width, uint32_t height, const char *title); +/** + * \brief Main point of initialization, must be called before any other engine + * function + * \param[in] argc The same argc defined in the program's main function + * \param[in] argv The same argv defined in the program's main function + * \return 0, or a negative number indicating the error + */ +RAPI int rune_init(int argc, char* argv[]); + +/** + * \brief Shuts down the engine and cleans up any remaining memory + */ RAPI void rune_exit(void); +/** + * \brief Hot-reloads the entire engine library from disk + */ +RAPI int rune_hot_reload(void); + #endif -- cgit v1.2.3