diff options
| author | sternenseemann <0rpkxez4ksa01gb3typccl0i@systemli.org> | 2020-12-20 21:36:04 +0100 |
|---|---|---|
| committer | sternenseemann <0rpkxez4ksa01gb3typccl0i@systemli.org> | 2020-12-20 21:36:04 +0100 |
| commit | 7eec59dc976e5ce167d47562712068e9c089a034 (patch) | |
| tree | 1a473dbdaae4c69ac7b2fee5e2e8526cc254a26c | |
| parent | ca8b1996e80bc82ce2b14cb955dbc79dc30e1086 (diff) | |
doc(buchstabensuppe.h): minor steps towards doxygen
| -rw-r--r-- | Makefile | 1 | ||||
| -rw-r--r-- | include/buchstabensuppe.h | 16 |
2 files changed, 16 insertions, 1 deletions
diff --git a/Makefile b/Makefile index ec0461a..c4b8027 100644 --- a/Makefile +++ b/Makefile @@ -10,6 +10,7 @@ all: clean: rm -f *.o *.a *.exe third_party/stb_truetype.o + rm -rf doc/html check: redo test.exe diff --git a/include/buchstabensuppe.h b/include/buchstabensuppe.h index b2657d6..fc24698 100644 --- a/include/buchstabensuppe.h +++ b/include/buchstabensuppe.h @@ -1,3 +1,6 @@ +/*! + * @file buchstabensuppe.h + */ #ifndef BUCHSTABENSUPPE_H #define BUCHSTABENSUPPE_H @@ -11,6 +14,10 @@ // buffers +/*! + * @name UTF-32 Buffer API + * @{ + */ typedef struct bs_utf32_buffer { uint32_t *bs_utf32_buffer; size_t bs_utf32_buffer_len; @@ -27,7 +34,12 @@ bool bs_utf32_buffer_append_single(uint32_t, bs_utf32_buffer_t *); bs_utf32_buffer_t bs_decode_utf8(const char *, size_t); -// main buchstabensuppe api +//! @} + +/*! + * @name Font Rendering + * @{ + */ typedef struct bs_font { hb_font_t *bs_font_hb; @@ -67,4 +79,6 @@ bool bs_render_grapheme_append(bs_context_t *, bs_bitmap_t *, bs_cursor_t *, bool bs_render_utf32_string_append(bs_context_t *, bs_bitmap_t *, bs_cursor_t *, bs_utf32_buffer_t); +//! @} + #endif |