From 0f8eb6dc43495b0effc6ed180e8b4d56f0934181 Mon Sep 17 00:00:00 2001 From: Steffan 'Ikslorin' Soelvsten <201505832@post.au.dk> Date: Sun, 6 Jun 2021 11:06:24 +0200 Subject: [PATCH] Add tpie::priority_queue(mm_avail) to documentation (closes #244) --- tpie/priority_queue.h | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/tpie/priority_queue.h b/tpie/priority_queue.h index d5191bcc8..d69d8798f 100644 --- a/tpie/priority_queue.h +++ b/tpie/priority_queue.h @@ -82,18 +82,20 @@ class priority_queue { static constexpr float default_blocksize = 0.0625; /////////////////////////////////////////////////////////////////////////// - /// \brief Constructor. + /// \brief Constructor with fractional amount of internal memory to use. /// /// \param f Factor of memory that the priority queue is allowed to use. /// \param b Block factor /////////////////////////////////////////////////////////////////////////// priority_queue(double f=1.0, float b=default_blocksize, stream_size_type n = std::numeric_limits::max()); -#ifndef DOXYGEN - // \param mmavail Number of bytes the priority queue is allowed to use. - // \param b Block factor + /////////////////////////////////////////////////////////////////////////// + /// \brief Constructor with absolute amount of internal memory to use. + /// + /// \param mmavail Number of bytes the priority queue is allowed to use. + /// \param b Block factor + /////////////////////////////////////////////////////////////////////////// priority_queue(memory_size_type mm_avail, float b=default_blocksize, stream_size_type n = std::numeric_limits::max()); -#endif ///////////////////////////////////////////////////////// ///