Add docu page components

Author: ufechner7

docs/make.jl

@@ -15,6 +15,7 @@ makedocs(;
     ),
     pages=[
         "Home" => "index.md",
+        "Components" => "components.md",
         "Types" => "types.md",
         "Functions" => "functions.md"
     ],

docs/src/components.md

@@ -0,0 +1,11 @@
+```@meta
+CurrentModule = WinchControllers
+```
+## Integrator
+```@docs
+Integrator
+Integrator(dt, i=1.0, x0=0.0)
+reset
+calc_output
+on_timer
+```

docs/src/functions.md

@@ -4,12 +4,10 @@ CurrentModule = WinchControllers
 ## Input functions
 ```@docs
 set_vset_pc
-reset
 ```
 
 ## Output functions
 ```@docs
-calc_output
 calc_vro
 get_state
 ```

docs/src/types.md

@@ -6,8 +6,6 @@ CurrentModule = WinchControllers
 
 ## Control components
 ```@docs
-Integrator
-Integrator(dt, i=1.0, x0=0.0)
 UnitDelay
 RateLimiter
 Mixer_2CH

src/components.jl

@@ -57,10 +57,29 @@ function reset(int::Integrator, x0=0.0)
     nothing
 end
 
+"""
+    calc_output(int::Integrator, input)
+
+Calculate and return the output without updating `last_output`.
+
+# Parameters
+
+- int::Integrator: An integrator struct
+- input: The input value
+"""
 function calc_output(int::Integrator, input)
     int.output = int.last_output + input * int.i * int.dt
 end
 
+"""
+    on_timer(int::Integrator)
+
+Update the field `last_output`. Must be called once per time-step.
+
+# Parameters
+
+- int::Integrator: An integrator struct
+"""
 function on_timer(int::Integrator)
     int.last_output = int.output
     nothing