Improve documentation

Author: ufechner7

Project.toml

@@ -5,6 +5,7 @@ version = "1.0.0-DEV"
 
 [deps]
 BenchmarkTools = "6e4b80f9-dd63-53aa-95a3-0cdb28fa8baf"
+DocStringExtensions = "ffbed154-4ef7-542d-bbb7-c09d3a79fcae"
 KiteUtils = "90980105-b163-44e5-ba9f-8b1c83bb0533"
 NLsolve = "2774e3e8-f4cf-5e23-947b-6d7e65073b56"
 Parameters = "d96e819e-fc66-5662-9728-84c9c7592b0a"
@@ -17,6 +18,7 @@ WinchModels = "7dcfa46b-7979-4771-bbf4-0aee0da42e1f"
 [compat]
 BenchmarkTools = "1.6.0"
 ControlPlots = "0.2.7"
+DocStringExtensions = "0.9.4"
 Documenter = "1.11.4"
 KiteUtils = "0.10.6"
 NLsolve = "4.5.1"

docs/src/types.md

@@ -4,7 +4,13 @@
 CurrentModule = WinchControllers
 ```
 
-## Basic types
+## Control components
 ```@docs
+Mixer_2CH
+```
+
+## Controller and settings
+```@docs
+WinchController
 WCSettings
 ```

src/WinchControllers.jl

@@ -1,6 +1,6 @@
 module WinchControllers
 
-using Parameters, StructTypes, KiteUtils, WinchModels, StaticArrays, NLsolve
+using Parameters, StructTypes, KiteUtils, WinchModels, StaticArrays, NLsolve, DocStringExtensions
 
 export WCSettings, WinchController
 export get_speed, set_force, calc_v_set, set_v_set, on_timer, get_acc, get_state, get_status

src/components.jl

@@ -91,9 +91,15 @@ function on_timer(rl::RateLimiter)
     rl.last_output = rl.output
 end
 
-# Mixer_2CH
-# Mix two analog inputs. Implements the simulink block diagram, shown in
-# docs/mixer_2ch.png
+"""
+    @with_kw mutable struct Mixer_2CH @deftype Float64
+
+Mix two analog inputs. Implements the simulink block diagram, shown in `docs/mixer_2ch.png`.
+
+# Fields
+
+$(TYPEDFIELDS)
+"""
 @with_kw mutable struct Mixer_2CH @deftype Float64
     dt
     t_blend = 1.0

src/winchcontroller.jl

@@ -1,8 +1,18 @@
 # Winch winch controller component, implemented as described in the PhD thesis of Uwe Fechner. 
 @enum WinchControllerState wcsLowerForceLimit wcsSpeedControl wcsUpperForceLimit
 
-# Basic winch controller. Works in one of the three modes wcsLowerForceLimit, wcsSpeedControl and
-# wcsUpperForceLimit.
+
+
+"""
+    @with_kw mutable struct WinchController @deftype Float64
+
+Basic winch controller. Works in one of the three modes `wcsLowerForceLimit`, `wcsSpeedControl` and
+`wcsUpperForceLimit`.
+
+# Fields
+
+$(TYPEDFIELDS)
+"""
 @with_kw mutable struct WinchController @deftype Float64
     wcs::WCSettings
     time = 0