Add documentation

Author: tharun571

test/test_interpreter.cpp

@@ -25,25 +25,42 @@
     #include <unistd.h>
 #endif
 
-// Object for capturing stderr
+/**
+ * @class StreamRedirectRAII
+ * @brief A RAII class to redirect a stream to a stringstream.
+ *
+ * This class redirects the output of a given std::ostream to a std::stringstream.
+ * The original stream is restored when the object is destroyed.
+ */
 class StreamRedirectRAII {
-    public:
-        StreamRedirectRAII(std::ostream& stream) : old_stream_buff(stream.rdbuf()), stream_to_redirect(stream) {
-            stream_to_redirect.rdbuf(ss.rdbuf());
-        }
+public:
+    /**
+     * @brief Constructor that starts redirecting the given stream.
+     * @param stream The stream to redirect.
+     */
+    StreamRedirectRAII(std::ostream& stream) : old_stream_buff(stream.rdbuf()), stream_to_redirect(stream) {
+        stream_to_redirect.rdbuf(ss.rdbuf());
+    }
 
-        ~StreamRedirectRAII() {
-            stream_to_redirect.rdbuf(old_stream_buff);
-        }
+    /**
+     * @brief Destructor that restores the original stream.
+     */
+    ~StreamRedirectRAII() {
+        stream_to_redirect.rdbuf(old_stream_buff);
+    }
 
-        std::string getCaptured() {
-            return ss.str();
-        }
+    /**
+     * @brief Get the output that was written to the stream.
+     * @return A string containing the output that was written to the stream.
+     */
+    std::string getCaptured() {
+        return ss.str();
+    }
 
-    private:
-        std::streambuf* old_stream_buff;
-        std::ostream& stream_to_redirect;
-        std::stringstream ss;
+private:
+    std::streambuf* old_stream_buff; ///< The original buffer of the stream.
+    std::ostream& stream_to_redirect; ///< The stream that is being redirected.
+    std::stringstream ss; ///< The stringstream that the stream is redirected to.
 };
 
 TEST_SUITE("execute_request")
@@ -695,7 +712,7 @@ TEST_SUITE("xmagics_apply"){
     } 
 
     TEST_CASE("cell magic with empty cell body") {
-        
+
         xcpp::xmagics_manager manager;
 
         StreamRedirectRAII redirect(std::cerr);