From 9e365069afe156f33fadfad9705e1325f894cd54 Mon Sep 17 00:00:00 2001
From: Campbell Barton <ideasman42@gmail.com>
Date: Thu, 9 Dec 2021 20:01:44 +1100
Subject: 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
---
 source/blender/blenlib/intern/BLI_heap.c | 31 -------------------------------
 1 file changed, 31 deletions(-)

(limited to 'source/blender/blenlib/intern/BLI_heap.c')

diff --git a/source/blender/blenlib/intern/BLI_heap.c b/source/blender/blenlib/intern/BLI_heap.c
index a221820d4c4..efa0110ed53 100644
--- a/source/blender/blenlib/intern/BLI_heap.c
+++ b/source/blender/blenlib/intern/BLI_heap.c
@@ -193,11 +193,6 @@ static void heap_node_free(Heap *heap, HeapNode *node)
 /** \name Public Heap API
  * \{ */
 
-/**
- * Creates a new heap. Removed nodes are recycled, so memory usage will not shrink.
- *
- * \note Use when the size of the heap is known in advance.
- */
 Heap *BLI_heap_new_ex(uint tot_reserve)
 {
   Heap *heap = MEM_mallocN(sizeof(Heap), __func__);
@@ -261,10 +256,6 @@ void BLI_heap_clear(Heap *heap, HeapFreeFP ptrfreefp)
   heap->nodes.free = NULL;
 }
 
-/**
- * Insert heap node with a value (often a 'cost') and pointer into the heap,
- * duplicate values are allowed.
- */
 HeapNode *BLI_heap_insert(Heap *heap, float value, void *ptr)
 {
   HeapNode *node;
@@ -289,9 +280,6 @@ HeapNode *BLI_heap_insert(Heap *heap, float value, void *ptr)
   return node;
 }
 
-/**
- * Convenience function since this is a common pattern.
- */
 void BLI_heap_insert_or_update(Heap *heap, HeapNode **node_p, float value, void *ptr)
 {
   if (*node_p == NULL) {
@@ -312,19 +300,11 @@ uint BLI_heap_len(const Heap *heap)
   return heap->size;
 }
 
-/**
- * Return the top node of the heap.
- * This is the node with the lowest value.
- */
 HeapNode *BLI_heap_top(const Heap *heap)
 {
   return heap->tree[0];
 }
 
-/**
- * Return the value of top node of the heap.
- * This is the node with the lowest value.
- */
 float BLI_heap_top_value(const Heap *heap)
 {
   BLI_assert(heap->size != 0);
@@ -332,9 +312,6 @@ float BLI_heap_top_value(const Heap *heap)
   return heap->tree[0]->value;
 }
 
-/**
- * Pop the top node off the heap and return its pointer.
- */
 void *BLI_heap_pop_min(Heap *heap)
 {
   BLI_assert(heap->size != 0);
@@ -366,11 +343,6 @@ void BLI_heap_remove(Heap *heap, HeapNode *node)
   BLI_heap_pop_min(heap);
 }
 
-/**
- * Can be used to avoid #BLI_heap_remove, #BLI_heap_insert calls,
- * balancing the tree still has a performance cost,
- * but is often much less than remove/insert, difference is most noticeable with large heaps.
- */
 void BLI_heap_node_value_update(Heap *heap, HeapNode *node, float value)
 {
   if (value < node->value) {
@@ -427,9 +399,6 @@ static bool heap_is_minheap(const Heap *heap, uint root)
   }
   return true;
 }
-/**
- * Only for checking internal errors (gtest).
- */
 bool BLI_heap_is_valid(const Heap *heap)
 {
   return heap_is_minheap(heap, 0);
-- 
cgit v1.2.3