Add more doc comments to various classe

Author: KredeGC

include/bitstream/stream/bit_reader.h

@@ -15,6 +15,7 @@ namespace bitstream
 {
 	/**
 	 * @brief A stream for reading objects from a tightly packed buffer
+	 * @note Does not take ownership of the buffer
 	*/
 	class bit_reader
 	{

include/bitstream/stream/bit_writer.h

@@ -17,6 +17,7 @@ namespace bitstream
 
 	/**
 	 * @brief A stream for writing objects tightly into a buffer
+	 * @note Does not take ownership of the buffer
 	*/
 	class bit_writer
 	{

include/bitstream/stream/byte_buffer.h

@@ -5,8 +5,9 @@
 namespace bitstream
 {
 	/**
-	 * @brief A byte buffer aligned to 4 bytes
-	 * @note Can be used with bit_reader and bit_writer
+	 * @brief A byte buffer aligned to 4 bytes.
+	 * Can be used with bit_reader and bit_writer.
+	 * @note Size must be a multiple of 4
 	*/
 	template<size_t Size>
 	struct byte_buffer

include/bitstream/utility/endian.h

@@ -72,9 +72,9 @@ namespace bitstream::utility
 #elif defined(__linux__)
             return __builtin_bswap32(value);
 #else
-			const uint32_t first = (value << 24)	& 0xFF000000;
+			const uint32_t first =  (value << 24)	& 0xFF000000;
 			const uint32_t second = (value << 8)	& 0x00FF0000;
-			const uint32_t third = (value >> 8)		& 0x0000FF00;
+			const uint32_t third =  (value >> 8)	& 0x0000FF00;
 			const uint32_t fourth = (value >> 24)	& 0x000000FF;
 
 			return first | second | third | fourth;