Update Doxygen documentation with json block examples #189
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Current situation
There is currently no concrete example of what each block looks like in a json file. I have added examples of this for all relevant blocks, which show up when the user goes to a specific class in the "Class List" of the developer guide documentation. This will hopefully increase clarity and help new users be able to generate their own json files more effectively. This is my first attempt at improving svZeroDSolver documentation both here and on the Simvascular website addressing #136 .
The only issue here is that the clang-format test is not passing and I have no idea why as I have run the automated clang formatting to the point where no files are changed.
Release Notes
Documentation
Testing
Code of Conduct & Contributing Guidelines