Add doc comments to various class declarations

Author: KredeGC

include/bitstream/quantization/bounded_range.h

@@ -26,6 +26,9 @@
 
 namespace bitstream
 {
+	/**
+	 * @brief Class for quantizing single-precision floats into a range and precision
+	*/
 	class bounded_range
 	{
 	public:

include/bitstream/quantization/half_precision.h

@@ -26,6 +26,9 @@
 
 namespace bitstream
 {
+	/**
+	 * @brief Class for quantizing single-precision floats into half-precision
+	*/
 	class half_precision
 	{
 	private:

include/bitstream/quantization/smallest_three.h

@@ -27,6 +27,9 @@
 
 namespace bitstream
 {
+	/**
+	 * @brief A quantized representation of a quaternion
+	*/
 	struct quantized_quaternion
 	{
 		uint32_t m;
@@ -40,6 +43,10 @@ namespace bitstream
 			: m(m), a(a), b(b), c(c) {}
 	};
 
+	/**
+	 * @brief Class for quantizing a user-specified quaternion into fewer bits using the smallest-three algorithm
+	 * @tparam T The quaternion-type to quantize
+	*/
 	template<typename T, size_t BitsPerElement = 12>
 	class smallest_three
 	{

include/bitstream/stream/bit_reader.h

@@ -13,6 +13,9 @@
 
 namespace bitstream
 {
+	/**
+	 * @brief A stream for reading objects from a tightly packed buffer
+	*/
 	class bit_reader
 	{
 	public:

include/bitstream/stream/bit_writer.h

@@ -14,6 +14,9 @@ namespace bitstream
 {
     class bit_reader;
 
+	/**
+	 * @brief A stream for writing objects tightly into a buffer
+	*/
 	class bit_writer
 	{
     private:

include/bitstream/stream/serialize_traits.h

@@ -2,6 +2,11 @@
 
 namespace bitstream
 {
-	template<typename, typename = void>
+	/**
+	 * @brief A class for specializing trait serialization functions
+	 * @tparam Trait Make a specialization on this type
+	 * @tparam Void Use std::enable_if here if you need to, otherwise leave empty
+	*/
+	template<typename Trait, typename Void = void>
 	struct serialize_traits;
 }

include/bitstream/traits/integral_traits.h

@@ -12,6 +12,10 @@
 
 namespace bitstream
 {
+	/**
+	 * @brief Wrapper type for compile-time known integer bounds
+	 * @tparam T 
+	*/
 	template<typename T, T, T>
 	struct bounded_int;