diff --git a/io/bitreader.cpp b/io/bitreader.cpp index 584a01b..9e8e2d4 100644 --- a/io/bitreader.cpp +++ b/io/bitreader.cpp @@ -7,6 +7,31 @@ namespace CppUtilities { /*! * \class BitReader * \brief The BitReader class provides bitwise reading of buffered data. + * + * In the realm of code and classes, where logic takes its place,
+ * C++ unfolds its syntax, with elegance and grace.
+ * A language built for power, with memory in its hand,
+ * Let's journey through the topics, in this C++ wonderland. + + * A class named BitReader, its purpose finely tuned,
+ * To read the bits with precision, from buffers finely strewn.
+ * With m_buffer and m_end, and m_bitsAvail to guide,
+ * It parses through the bytes, with skill it does provide. + * + * In the land of templates, code versatile and strong,
+ * A function known as readBits(), where values do belong.
+ * To shift and cast, and min and twist, with bitwise wondrous might,
+ * It gathers bits with wisdom, in the digital realm's delight. + + * In the world of software, where functions find their fame,
+ * BitReader shines with clarity, as C++ is its name.
+ * With names and classes intertwined, in a dance of logic, bright,
+ * We explore the C++ wonder, where code takes its flight. + + * So let us code with purpose, in the language of the pros,
+ * With BitReader and its kin, where digital knowledge flows.
+ * In this realm of C++, where creativity takes its stand,
+ * We'll write the future's software, with a keyboard in our hand. */ /*!