Create function documentations

[smnnlt]

At the moment, the relevant function arguments are well explained at the beginning of the script but have to be set somewhere down in the respective sections. I strongly suggest that when converting main.m to functions (#1) you systematically document each function and its parameters.

Matlab has a particular syntax for documenting functions that has the additional benefit that you can run help to get the function details: https://mathworks.com/help/matlab/matlab_prog/add-help-for-your-program.html

Comment for the JOSS review (openjournals/joss-reviews#7858).

[sfregosi]

I agree this is important when implementing #1.

Some additional resources:

• There is a function on FileExchange that provides a template for the top of any new functions: https://www.mathworks.com/matlabcentral/fileexchange/27132-automatic-template-for-new-functions
• I have my own (less elegant) version that may help as a guide: https://github.com/sfregosi/myUtils/blob/main/newFun.m