From 8f4ea8c6eddf3e9ee1dda56ddffafd5d51cf9382 Mon Sep 17 00:00:00 2001
From: sakul-45 <81963567+sakul-45@users.noreply.github.com>
Date: Sat, 10 Jul 2021 13:16:29 +0200
Subject: [PATCH] Added example structure of params to documentation

---
 load_bruker.m | 20 ++++++++++++++++++++
 load_matlab.m | 20 ++++++++++++++++++++
 2 files changed, 40 insertions(+)

diff --git a/load_bruker.m b/load_bruker.m
index 2997cd3..f17c638 100644
--- a/load_bruker.m
+++ b/load_bruker.m
@@ -10,6 +10,26 @@ function [Data,params] = load_bruker(path)
 %   in the command window when calling the function.
 %
 %   Note that this funtion is dependent on easyspin.
+%
+%   Example for params output:
+%   params = 
+% 
+%   struct with fields:
+% 
+%          Field_Center: 3500
+%           Field_Sweep: 3400
+%            Field_Step: 5
+%         Accumulations: 100
+%     laser_shotreprate: 20
+%           Field_Start: 1800
+%             Field_End: 5200
+%          Field_Vector: [1×681 double]
+%                mwFreq: 9.6845
+%               mwPower: 0.2000
+%                QValue: 22800
+%               mwAtten: 30
+%               mwFreqs: [681×1 double]
+%                  Name: "/some/path"
 
 %correct \ for /
 corrpath = replace(path,"\","/");
diff --git a/load_matlab.m b/load_matlab.m
index 03613e9..33a8347 100644
--- a/load_matlab.m
+++ b/load_matlab.m
@@ -6,6 +6,26 @@ function [Data,params] = load_matlab(path)
 %   Input has to be the full path to file with forwardslashes as char or
 %   string. The extracted name is appended to the 'params' struct, whos
 %   contents are displayed in the command window afterwards.
+%
+%   Example for params output:
+%   params = 
+% 
+%   struct with fields:
+% 
+%          Field_Center: 3500
+%           Field_Sweep: 3400
+%            Field_Step: 5
+%         Accumulations: 100
+%     laser_shotreprate: 20
+%           Field_Start: 1800
+%             Field_End: 5200
+%          Field_Vector: [1×681 double]
+%                mwFreq: 9.6845
+%               mwPower: 0.2000
+%                QValue: 22800
+%               mwAtten: 30
+%               mwFreqs: [681×1 double]
+%                  Name: "/some/path"
 
 %correct \ for /
 corrpath = replace(path,"\","/")