From c48d56bcc0c919007d712d8716c86714e387554b Mon Sep 17 00:00:00 2001
From: David Robillard <d@drobilla.net>
Date: Sun, 19 Aug 2018 17:51:42 +0200
Subject: Document various bit vector types

---
 chilbert/DynamicBitVec.hpp | 5 +++++
 1 file changed, 5 insertions(+)

(limited to 'chilbert/DynamicBitVec.hpp')

diff --git a/chilbert/DynamicBitVec.hpp b/chilbert/DynamicBitVec.hpp
index ab7d00b..7372629 100644
--- a/chilbert/DynamicBitVec.hpp
+++ b/chilbert/DynamicBitVec.hpp
@@ -33,6 +33,11 @@
 
 namespace chilbert {
 
+/** A dynamically allocated bit vector.
+ *
+ * This uses dynamic allocation internally and can be constructed with any
+ * size, assuming sufficient memory is available.
+ */
 class DynamicBitVec : public MultiBitVec<DynamicBitVec>
 {
 public:
-- 
cgit v1.2.1