Some progress

Author: ufechner7

docs/src/components.md

@@ -30,9 +30,11 @@ on_timer(rl::RateLimiter)
 ## Mixer_2CH
 ```@docs
 Mixer_2CH
+Mixer_2CH(dt, t_blend)
 ```
 
 ## Mixer_3CH
 ```@docs
 Mixer_3CH
+get_state(m3::Mixer_3CH)
 ```

docs/src/functions.md

@@ -2,13 +2,7 @@
 CurrentModule = WinchControllers
 ```
 
-## Output functions
-```@docs
-calc_vro
-get_state
-```
-
-## Utility functions
+## Utility Functions and Macros
 ```@docs
 @limit
 saturate

docs/src/winchcontroller.md

@@ -2,8 +2,7 @@
 CurrentModule = WinchControllers
 ```
 
-## Control components
-### CalcVSetIn
+## CalcVSetIn
 ```@docs
 CalcVSetIn
 CalcVSetIn(wcs::WCSettings)
@@ -12,8 +11,13 @@ calc_output(cvi::CalcVSetIn)
 on_timer(cvi::CalcVSetIn)
 ```
 
-## Controller and settings
+## Winch Controller
 ```@docs
 WinchController
+```
+
+## Controller Settings
+```@docs
 WCSettings
+calc_vro
 ```

src/components.jl

@@ -264,6 +264,18 @@ $(TYPEDFIELDS)
     select_b::Bool = false
 end
 
+"""
+    Mixer_2CH(dt, t_blend)
+
+Constructor for Mixer_2CH, a component for mixing two analog inputs.
+
+## Parameters
+- dt: the time-step [s]
+- `t_blend`: the time for blending over from one channel to the other [s]
+
+## Returns
+- a struct of type Mixer_2CH
+"""
 function Mixer_2CH(dt, t_blend)
     Mixer_2CH(dt, t_blend, 0, false)
 end
@@ -347,11 +359,14 @@ function calc_output(m3::Mixer_3CH, input_a, input_b, input_c)
 end
 
 """
+    function get_state(m3::Mixer_3CH)
+
 Return the controller state as integer.
 
-wcsLowerForceControl = 0 # input b selected 
-wcsSpeedControl = 1      # input a selected
-wcsUpperForceControl = 2 # input c selected
+Returns:
+- wcsLowerForceControl = 0 # input b selected 
+- wcsSpeedControl = 1      # input a selected
+- wcsUpperForceControl = 2 # input c selected
 """
 function get_state(m3::Mixer_3CH)
     Int(! m3.select_b && ! m3.select_c) + 2 * Int(m3.select_c)

src/utils.jl

@@ -22,12 +22,14 @@ function saturate(value, min_, max_)
     result
 end
 
-""" 
+"""
+    macro limit(name, min, max=nothing)
+
 Limit the value of a variable. 
 
 Usage:
-@limit x 1 4 # limits the value to the range    1 .. 4,  modifies x
-@limit x 10  # limits the value to the range -inf .. 10, modifies x
+- @limit x 1 4 # limits the value to the range    1 .. 4,  modifies x
+- @limit x 10  # limits the value to the range -inf .. 10, modifies x
 
 """
 macro limit(name, min, max=nothing)

src/wc_components.jl

@@ -15,7 +15,7 @@ Implemented as described in the PhD thesis of Uwe Fechner.
 """
     mutable struct CalcVSetIn
 
-Component for calculation v_set_in, using soft switching.
+Component for calculation `v_set_in`, using soft switching.
 
 # Fields