Add documentation to convenience functions

Author: etfrogers

gnuplot/src/color.rs

@@ -57,10 +57,10 @@ pub enum ColorType<T = String>
 	),
 	/// Vector of tuples of `u8` (as per `RGBColor`), but instead of a single color for the whole
 	/// plot, the vector should contain a separte color for each data point.
-	VariableRGBIntegers(Vec<RGBInts>),
+	VariableRGBInteger(Vec<RGBInts>),
 	/// Vector of tuples of `u8` (as per `ARGBColor`), but as with `VariableRGBColor`, a separate
 	/// color value is given for each data point.
-	VariableARGBIntegers(Vec<ARGBInts>),
+	VariableARGBInteger(Vec<ARGBInts>),
 	/// TODO
 	PaletteFracColor(f32),
 	/// TODO
@@ -98,8 +98,8 @@ impl<T: Display> ColorType<T>
 			RGBString(s) => format!(r#"rgb "{}""#, s),
 			RGBInteger(r, g, b) => format!(r#"rgb {}"#, from_argb(0, *r, *g, *b)),
 			ARGBInteger(a, r, g, b) => format!(r#"rgb {}"#, from_argb(*a, *r, *g, *b)),
-			VariableRGBIntegers(_) => String::from("rgb variable"),
-			VariableARGBIntegers(_) => String::from("rgb variable"),
+			VariableRGBInteger(_) => String::from("rgb variable"),
+			VariableARGBInteger(_) => String::from("rgb variable"),
 			PaletteFracColor(_) => todo!(),
 			PaletteCBColor(_) => todo!(),
 			VariablePaletteColor(_) => String::from("palette z"),
@@ -118,11 +118,11 @@ impl<T: Display> ColorType<T>
 			RGBString(_) => panic!("data() called on non-variable color type."),
 			RGBInteger(_, _, _) => panic!("data() called on non-variable color type."),
 			ARGBInteger(_, _, _, _) => panic!("data() called on non-variable color type."),
-			VariableRGBIntegers(items) => items
+			VariableRGBInteger(items) => items
 				.iter()
 				.map(|(r, g, b)| from_argb(0, *r, *g, *b) as f64)
 				.collect(),
-			VariableARGBIntegers(items) => items
+			VariableARGBInteger(items) => items
 				.into_iter()
 				.map(|(a, r, g, b)| from_argb(*a, *r, *g, *b) as f64)
 				.collect(),
@@ -141,8 +141,8 @@ impl<T: Display> ColorType<T>
 	{
 		match self
 		{
-			VariableRGBIntegers(_)
-			| VariableARGBIntegers(_)
+			VariableRGBInteger(_)
+			| VariableARGBInteger(_)
 			| VariableIndex(_)
 			| VariablePaletteColor(_)
 			| SavedColorMap(_, _) => true,
@@ -170,7 +170,7 @@ impl<T: Display> ColorType<T>
 					false
 				}
 			}
-			ARGBInteger(_, _, _, _) | VariableARGBIntegers(_) => true,
+			ARGBInteger(_, _, _, _) | VariableARGBInteger(_) => true,
 			_ => false,
 		}
 	}
@@ -275,15 +275,23 @@ impl<T> Into<ColorType<T>> for Vec<RGBInts>
 {
 	fn into(self) -> ColorType<T>
 	{
-		ColorType::VariableRGBIntegers(self)
+		ColorType::VariableRGBInteger(self)
 	}
 }
 
 impl<T> Into<ColorType<T>> for Vec<ARGBInts>
 {
 	fn into(self) -> ColorType<T>
 	{
-		ColorType::VariableARGBIntegers(self)
+		ColorType::VariableARGBInteger(self)
+	}
+}
+
+impl<T> Into<ColorType<T>> for ColorIndex
+{
+	fn into(self) -> ColorType<T>
+	{
+		ColorType::Index(self)
 	}
 }
 
@@ -305,7 +313,7 @@ impl<T: Display> OneWayOwned for ColorType<T>
 		{
 			RGBString(s) => RGBString(s.to_string()),
 			RGBInteger(r, g, b) => RGBInteger(*r, *g, *b),
-			VariableRGBIntegers(d) => VariableRGBIntegers(d.clone()),
+			VariableRGBInteger(d) => VariableRGBInteger(d.clone()),
 			PaletteFracColor(_) => todo!(),
 			PaletteCBColor(_) => todo!(),
 			VariablePaletteColor(d) => VariablePaletteColor(d.clone()),
@@ -315,7 +323,7 @@ impl<T: Display> OneWayOwned for ColorType<T>
 			Index(n) => Index(*n),
 			Black => Black,
 			ARGBInteger(a, r, g, b) => ARGBInteger(*a, *r, *g, *b),
-			VariableARGBIntegers(d) => VariableARGBIntegers(d.clone()),
+			VariableARGBInteger(d) => VariableARGBInteger(d.clone()),
 		}
 	}
 }
