From e2b7ac4bdd423f8fd658db359ca9d0ed800b289f Mon Sep 17 00:00:00 2001
From: Mike Wey
Date: Sun, 30 Oct 2011 17:28:07 +0100
Subject: Even more Documentation.

---
 dmagick/c/magickType.d | 47 ++++++++++++++++++++++++++++++++++++++++-------
 1 file changed, 40 insertions(+), 7 deletions(-)

(limited to 'dmagick/c/magickType.d')

diff --git a/dmagick/c/magickType.d b/dmagick/c/magickType.d
index 7a8b845..32b2e5f 100644
--- a/dmagick/c/magickType.d
+++ b/dmagick/c/magickType.d
@@ -6,46 +6,78 @@ extern (C)
 {
 	version(Quantum8)
 	{
+		/**
+		 * Quantum is an alias for the smallest integer that can hold
+		 * a pixel channel.
+		 */
 		alias ubyte  Quantum;
 		alias double MagickRealType;
 
-		enum MAGICKCORE_QUANTUM_DEPTH = 8;
+		/**
+		 * The largest value that fits in a Quantum, This is the same
+		 * as Quantum.max except when the Quantum dept is 64 bits.
+		 */
 		enum QuantumRange = Quantum.max;
+		enum MAGICKCORE_QUANTUM_DEPTH = 8;
 		enum MaxColormapSize = 256;
 		enum MagickEpsilon = 1.0e-6;
 		enum MagickHuge    = 1.0e6;
 	}
 	else version(Quantum32)
 	{
+		/**
+		 * Quantum is an alias for the smallest integer that can hold
+		 * a pixel channel.
+		 */
 		alias uint   Quantum;
 		alias double MagickRealType;
 
-		enum MAGICKCORE_QUANTUM_DEPTH = 32;
+		/**
+		 * The largest value that fits in a Quantum, This is the same
+		 * as Quantum.max except when the Quantum dept is 64 bits.
+		 */
 		enum QuantumRange = Quantum.max;
+		enum MAGICKCORE_QUANTUM_DEPTH = 32;
 		enum MaxColormapSize = 65536;
 		enum MagickEpsilon = 1.0e-10;
 		enum MagickHuge    = 1.0e12;
 	}
 	else version(Quantum64)
 	{
+		/**
+		 * Quantum is an alias for the smallest integer that can hold
+		 * a pixel channel.
+		 */
 		alias double Quantum;
 		//real seems to be the same size as long double for
 		//dmc and dmd on windows and for dmd and gcc on linux. 
 		alias real MagickRealType;
 
-		enum MAGICKCORE_QUANTUM_DEPTH = 64;
+		/**
+		 * The largest value that fits in a Quantum, This is the same
+		 * as Quantum.max except when the Quantum dept is 64 bits.
+		 */
 		enum QuantumRange = 18446744073709551615.0;
+		enum MAGICKCORE_QUANTUM_DEPTH = 64;
 		enum MaxColormapSize = 65536;
 		enum MagickEpsilon = 1.0e-10;
 		enum MagickHuge = 1.0e12;
 	}
 	else
 	{
+		/**
+		 * Quantum is an alias for the smallest integer that can hold
+		 * a pixel channel.
+		 */
 		alias ushort Quantum;
 		alias double MagickRealType;
 
-		enum MAGICKCORE_QUANTUM_DEPTH = 16;
+		/**
+		 * The largest value that fits in a Quantum, This is the same
+		 * as Quantum.max except when the Quantum dept is 64 bits.
+		 */
 		enum QuantumRange = Quantum.max;
+		enum MAGICKCORE_QUANTUM_DEPTH = 16;
 		enum MaxColormapSize = 65536;
 		enum MagickEpsilon = 1.0e-10;
 		enum MagickHuge    = 1.0e12;
@@ -57,13 +89,14 @@ extern (C)
 	alias int   MagickBooleanType;
 
 	alias MagickSizeType  QuantumAny;
-	alias QuantumRange    TransparentOpacity;
 	alias MaxColormapSize MaxMap;
+	enum  MaxTextExtent = 4096;
 
+	/// The Quantum depth ImageMagick / DMagick is compiled with.
 	alias MAGICKCORE_QUANTUM_DEPTH MagickQuantumDepth;
 
-	enum MaxTextExtent = 4096;
-	enum OpaqueOpacity = 0;
+	alias QuantumRange    TransparentOpacity; /// Fully transparent Quantum.
+	enum  OpaqueOpacity = 0;                  /// Fully opaque Quantum.
 
 	version(D_Ddoc)
 	{
-- 
cgit v1.2.3