From 5234bf81495bea84e6aecac40c19236b0ba3befd Mon Sep 17 00:00:00 2001 From: NishiOwO Date: Tue, 15 Apr 2025 16:57:26 +0900 Subject: [PATCH] adding more docs --- engine/include/gf_type/core.h | 6 ++++++ engine/include/gf_type/graphic.h | 23 +++++++++++++++++++++++ engine/include/gf_type/version.h | 2 +- 3 files changed, 30 insertions(+), 1 deletion(-) diff --git a/engine/include/gf_type/core.h b/engine/include/gf_type/core.h index a518fd4..7e5149e 100644 --- a/engine/include/gf_type/core.h +++ b/engine/include/gf_type/core.h @@ -32,6 +32,12 @@ * @var gf_engine_t::draw * @brief Draw part * @todo Create gf_client_t and move draw there + * + * @var gf_engine_t::log + * @brief Log output + * @note Default is `stderr` + * @warning This is `NULL` when logger is using graphical console + * @warning Destroying engien instance **does not** `fclose` this */ GF_DECLARE_TYPE(engine, { gf_physics_t* physics; diff --git a/engine/include/gf_type/graphic.h b/engine/include/gf_type/graphic.h index 4b155c6..80bc700 100644 --- a/engine/include/gf_type/graphic.h +++ b/engine/include/gf_type/graphic.h @@ -1,3 +1,9 @@ +/** + * @file gf_type/graphic.h + * @~english + * @brief Type definitions related to graphic interface + */ + #ifndef __GF_TYPE_GRAPHIC_H__ #define __GF_TYPE_GRAPHIC_H__ @@ -11,6 +17,23 @@ /* Standard */ +/** + * @struct gf_color_t + * @~english + * @brief Color + * + * @var gf_color_t::r + * @brief Red + * + * @var gf_color_t::g + * @brief Green + * + * @var gf_color_t::b + * @brief Blue + * + * @var gf_color_t::a + * @brief Alpha + */ GF_DECLARE_TYPE(color, { double r; double g; diff --git a/engine/include/gf_type/version.h b/engine/include/gf_type/version.h index bd13878..cd1c7c4 100644 --- a/engine/include/gf_type/version.h +++ b/engine/include/gf_type/version.h @@ -18,7 +18,7 @@ /* Standard */ /** - * @typedef gf_version_t + * @struct gf_version_t * @~english * @brief Version *