Add documentation of SysLog

ufechner7 · Dec 25, 2021 · 43c4fa5 · 43c4fa5
1 parent 1fd3f15
commit 43c4fa5
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 5 deletions.
diff --git a/docs/src/types.md b/docs/src/types.md
@@ -15,4 +15,5 @@ Also look at the default file that is parsed to fill the Settings stuct with dat
 MyFloat
 SysState{P}
 ExtSysState{P}
+SysLog{P}
 ```
diff --git a/src/KiteUtils.jl b/src/KiteUtils.jl
@@ -220,13 +220,22 @@ struct ExtSysState{P}
  z::MyFloat
 end
 
-# flight log, containing the basic data as struct of arrays 
-# and in addition an extended view on the data that includes derived/ calculated values for plotting
-# finally meta data like the file name of the log file is included
+"""
+ SysLog{P}
+
+Flight log, containing the basic data as struct of arrays 
+and in addition an extended view on the data that includes derived/ calculated values for plotting
+finally meta data like the file name of the log file is included.
+
+$(TYPEDFIELDS)
+"""
 struct SysLog{P}
+ "name of the flight log"
  name::String
- syslog::StructArray{SysState{P}} # struct of vectors
- extlog::StructArray{ExtSysState{P}} # struct of vectors, containing derived values
+ "struct of vectors"
+ syslog::StructArray{SysState{P}}
+ "struct of vectors, containing derived values"
+ extlog::StructArray{ExtSysState{P}}
 end
 
 # functions