diff options
author | Robin Haberkorn <robin.haberkorn@googlemail.com> | 2025-04-08 22:32:52 +0300 |
---|---|---|
committer | Robin Haberkorn <robin.haberkorn@googlemail.com> | 2025-04-08 23:59:21 +0300 |
commit | a7e66807871c70a99909fcf78335309ae1505055 (patch) | |
tree | 8bb3e48adea662b9d698cc24ffadb714e4b8fcde /src/goto-commands.c | |
parent | 44307bd7998e5f1fc81d63d74edaf4756ddf5a47 (diff) | |
download | sciteco-a7e66807871c70a99909fcf78335309ae1505055.tar.gz |
minor improvements of TECO_DEFINE_STATE_COMMENT() documentation
All state definition macros document their "base" states as well
since they form an inheritance hierarchy.
Diffstat (limited to 'src/goto-commands.c')
-rw-r--r-- | src/goto-commands.c | 8 |
1 files changed, 6 insertions, 2 deletions
diff --git a/src/goto-commands.c b/src/goto-commands.c index bf5743e..e335c70 100644 --- a/src/goto-commands.c +++ b/src/goto-commands.c @@ -193,11 +193,15 @@ TECO_DEFINE_STATE_EXPECTSTRING(teco_state_goto, .insert_completion_cb = (teco_state_insert_completion_cb_t)teco_state_goto_insert_completion ); -/* +/** + * @interface TECO_DEFINE_STATE_COMMENT + * @implements TECO_DEFINE_STATE + * @ingroup states + * * True comments: * They don't add entries to the goto table. * - * NOTE: This still needs some special handling in the Scintilla lexer + * @note This still needs some special handling in the Scintilla lexer * (for syntax highlighting) since comments always start with `!`. */ #define TECO_DEFINE_STATE_COMMENT(NAME, ...) \ |