diff options
author | Campbell Barton <ideasman42@gmail.com> | 2021-12-20 11:01:14 +0300 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2021-12-20 11:07:10 +0300 |
commit | fdb2167b4ad9f140708e38bfcc30fdbd3168bf1e (patch) | |
tree | 5d4ef81b5364de8ff13698cd719bcc43a49d19d7 /source/blender/blenlib/BLI_linklist_lockfree.h | |
parent | 5c63c0a58ca34d12cf70bf0021cf851f4e6192d6 (diff) |
Docs: use doxygen formatting for BLI
Differentiate doc-strings from title/section text.
Diffstat (limited to 'source/blender/blenlib/BLI_linklist_lockfree.h')
-rw-r--r-- | source/blender/blenlib/BLI_linklist_lockfree.h | 11 |
1 files changed, 6 insertions, 5 deletions
diff --git a/source/blender/blenlib/BLI_linklist_lockfree.h b/source/blender/blenlib/BLI_linklist_lockfree.h index 142fa1cf243..d2083bdd44e 100644 --- a/source/blender/blenlib/BLI_linklist_lockfree.h +++ b/source/blender/blenlib/BLI_linklist_lockfree.h @@ -48,18 +48,19 @@ typedef void (*LockfreeeLinkNodeFreeFP)(void *link); /* NOTE: These functions are NOT safe for use from threads. */ /* NOTE: !!! I REPEAT: DO NOT USE THEM WITHOUT EXTERNAL LOCK !!! */ -/* Make list ready for lock-free access. */ +/** Make list ready for lock-free access. */ void BLI_linklist_lockfree_init(LockfreeLinkList *list); -/* Completely free the whole list, it is NOT re-usable after this. */ +/** Completely free the whole list, it is NOT re-usable after this. */ void BLI_linklist_lockfree_free(LockfreeLinkList *list, LockfreeeLinkNodeFreeFP free_func); -/* Remove all the elements from the list, keep it usable for further - * inserts. +/** + * Remove all the elements from the list, keep it usable for further inserts. */ void BLI_linklist_lockfree_clear(LockfreeLinkList *list, LockfreeeLinkNodeFreeFP free_func); -/* Begin iteration of lock-free linked list, starting with a +/** + * Begin iteration of lock-free linked list, starting with a * first user=defined node. Will ignore the dummy node. */ LockfreeLinkNode *BLI_linklist_lockfree_begin(LockfreeLinkList *list); |