[Bf-blender-cvs] [502eb15eb73] temp-inplace-priority-queue: improve comments

[Jacques Lucke]

Commit: 502eb15eb7319508c3acbc1eb7b078829d7b9757
Author: Jacques Lucke
Date:   Wed Dec 16 11:56:38 2020 +0100
Branches: temp-inplace-priority-queue
https://developer.blender.org/rB502eb15eb7319508c3acbc1eb7b078829d7b9757

improve comments

===================================================================

M	source/blender/blenlib/BLI_inplace_priority_queue.hh

===================================================================

diff --git a/source/blender/blenlib/BLI_inplace_priority_queue.hh b/source/blender/blenlib/BLI_inplace_priority_queue.hh
index bd5a49c3b65..a5fc5d3168b 100644
--- a/source/blender/blenlib/BLI_inplace_priority_queue.hh
+++ b/source/blender/blenlib/BLI_inplace_priority_queue.hh
@@ -95,6 +95,8 @@ class InplacePriorityQueue {
 
   /**
    * Get the element with the highest priority in the priority queue.
+   * The returned reference is const, because the priority queue has read-only access to the
+   * underlying data. If you need a mutable reference, use #peek_index instead.
    */
   const T &peek() const
   {
@@ -103,6 +105,8 @@ class InplacePriorityQueue {
 
   /**
    * Get the element with the highest priority in the priority queue and remove it.
+   * The returned reference is const, because the priority queue has read-only access to the
+   * underlying data. If you need a mutable reference, use #pop_index instead.
    */
   const T &pop()
   {