Documentation for Memory

Former-commit-id: 85e41e916df2c2e2bffa31f5540643144223a322

include/Nazara/Core/MemoryStream.inl

@@ -7,18 +7,36 @@
 
 namespace Nz
 {
+	/*!
+	* \brief Constructs a MemoryStream object by default
+	*/
+
 	inline MemoryStream::MemoryStream() :
 	Stream(StreamOption_None, OpenMode_ReadWrite),
 	m_pos(0)
 	{
 	}
 
+	/*!
+	* \brief Constructs a MemoryStream object with a byte array
+	*
+	* \param byteArray Bytes to stream
+	* \param openMode Reading/writing mode for the stream
+	*/
+
 	inline MemoryStream::MemoryStream(ByteArray* byteArray, UInt32 openMode) :
 	MemoryStream()
 	{
 		SetBuffer(byteArray, openMode);
 	}
 
+	/*!
+	* \brief Gets the internal buffer
+	* \return Buffer of bytes
+	*
+	* \remark Produces a NazaraAssert if buffer is invalid
+	*/
+
 	inline ByteArray& MemoryStream::GetBuffer()
 	{
 		NazaraAssert(m_buffer, "Invalid buffer");
@@ -26,6 +44,13 @@ namespace Nz
 		return *m_buffer;
 	}
 
+	/*!
+	* \brief Gets the internal buffer
+	* \return Buffer of bytes
+	*
+	* \remark Produces a NazaraAssert if buffer is invalid
+	*/
+
 	inline const ByteArray& MemoryStream::GetBuffer() const
 	{
 		NazaraAssert(m_buffer, "Invalid buffer");