diff --git a/+PlotID/@config/config.m b/+PlotID/@config/config.m
index cfece4d21ea2fd558a7f2cc4ff37787667ded57b..b9b4779ef6f87e15119fefcd9d1063745711ff48 100644
--- a/+PlotID/@config/config.m
+++ b/+PlotID/@config/config.m
@@ -1,7 +1,7 @@
classdef config < handle
- %CONFIG class handles methods and attributes related to the config
+ % CONFIG class handles methods and attributes related to the config
%file
- %handle class used for dynamicy property updates
+ % handle class used for dynamicy property updates
properties (SetAccess = private)
mandatoryFields = {'Author', 'ProjectID'}
diff --git a/+PlotID/@dataPath/dataPath.m b/+PlotID/@dataPath/dataPath.m
index bc4f395b77d5145f54785c98105d3fe51ac86ec5..2edf934401bf60bcd6a00e15385c3d075a8e3278 100644
--- a/+PlotID/@dataPath/dataPath.m
+++ b/+PlotID/@dataPath/dataPath.m
@@ -1,5 +1,5 @@
classdef dataPath < handle
- %DATAPATH stores the datapaths to the research data
+ % DATAPATH stores the datapaths to the research data
% usage of a class is neccessary to support variables, argument
% validation and storing variables as tempory files
diff --git a/+PlotID/@userDLG/userDLG.m b/+PlotID/@userDLG/userDLG.m
index 7b82f79cd84dfb8102cdd84412971710b8ad6765..579d1117633d59988ea305a4a349e7e84d810b56 100644
--- a/+PlotID/@userDLG/userDLG.m
+++ b/+PlotID/@userDLG/userDLG.m
@@ -1,19 +1,19 @@
classdef userDLG
- %userDLG the userDLG Class is responsible for the user dialog
+ % userDLG the userDLG Class is responsible for the user dialog
% error handeling, user messages and warnings will be provided from
% this class, depending on the user options and error type.
% This reduces messaging overhead and code length in PlotID.Publish()
properties
- configError = false
- scriptPublished = false
- rdFilesPublished = false
- figurePublished = false
- msg = ''
+ configError = false % error state of reading the config
+ scriptPublished = false % error state of publishing the script
+ rdFilesPublished = false % error state of publishing the research data
+ figurePublished = false % error state of publishing the figure
+ msg = '' % message to the user
end
properties (SetAccess = protected)
- success = false
+ success = false % product of all states
showMessages {mustBeNumericOrLogical}
forcePublish {mustBeNumericOrLogical}
ID %plotID
diff --git a/+PlotID/CreateID.m b/+PlotID/CreateID.m
index 2579717c343c33a6a777e3458e85fb29f168325d..9ae087d8c98afe515c38e236608b8abaa39b3cab 100644
--- a/+PlotID/CreateID.m
+++ b/+PlotID/CreateID.m
@@ -1,5 +1,5 @@
function [ID] = CreateID(method)
-%CreateID Creates an identifier (char)
+% CreateID Creates an identifier (char)
% Creates an (sometimes unique) identifier based on the selected method
% if no method is selected method 1 will be the default method
arguments
diff --git a/+PlotID/Publish.m b/+PlotID/Publish.m
index ddb90177022ed2dd22a82fb9fe4064e2c086c254..909dc03cfa54528ace7aed66a63d4afe0126c61c 100644
--- a/+PlotID/Publish.m
+++ b/+PlotID/Publish.m
@@ -1,5 +1,5 @@
function Publish(DataPaths,scriptPath, figure, options)
-%%Publish(DataPaths,scriptPath, ID, figure, options) saves plot, data and measuring script
+% Publish(DataPaths,scriptPath, ID, figure, options) saves plot, data and measuring script
%
% DataPaths contains the path(s) to the research data, for multiple files
% use a cell array or ONE struct of variables (only the first struct will
diff --git a/+PlotID/TagPlot.m b/+PlotID/TagPlot.m
index 896e26e3ed32c8a066359c70fa302cbb99a17cd2..d36e6910913d05e136427d9902fea84fb4fa0967 100644
--- a/+PlotID/TagPlot.m
+++ b/+PlotID/TagPlot.m
@@ -1,5 +1,5 @@
function [figs, IDs] = TagPlot(figs, options)
-%TagPlot adds IDs to figures
+% TagPlot adds IDs to figures
% The ID is placed visual on the figure window and as Tag (property of figure)
% TagPlot can tag multiple figures at once.
% If a single Plot is tagged IDs is a char, otherwise it is a cell array of
diff --git a/+PlotID/centralized.m b/+PlotID/centralized.m
index f5c92e7bfd7bfde657135d7a133146cd1cfa8cb8..ff9b45bd94e3f49008ee939f8dd7a8eda97974a2 100644
--- a/+PlotID/centralized.m
+++ b/+PlotID/centralized.m
@@ -1,6 +1,10 @@
function [status, msg] = centralized(storPath, dataObj, folderName)
-%centralized stores the research files in a centrelized folder. Linked
-%files are created for subsequent folders (HDF5 only).
+% CENTRALIZED stores the research files in a centrelized folder.
+% Linked files are created for subsequent folders (HDF5 only).
+%
+% storPath for the Data
+% dataObj contains tha data related information
+% folderName is the Name of the storage Folder
msg = '';
warning(['Linked HDF5 can only be moved with their ',...
'respective master files in the ', dataObj.dataFolderName, ' folder.']);
diff --git a/+PlotID/copyUserFCN.m b/+PlotID/copyUserFCN.m
index 4525737320b5b2347b8dd2caf18c051ac0c6a90a..cabf4904581b5793c7a128804cdc65c5c594ccfd 100644
--- a/+PlotID/copyUserFCN.m
+++ b/+PlotID/copyUserFCN.m
@@ -1,7 +1,11 @@
function pList = copyUserFCN(scriptPath, folderName, storPath, ID)
-%COPYUSERFCN copies all user functions, classes and toolboxes that are used
-%by the base script (scriptpath).
-% folderName, storPath and ID are required for createfilecopy
+% COPYUSERFCN copies all user functions, classes and toolboxes that are used
+% by a script (scriptpath).
+%
+% All toolboxes and classes are copied as a whole.
+% folderName, storPath and ID are required for createfilecopy
+% see also createFileCopy
+
[fList,pList] = matlab.codetools.requiredFilesAndProducts(scriptPath);
fList = fList(~ismember(fList,scriptPath)); % rmv plot script itself from list
fList = fList(~contains(fList,'config.json')); % rmv config.json from list
diff --git a/+PlotID/createFileCopy.m b/+PlotID/createFileCopy.m
index f27ea2e9620b64af626843aadd6af923441f9d66..297203c57e65a916d5e4b359b93616edbbf3b5ec 100644
--- a/+PlotID/createFileCopy.m
+++ b/+PlotID/createFileCopy.m
@@ -1,7 +1,10 @@
function [storagePaths, status, msg] = createFileCopy(filePaths,folderName,storPath,ID,type)
-% Creates a copy of the files (can be used for multiple paths in a cell array)
-% folderName is the name of the exporting folder
-% returns the storage paths were files were stored
+% createFileCopy Creates a copy of the files (can be used for multiple
+% paths in a cell array)
+%
+% folderName is the name of the exporting folder
+% returns the storage paths were files were stored
+% type switches the mode depending on the data type
if ~iscell(filePaths)
%fixes Issue if filepath is a char and not a cell array
diff --git a/+PlotID/createLinkedHDF5.m b/+PlotID/createLinkedHDF5.m
index 70e6ec3e7eb8fc0194b870bed624e98fa3462b6b..46dacbda5dbc1afb2969d1758dbc291e48028eef 100644
--- a/+PlotID/createLinkedHDF5.m
+++ b/+PlotID/createLinkedHDF5.m
@@ -1,6 +1,6 @@
function [status] = createLinkedHDF5(SourceFile,TargetPath)
-%createLinkedHDF5 creates a HDF file that references the Sourcefile
-% TargetPath is the storage location, ID the foldername
+% createLinkedHDF5 creates a HDF file that references the Sourcefile
+% TargetPath is the storage location
% Status returns true if the function was successfull
plist_id = 'H5P_DEFAULT';
diff --git a/+PlotID/fileCompare.m b/+PlotID/fileCompare.m
index 9d0f9694ddf0bef7b291716728f3686024ba3e69..43ca371ce0d0ac08c276aa1ed073f197580979d2 100644
--- a/+PlotID/fileCompare.m
+++ b/+PlotID/fileCompare.m
@@ -1,9 +1,10 @@
function [status, id] = fileCompare(filename,fileList)
-%% fileCompare checks if file1 is (binary) identical to a file in filelist
+% fileCompare checks if file1 is (binary) identical to a file in filelist
% it returns a status and the id of the identical file
-% the functions uses the java libraries from matlab for windows systems
-% or the unix function diff
-% because of performance issues with windows system calls in matlab
+%
+% the functions uses the java libraries from matlab for windows systems
+% or the unix function diff because of performance issues with windows
+% system calls in matlab
if isempty(fileList)
% no comparison necessary
diff --git a/+PlotID/friendlyID.m b/+PlotID/friendlyID.m
index cdac106b417794cf287ea9cab706741a4bb25b9c..1a26af21948b68f3ab206b1273f49eeaf3d2ae87 100644
--- a/+PlotID/friendlyID.m
+++ b/+PlotID/friendlyID.m
@@ -1,7 +1,8 @@
function [IDf,PrjID, Str] = friendlyID(ID)
-%FriendlyID Changes the Hex Number to a human friendly datetime and dateStr
-% IDf ID as DateTime Object, PrjID returns the ProjectID, Str returns the
-% timestamp as String
+% FriendlyID Changes the Hex Number to a human friendly datetime and dateStr
+%
+% IDf ID as DateTime Object, PrjID returns the ProjectID, Str returns the
+% timestamp as String
%Remove Prefix
if contains(ID,'-')
diff --git a/+PlotID/plotQR.m b/+PlotID/plotQR.m
index 4e44b97225482139ecd847150462cc188b15a96f..6cdccc74d98726e6937259c0f2cdbf6478526249 100644
--- a/+PlotID/plotQR.m
+++ b/+PlotID/plotQR.m
@@ -1,8 +1,11 @@
-function img = plotQR(data, size)
-%QR reads a QR code from qrserver (depends on API)
-% created by J.Stifter
+function img = plotQR(qrTxt, size)
+% plotQR creates a QR code based on qrTxt by calling a qrserver (depends on
+% API)
+% size specifies the absolut size of the qr code (pixels)
+% special thanks to J.Stifter for this suggestion
+
arguments
- data {mustBeTextScalar} = 'example';
+ qrTxt {mustBeTextScalar} = 'example';
size (1,2) {mustBeInteger} = [150, 150];
end
@@ -10,7 +13,7 @@ function img = plotQR(data, size)
n = size(2);
base_api = 'https://api.qrserver.com/v1/create-qr-code/?size=%dx%d&data=%s';
- request = sprintf(base_api, m, n, data);
+ request = sprintf(base_api, m, n, qrTxt);
options = weboptions;
options.Timeout = 5;
diff --git a/+PlotID/replaceLinkedHDF5.m b/+PlotID/replaceLinkedHDF5.m
index e84e49f6e3aeed36d24f59b50288984fbe4d3998..07f3435998e6e414603a37f678c40931881fe605 100644
--- a/+PlotID/replaceLinkedHDF5.m
+++ b/+PlotID/replaceLinkedHDF5.m
@@ -6,8 +6,6 @@ function replaceLinkedHDF5(linkedFilepath)
% Filepath is the location of the File that contains the link. The
% filepath to the linked data has to be present in the file itself.
-
-
%% Check whether the only Objects present are links
h5inf = h5info(linkedFilepath);