Documentation.

Author: macmade

Assets/ColorSet.png

@@ -437,6 +437,23 @@
 		};
 /* End PBXHeadersBuildPhase section */
 
+/* Begin PBXLegacyTarget section */
+		0556FA752343510900EB91DB /* ColorSetKit-Documentation */ = {
+			isa = PBXLegacyTarget;
+			buildArgumentsString = "";
+			buildConfigurationList = 0556FA782343510900EB91DB /* Build configuration list for PBXLegacyTarget "ColorSetKit-Documentation" */;
+			buildPhases = (
+			);
+			buildToolPath = /usr/bin/make;
+			buildWorkingDirectory = Documentation;
+			dependencies = (
+			);
+			name = "ColorSetKit-Documentation";
+			passBuildSettingsInEnvironment = 1;
+			productName = "ColorSetKit-Documentation";
+		};
+/* End PBXLegacyTarget section */
+
 /* Begin PBXNativeTarget section */
 		0543AE6120DC33BC00284E99 /* ColorSet */ = {
 			isa = PBXNativeTarget;
@@ -516,6 +533,9 @@
 							};
 						};
 					};
+					0556FA752343510900EB91DB = {
+						CreatedOnToolsVersion = 11.0;
+					};
 					057DC44A22B1492200BA6727 = {
 						CreatedOnToolsVersion = 10.2.1;
 					};
@@ -541,6 +561,7 @@
 				0543AE6120DC33BC00284E99 /* ColorSet */,
 				05CD4AB920ED7CD100DBDE99 /* ColorSetKit */,
 				057DC44A22B1492200BA6727 /* ColorSetKit-Test */,
+				0556FA752343510900EB91DB /* ColorSetKit-Documentation */,
 			);
 		};
 /* End PBXProject section */
@@ -778,6 +799,18 @@
 			};
 			name = Release;
 		};
+		0556FA762343510900EB91DB /* Debug */ = {
+			isa = XCBuildConfiguration;
+			buildSettings = {
+			};
+			name = Debug;
+		};
+		0556FA772343510900EB91DB /* Release */ = {
+			isa = XCBuildConfiguration;
+			buildSettings = {
+			};
+			name = Release;
+		};
 		057DC45322B1492200BA6727 /* Debug */ = {
 			isa = XCBuildConfiguration;
 			buildSettings = {
@@ -884,6 +917,15 @@
 			defaultConfigurationIsVisible = 0;
 			defaultConfigurationName = Release;
 		};
+		0556FA782343510900EB91DB /* Build configuration list for PBXLegacyTarget "ColorSetKit-Documentation" */ = {
+			isa = XCConfigurationList;
+			buildConfigurations = (
+				0556FA762343510900EB91DB /* Debug */,
+				0556FA772343510900EB91DB /* Release */,
+			);
+			defaultConfigurationIsVisible = 0;
+			defaultConfigurationName = Release;
+		};
 		057DC45622B1492200BA6727 /* Build configuration list for PBXNativeTarget "ColorSetKit-Test" */ = {
 			isa = XCConfigurationList;
 			buildConfigurations = (

ColorSet.xcodeproj/project.pbxproj

@@ -24,22 +24,69 @@
 
 import Cocoa
 
+/**
+ * Represents a color pair.
+ * 
+ * Color pairs contains a primary color, as well as an optional variant
+ * for the dark mode and optional lightness variants..
+ * 
+ * - Authors:
+ *      Jean-David Gadina
+ * 
+ * - Seealso: `LightnessPair`
+ */
 @objc public class ColorPair: NSObject
 {
-    @objc public dynamic var color:       NSColor?
-    @objc public dynamic var variant:     NSColor?
+    /**
+     * The main/primary color.
+     */
+    @objc public dynamic var color: NSColor?
+    
+    /**
+     * An optional color variant to use on dark mode interfaces.
+     */
+    @objc public dynamic var variant: NSColor?
+    
+    /**
+     * Predefined lightness variants for the main/primary color.
+     */
     @objc public dynamic var lightnesses: [ LightnessPair ] = []
 
+    /**
+     * Default convenience initializer.  
+     * Returns a color pair with no color, variant or lightness variant.
+     * 
+     * - Seealso: `init(color:)`
+     * - Seealso: `init(color:variant:)`
+     */
     @objc public convenience override init()
     {
         self.init( color: nil, variant: nil )
     }
 
+    /**
+     * Initializes a color pair with a color.  
+     * No variant or lightness variant will be set.
+     * 
+     * - parameter color:   The main/primary color
+     * 
+     * - Seealso: `init()`
+     * - Seealso: `init(color:variant:)` 
+     */
     @objc public convenience init( color: NSColor? )
     {
         self.init( color: color, variant: nil )
     }
 
+    /**
+     * Initializes a color pair with a color and a dark mode variant.
+     * 
+     * - parameter color:   The main/primary color
+     * - parameter variant: The variant color for the dark mode 
+     * 
+     * - Seealso: `init()`
+     * - Seealso: `init(color:)` 
+     */
     @objc public init( color: NSColor?, variant: NSColor? )
     {
         self.color   = color