Rewrite BufferedFile as a standalone class

[libs/core.git] / source / io / filtered.h

diff --git a/source/io/filtered.h b/source/io/filtered.h
index a4a43192b4b2c166dbf4952e3dfff4ee9aad270e..209274361e4432ca6608d4eb1112786c5b84e100 100644 (file)
--- a/source/io/filtered.h
+++ b/source/io/filtered.h
@@ -4,7 +4,11 @@
 namespace Msp {
 namespace IO {
 
-// XXX This needs a redesign
+/**
+This class is broken by design.  Do not use.  It exposes base class methods in
+an unsafe and misleading way.  In particular, a Filtered<File, Buffered> causes
+seeks to behave incorrectly.
+*/
 template<typename B, typename F>
 class Filtered: public B
 {