Added doxygen comments and a README file to MONIO.
Following the class diagram, priority was given to top-level classes and comments added for clarity where appropriate (the class diagram in the repo has also been tweaked).
However, many functions and variables are considered to be self-explanatory. As part of this review, could I ask you, @mo-joshuacolclough to also look at places where I have not made changes and see if you agree with this? My preference is always to avoid comments, if possible.
Some other code changes are a simple re-ordering of function declarations or definitions.
This work also led to the discovery of some unused and obsolete constructs that have been removed. For this reason there is a dependent PR in LFRic-Lite where a member variable in FileData has been removed, leading to a change in class construction.
mo-joshuacolclough
commented
1 year ago
Added doxygen comments and a README file to MONIO.
Following the class diagram, priority was given to top-level classes and comments added for clarity where appropriate (the class diagram in the repo has also been tweaked).
However, many functions and variables are considered to be self-explanatory. As part of this review, could I ask you, @mo-joshuacolclough to also look at places where I have not made changes and see if you agree with this? My preference is always to avoid comments, if possible.
Some other code changes are a simple re-ordering of function declarations or definitions.
This work also led to the discovery of some unused and obsolete constructs that have been removed. For this reason there is a dependent PR in LFRic-Lite where a member variable in
FileDatahas been removed, leading to a change in class construction.This PR partially addresses issue #1 (license changes will come in a subsequent PR). It is also dependent on PR # 356 in LFRic-Lite https://github.com/JCSDA-internal/lfric-lite-jedi/pull/356
Current test outputs for MONIO, LFRic-Lite, and LFRic-JEDI: http://fcm1/cylc-review/taskjobs/punderwo/?suite=monio_streamlining_03