From 49de6e2012280b0eabb6e9e09a428e0a59ddbcd6 Mon Sep 17 00:00:00 2001 From: Jeffrey Walton Date: Wed, 16 Dec 2015 03:22:22 -0500 Subject: Updated documentation --- queue.h | 18 +++++++++++++++--- 1 file changed, 15 insertions(+), 3 deletions(-) (limited to 'queue.h') diff --git a/queue.h b/queue.h index 570a26d9..88a3b8d4 100644 --- a/queue.h +++ b/queue.h @@ -12,15 +12,23 @@ NAMESPACE_BEGIN(CryptoPP) -/** The queue is implemented as a linked list of byte arrays, but you don't need to - know about that. So just ignore this next line. :) */ class ByteQueueNode; -//! Byte Queue +//! \class ByteQueue +//! \brief Data structure used to store byte strings +//! \details The queue is implemented as a linked list of byte arrays class CRYPTOPP_DLL ByteQueue : public Bufferless { public: + //! \brief Construct a ByteQueue + //! \param nodeSize the initial node size + //! \details Internally, ByteQueue uses a ByteQueueNode to store bytes, and \p nodeSize determines the + //! size of the ByteQueueNode. A value of 0 indicates the ByteQueueNode should be automatically sized, + //! which means a value of 256 is used. ByteQueue(size_t nodeSize=0); + + //! \brief Copy construct a ByteQueue + //! \param copy the other ByteQueue ByteQueue(const ByteQueue ©); ~ByteQueue(); @@ -66,9 +74,13 @@ public: byte operator[](lword i) const; void swap(ByteQueue &rhs); + //! \class Walker + //! \brief A ByteQueue iterator class Walker : public InputRejecting { public: + //! \brief Construct a ByteQueue Walker + //! \param queue a ByteQueue Walker(const ByteQueue &queue) : m_queue(queue), m_node(NULL), m_position(0), m_offset(0), m_lazyString(NULL), m_lazyLength(0) {Initialize();} -- cgit v1.2.1