Skip to content

Conversation

@ncdorn
Copy link
Contributor

@ncdorn ncdorn commented Sep 19, 2025

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

  • add json examples for each block into the Doxygen developer guide

Documentation

  • all additions were to enhance the documentation

Testing

  • currently this is not passing the clang-format test and I have no idea why. All other tests are passing.

Code of Conduct & Contributing Guidelines

@ncdorn ncdorn requested a review from mrp089 September 19, 2025 18:35
@ncdorn ncdorn changed the title Update Doxygen documentation Update Doxygen documentation with json block examples Sep 19, 2025
@ncdorn
Copy link
Contributor Author

ncdorn commented Sep 25, 2025

my local clang-format needed up be updated to 21.1.2 in order to match the GitHub runners clang-format version

@mrp089 mrp089 merged commit 9ee68ed into SimVascular:master Oct 16, 2025
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants