Add documentation

[RShaw026]

Description and Context

Documentation has been added to the code explaining the functions and the variables.

Related Issues and Pull Requests

• Closes #5
• Blocks
• Is blocked by
• Follows
• Precedes
• Related to
• Part of
• Composed of

How Has This Been Tested?

Building and running ctest

Checklist

• [x] My commit messages mention the appropriate GitHub issue numbers and are longer than one line where appropriate.
• [x] I have added/updated documentation where necessary.

Additional Information

Please let me know of any possibility of renaming variables using more descriptive names.

Interested Parties / Possible Reviewers

@NoraHagmeyer

[NoraHagmeyer]

I think documentation will really help with understanding and maintaining the code in the future.. this is a good start. 2 general remarks: I'd put the documentation of functions above the function header and not into the function body. Secondly, in other codes we usually put the function documentation in the header file. The main reason is the use of doxygen, which we do not use here. But, to be consistent, and in case doxygen is used at some point, I'd suggest to do the same here.

[NoraHagmeyer]

Make sure to resolve the conflicts, i.e. by rebasing on the updated master.

[NoraHagmeyer]

Definitely makes the code easier to read. All remarks are just suggestions, mainly to be consistent with other codes such as BACI. But, in general, every comment makes the code better.

[NoraHagmeyer]

@RShaw026 What's the status of this pull request?

[RShaw026]

@NoraHagmeyer last week I was working on working on changing how MIRCO would be called from BACI. That may require changing some files. Therefore, I thought of adding this merge request after those changes are made.