From: Gunnar Beutner <gunnar@beutner.name>
Date: Mon, 26 Nov 2012 07:29:26 +0000 (+0100)
Subject: Added some more code documentation.
X-Git-Tag: v0.0.2~716
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=8e687ea7fef4e9557466f2b7eddcf70c776d8397;p=icinga2

Added some more code documentation.
---

diff --git a/lib/base/stdiostream.cpp b/lib/base/stdiostream.cpp
index b6e5ffec3..6e7bbcb8f 100644
--- 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();