clarified comment

This commit is contained in:
Richard Thier 2024-09-29 18:21:26 +02:00
parent 3fe5391401
commit 646189d60c

View File

@ -176,8 +176,6 @@ typedef struct do_not_save_charptr do_not_save_charptr;
* SLC_SYM_GET Gets the symbol at key (the word parameter is unused). Returns NULL if there is no word for the key. * SLC_SYM_GET Gets the symbol at key (the word parameter is unused). Returns NULL if there is no word for the key.
* SLC_SYM_ERASE Erases the symbol table so it becomes empty again. Can never fail, returns NULL. * SLC_SYM_ERASE Erases the symbol table so it becomes empty again. Can never fail, returns NULL.
* *
* Rem.: On GET we return a word* in case the key is to a word and a regular uint32_t* if its a variable name!
*
* @param op Defines which operation the caller wants. * @param op Defines which operation the caller wants.
* @param key The key (both for SET and GET). This pointer can get easily invalidated so you might need a copy or you do Trie, etc. * @param key The key (both for SET and GET). This pointer can get easily invalidated so you might need a copy or you do Trie, etc.
* @param ptr When adding a found word/variable to the symbol table, the key will point to this word* or uint32_t* * @param ptr When adding a found word/variable to the symbol table, the key will point to this word* or uint32_t*