diff options
author | Campbell Barton <ideasman42@gmail.com> | 2021-12-09 12:01:44 +0300 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2021-12-09 12:01:44 +0300 |
commit | 9e365069afe156f33fadfad9705e1325f894cd54 (patch) | |
tree | 78373044d029feb51f987b45208e0c1a36958625 /source/blender/blenlib/intern/BLI_heap_simple.c | |
parent | d8b42751625c915113b64f5a2d9c72f19f009fee (diff) |
Cleanup: move public doc-strings into headers for 'blenlib'
- Added space below non doc-string comments to make it clear
these aren't comments for the symbols directly below them.
- Use doxy sections for some headers.
- Minor improvements to doc-strings.
Ref T92709
Diffstat (limited to 'source/blender/blenlib/intern/BLI_heap_simple.c')
-rw-r--r-- | source/blender/blenlib/intern/BLI_heap_simple.c | 15 |
1 files changed, 0 insertions, 15 deletions
diff --git a/source/blender/blenlib/intern/BLI_heap_simple.c b/source/blender/blenlib/intern/BLI_heap_simple.c index c075a2f8643..f285dd074c3 100644 --- a/source/blender/blenlib/intern/BLI_heap_simple.c +++ b/source/blender/blenlib/intern/BLI_heap_simple.c @@ -147,11 +147,6 @@ static void heapsimple_up(HeapSimple *heap, uint i, float active_val, void *acti /** \name Public HeapSimple API * \{ */ -/** - * Creates a new simple heap, which only supports insertion and removal from top. - * - * \note Use when the size of the heap is known in advance. - */ HeapSimple *BLI_heapsimple_new_ex(uint tot_reserve) { HeapSimple *heap = MEM_mallocN(sizeof(HeapSimple), __func__); @@ -190,10 +185,6 @@ void BLI_heapsimple_clear(HeapSimple *heap, HeapSimpleFreeFP ptrfreefp) heap->size = 0; } -/** - * Insert heap node with a value (often a 'cost') and pointer into the heap, - * duplicate values are allowed. - */ void BLI_heapsimple_insert(HeapSimple *heap, float value, void *ptr) { if (UNLIKELY(heap->size >= heap->bufsize)) { @@ -214,9 +205,6 @@ uint BLI_heapsimple_len(const HeapSimple *heap) return heap->size; } -/** - * Return the lowest value of the heap. - */ float BLI_heapsimple_top_value(const HeapSimple *heap) { BLI_assert(heap->size != 0); @@ -224,9 +212,6 @@ float BLI_heapsimple_top_value(const HeapSimple *heap) return heap->tree[0].value; } -/** - * Pop the top node off the heap and return its pointer. - */ void *BLI_heapsimple_pop_min(HeapSimple *heap) { BLI_assert(heap->size != 0); |