@@ -328,14 +336,14 @@ impl ColorType<String>
 		{
 			RGBString(s) => RGBString(s),
 			RGBInteger(r, g, b) => RGBInteger(*r, *g, *b),
-			VariableRGBIntegers(d) => VariableRGBIntegers(d.to_vec()),
-			VariableARGBIntegers(d) => VariableARGBIntegers(d.to_vec()),
+			VariableRGBInteger(d) => VariableRGBInteger(d.to_vec()),
+			VariableARGBInteger(d) => VariableARGBInteger(d.to_vec()),
 			PaletteFracColor(_) => todo!(),
 			PaletteCBColor(_) => todo!(),
 			VariablePaletteColor(d) => VariablePaletteColor(d.to_vec()),
 			SavedColorMap(s, d) => SavedColorMap(s, d.to_vec()),
 			VariableIndex(d) => VariableIndex(d.to_vec()),
-			Background => todo!(),
+			Background => Background,
 			Index(n) => Index(*n),
 			Black => Black,
 			ARGBInteger(a, r, g, b) => ARGBInteger(*a, *r, *g, *b),

gnuplot/src/options.rs

@@ -78,13 +78,25 @@ pub enum PlotOption<T>
 }
 
 #[allow(non_snake_case)]
-/// TODO
+/// Convience function to allow construction of color options implicitly from a wide range of inputs.
+///
+/// Currently these are:
+/// * `String` or `&str` - produces a [ColorType::RGBString]
+/// * `(u8, u8, u8)` - produces a [ColorType::RGBInteger]
+/// * `(u8, u8, u8, u8)` - produces a [ColorType::ARGBInteger]
+/// * `Vec<((u8, u8, u8))>` or `Vec<(u8, u8, u8, u8)>` - produces a
+/// 	[ColorType::VariableRGBInteger] or [ColorType::VariableARGBInteger] respectively
+/// * `u8` or `Vec<u8>` produces a [ColorType::Index] or [ColorType::VariableIndex] respectively
+///
+///	See `examples/color.rs` for usage of this function
 pub fn Color<'l, T: IntoColor<&'l str>>(c: T) -> PlotOption<&'l str>
 {
 	ColorOpt(c.into())
 }
 
 #[allow(non_snake_case)]
+/// Convience function to allow construction of border color options implicitly from a wide range of inputs.
+/// Format and possible inputs are the same as [Color]
 pub fn BorderColor<'l, T: IntoColor<&'l str>>(c: T) -> PlotOption<&'l str>
 {
 	BorderColorOpt(c.into())
@@ -289,7 +301,8 @@ impl<'l> OneWayOwned for LabelOption<&'l str>
 }
 
 #[allow(non_snake_case)]
-/// TODO
+/// Convience function to allow construction of text color options implicitly from a wide range of inputs.
+/// Format and possible inputs are the same as [Color]
 pub fn TextColor<'l, T: IntoColor<&'l str>>(c: T) -> LabelOption<&'l str>
 {
 	TextColorOpt(c.into())