Some progress

Author: ufechner7

docs/src/components.md

@@ -18,6 +18,12 @@ calc_output(ud::UnitDelay, input)
 on_timer(ud::UnitDelay)
 ```
 
+## RateLimiter
+```@docs
+RateLimiter
+RateLimiter(dt, limit=1.0, x0=0.0)
+```
+
 ## CalcVSetIn
 ```@docs
 set_vset_pc(cvi::CalcVSetIn, v_set_pc, force)

docs/src/types.md

@@ -6,7 +6,6 @@ CurrentModule = WinchControllers
 
 ## Control components
 ```@docs
-RateLimiter
 Mixer_2CH
 Mixer_3CH
 ```

src/components.jl

@@ -177,6 +177,17 @@ $(TYPEDFIELDS)
     last_output = 0
 end
 
+"""
+    RateLimiter(dt, limit=1.0, x0=0.0)
+
+## Parameters
+- dt: the time-step [s]
+- limit: the rate limit, default: 1.0 [1/s]
+- x0: the initial output, default: 0.0
+
+## Returns
+- a struct of type RateLimiter
+"""
 function RateLimiter(dt, limit=1.0, x0=0.0)
     RateLimiter(dt, limit, x0, x0)
 end

src/wc_components.jl

@@ -24,9 +24,17 @@ function CalcVSetIn(wcs::WCSettings)
     CalcVSetIn(wcs=wcs)
 end
 
-""" 
+"""
+    calc_vro(wcs::WCSettings, force)
 
 Calculate the optimal reel-out speed for a given force. 
+
+## Parameters
+- wcs::WCSettings: the settings struct
+- force: the tether force at the winch
+
+## Returns
+- the optimal reel-out speed
 """
 function calc_vro(wcs::WCSettings, force)
     if wcs.test

src/wc_settings.jl

@@ -1,5 +1,11 @@
 """
+    mutable struct WCSettings
+        
 Settings of the WinchController
+
+# Fields
+
+$(TYPEDFIELDS)
 """
 @with_kw mutable struct WCSettings @deftype Float64
     "timestep of the winch controller"