add documentation for grey mcdm

docs/src/greynumbers.md

@@ -1,7 +1,7 @@
 # Multiple-criteria Decision Making Tools with Grey Numbers 
 
 
-# A grey number
+## A grey number
 
 ```julia
 julia> a = GreyNumber(1, 4)
@@ -35,6 +35,18 @@ julia> a * -1
 GreyNumber(-4, -1)
 ```
 
+
+## whitenize
+```@docs
+JMcDM.whitenize
+```
+
+
+## kernel
+```@docs
+JMcDM.kernel
+```
+
 # MCDM Tools with Grey Numbers 
 
 ## Grey Topsis

src/greynumber.jl

@@ -233,16 +233,63 @@ function Base.getindex(g::GreyNumber, index::Int)::Real
 end
 
 
+"""
+
+	kernel(g::GreyNumber)::Float64
+
+# Description
+
+Calculate the kernel of a grey number
+
+# Arguments
+
+- `g::GreyNumber`: A grey number
 
+
+# Examples
+
+```julia
+julia> g = GreyNumber(1, 2)
+GreyNumber(1, 2)
+
+julia> kernel(g)
+1.5
+```
+"""
 function kernel(g::GreyNumber)::Float64
 	return (g.a + g.b) / 2.0
 end
 
+
+"""
+
+	whitenizate(g::GreyNumber; t::Float64 = 0.5):: Float64
+
+# Description
+
+Whitenizate a grey number
+
+# Arguments
+
+- `g::GreyNumber`: A grey number
+- `t::Float64`: A value between 0 and 1. Default is 0.5.
+
+# Examples
+
+```julia
+julia> g = GreyNumber(1, 2)
+GreyNumber(1, 2)
+
+julia> whitenizate(g)
+1.5
+```
+"""
 function whitenizate(g::GreyNumber; t::Float64 = 0.5)::Float64
 	@assert 0.0 <= t <= 1.0
 	return g.a * t + g.b * (1.0 - t)
 end
 
+
 function Base.zero(::Type{GreyNumber})
 	return GreyNumber(0.0, 0.0)
 end