Added some more code documentation.

diff --git a/lib/base/stdiostream.cpp b/lib/base/stdiostream.cpp
index b6e5ffec31bdb0d5ef56c9c9d9433d3ced9c4e6d..6e7bbcb8fd42c0628b066dec121df8f6aae61744 100644 (file)
--- a/lib/base/stdiostream.cpp
+++ b/lib/base/stdiostream.cpp
@@ -21,6 +21,13 @@
 
 using namespace icinga;
 
+/**
+ * Constructor for the StdioStream class.
+ *
+ * @param innerStream The inner stream.
+ * @param ownsStream Whether the new object owns the inner stream. If true
+ *                                      the stream's destructor deletes the inner stream.
+ */
 StdioStream::StdioStream(iostream *innerStream, bool ownsStream)
        : m_InnerStream(innerStream), m_OwnsStream(ownsStream),
          m_ReadAheadBuffer(boost::make_shared<FIFO>())
@@ -28,6 +35,9 @@ StdioStream::StdioStream(iostream *innerStream, bool ownsStream)
        m_ReadAheadBuffer->Start();
 }
 
+/**
+ * Destructor for the StdioStream class.
+ */
 StdioStream::~StdioStream(void)
 {
        m_ReadAheadBuffer->Close();