From 81b19e9c8ea9bc7f60c9bccdccfba5b90bdc4380 Mon Sep 17 00:00:00 2001
From: Bruce Mitchener <bruce.mitchener@gmail.com>
Date: Sat, 6 Oct 2018 21:22:46 +0700
Subject: [PATCH] glm docs: Add examples for clamp and clamp_scalar.

---
 nalgebra-glm/src/common.rs | 34 ++++++++++++++++++++++++++++++++--
 1 file changed, 32 insertions(+), 2 deletions(-)

diff --git a/nalgebra-glm/src/common.rs b/nalgebra-glm/src/common.rs
index a796929c..d35ad834 100644
--- a/nalgebra-glm/src/common.rs
+++ b/nalgebra-glm/src/common.rs
@@ -50,6 +50,21 @@ pub fn ceil<N: Real, D: Dimension>(x: &TVec<N, D>) -> TVec<N, D>
 
 /// Returns `min(max(x, min_val), max_val)`.
 ///
+/// # Examples:
+///
+/// ```
+/// # use nalgebra_glm as glm;
+/// // Works with integers:
+/// assert_eq!(3, glm::clamp_scalar(1, 3, 5));
+/// assert_eq!(4, glm::clamp_scalar(4, 3, 5));
+/// assert_eq!(5, glm::clamp_scalar(7, 3, 5));
+///
+/// // And it works with floats:
+/// assert_eq!(3.25, glm::clamp_scalar(1.3, 3.25, 5.5));
+/// assert_eq!(4.5, glm::clamp_scalar(4.5, 3.25, 5.5));
+/// assert_eq!(5.5, glm::clamp_scalar(7.8, 3.25, 5.5));
+/// ```
+///
 /// # See also:
 ///
 /// * [`clamp`](fn.clamp.html)
@@ -58,7 +73,21 @@ pub fn clamp_scalar<N: Number>(x: N, min_val: N, max_val: N) -> N {
     na::clamp(x, min_val, max_val)
 }
 
-/// Returns `min(max(x[i], min_val), max_val)` for each component in `x` using the floating-point values `min_val and `max_val`.
+/// Returns `min(max(x[i], min_val), max_val)` for each component in `x`
+/// using the values `min_val and `max_val` as bounds.
+///
+/// # Examples:
+///
+/// ```
+/// # use nalgebra_glm as glm;
+/// // Works with integers:
+/// assert_eq!(glm::vec3(3, 4, 5),
+///            glm::clamp(&glm::vec3(1, 4, 7), 3, 5));
+///
+/// // And it works with floats:
+/// assert_eq!(glm::vec3(3.25, 4.5, 5.5),
+///            glm::clamp(&glm::vec3(1.3, 4.5, 7.8), 3.25, 5.5));
+/// ```
 ///
 /// # See also:
 ///
@@ -69,7 +98,8 @@ pub fn clamp<N: Number, D: Dimension>(x: &TVec<N, D>, min_val: N, max_val: N) ->
     x.map(|x| na::clamp(x, min_val, max_val))
 }
 
-/// Returns `min(max(x[i], min_val[i]), max_val[i])` for each component in `x` using the components of `min_val` and `max_val` as bounds.
+/// Returns `min(max(x[i], min_val[i]), max_val[i])` for each component in `x`
+/// using the components of `min_val` and `max_val` as bounds.
 ///
 /// # See also:
 ///