From e48d750b340045698ddee65472cc885480766ca7 Mon Sep 17 00:00:00 2001 From: Tom Henderson Date: Tue, 2 Oct 2018 16:39:28 -0700 Subject: [PATCH] network: Clarify some Queue documentation --- src/network/utils/queue.h | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/src/network/utils/queue.h b/src/network/utils/queue.h index bfcd2fe1e..54d0f8157 100644 --- a/src/network/utils/queue.h +++ b/src/network/utils/queue.h @@ -232,7 +232,10 @@ private: * Queue is a template class. The type of the objects stored within the queue * is specified by the type parameter, which can be any class providing a * GetSize () method (e.g., Packet, QueueDiscItem, etc.). Subclasses need to - * implement the DoEnqueue, DoDequeue, DoRemove and DoPeek methods. + * implement the Enqueue, Dequeue, Remove and Peek methods, and are + * encouraged to leverage the DoEnqueue, DoDequeue, DoRemove, and DoPeek + * methods in doing so, to ensure that appropriate trace sources are called + * and statistics are maintained. * * Users of the Queue template class usually hold a queue through a smart pointer, * hence forward declaration is recommended to avoid pulling the implementation